Describe Packages

elasticsearchservice_describe_packages

R Documentation

Describes all packages available to Amazon ES¶

Description¶

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Usage¶

elasticsearchservice_describe_packages(Filters, MaxResults, NextToken)

Arguments¶

Filters

Only returns packages that match the DescribePackagesFilterList values.

MaxResults

Limits results to a maximum number of packages.

NextToken

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Value¶

A list with the following syntax:

list(
  PackageDetailsList = list(
    list(
      PackageID = "string",
      PackageName = "string",
      PackageType = "TXT-DICTIONARY",
      PackageDescription = "string",
      PackageStatus = "COPYING"|"COPY_FAILED"|"VALIDATING"|"VALIDATION_FAILED"|"AVAILABLE"|"DELETING"|"DELETED"|"DELETE_FAILED",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      AvailablePackageVersion = "string",
      ErrorDetails = list(
        ErrorType = "string",
        ErrorMessage = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_packages(
  Filters = list(
    list(
      Name = "PackageID"|"PackageName"|"PackageStatus",
      Value = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)