ElasticsearchService / Client / describe_packages

describe_packages

ElasticsearchService.Client.describe_packages(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_packages(
    Filters=[
        {
            'Name': 'PackageID'|'PackageName'|'PackageStatus',
            'Value': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Filters (list) –

  Only returns packages that match the DescribePackagesFilterList values.

  • (dict) –

    Filter to apply in DescribePackage response.

    • Name (string) –

      Any field from PackageDetails.

    • Value (list) –

      A non-empty list of values for the specified field.

      • (string) –

• MaxResults (integer) – Limits results to a maximum number of packages.

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

Return type:

dict

Returns:

Response Syntax

{
    'PackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'PackageDescription': 'string',
            'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'AvailablePackageVersion': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Container for response returned by DescribePackages operation.

  • PackageDetailsList (list) –

    List of PackageDetails objects.

    • (dict) –

      Basic information about a package.

      • PackageID (string) –

        Internal ID of the package.

      • PackageName (string) –

        User specified name of the package.

      • PackageType (string) –

        Currently supports only TXT-DICTIONARY.

      • PackageDescription (string) –

        User-specified description of the package.

      • PackageStatus (string) –

        Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

      • CreatedAt (datetime) –

        Timestamp which tells creation date of the package.

      • LastUpdatedAt (datetime) –

      • AvailablePackageVersion (string) –

      • ErrorDetails (dict) –

        Additional information if the package is in an error state. Null otherwise.

        • ErrorType (string) –

        • ErrorMessage (string) –

  • NextToken (string) –

Exceptions

• ElasticsearchService.Client.exceptions.BaseException

• ElasticsearchService.Client.exceptions.InternalException

• ElasticsearchService.Client.exceptions.ResourceNotFoundException

• ElasticsearchService.Client.exceptions.AccessDeniedException

• ElasticsearchService.Client.exceptions.ValidationException