Amazon Elasticsearch Service

2020/11/09 - Amazon Elasticsearch Service - 2 new7 updated api methods

Changes  Update es client to latest version

GetPackageVersionHistory (new) Link ¶

Returns a list of versions of the package, along with their creation time and commit message.

See also: AWS API Documentation

Request Syntax

client.get_package_version_history(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

Returns an audit history of versions of the package.

type MaxResults:

integer

param MaxResults:

Limits results to a maximum number of versions.

type NextToken:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'PackageID': 'string',
    'PackageVersionHistoryList': [
        {
            'PackageVersion': 'string',
            'CommitMessage': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for response returned by GetPackageVersionHistory operation.

    • PackageID (string) --

    • PackageVersionHistoryList (list) --

      List of PackageVersionHistory objects.

      • (dict) --

        Details of a package version.

        • PackageVersion (string) --

          Version of the package.

        • CommitMessage (string) --

          A message associated with the version.

        • CreatedAt (datetime) --

          Timestamp which tells creation time of the package version.

    • NextToken (string) --

UpdatePackage (new) Link ¶

Updates a package for use with Amazon ES domains.

See also: AWS API Documentation

Request Syntax

client.update_package(
    PackageID='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    },
    PackageDescription='string',
    CommitMessage='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

Unique identifier for the package.

type PackageSource:

dict

param PackageSource:

[REQUIRED]

The S3 location for importing the package specified as S3BucketName and S3Key

  • S3BucketName (string) --

    Name of the bucket containing the package.

  • S3Key (string) --

    Key (file name) of the package.

type PackageDescription:

string

param PackageDescription:

New description of the package.

type CommitMessage:

string

param CommitMessage:

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

rtype:

dict

returns:

Response Syntax

{
    'PackageDetails': {
        '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'
        }
    }
}

Response Structure

  • (dict) --

    Container for response returned by UpdatePackage operation.

    • PackageDetails (dict) --

      Information about the package PackageDetails.

      • 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) --

AssociatePackage (updated) Link ¶
Changes (response) 
{'DomainPackageDetails': {'PackageVersion': 'string'}}

Associates a package with an Amazon ES domain.

See also: AWS API Documentation

Request Syntax

client.associate_package(
    PackageID='string',
    DomainName='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

type DomainName:

string

param DomainName:

[REQUIRED]

Name of the domain that you want to associate the package with.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for response returned by AssociatePackage operation.

    • DomainPackageDetails (dict) --

      DomainPackageDetails

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • LastUpdated (datetime) --

        Timestamp of the most-recent update to the association status.

      • DomainName (string) --

        Name of the domain you've associated a package with.

      • DomainPackageStatus (string) --

        State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

      • PackageVersion (string) --

      • ReferencePath (string) --

        The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

      • ErrorDetails (dict) --

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

        • ErrorType (string) --

        • ErrorMessage (string) --

CreatePackage (updated) Link ¶
Changes (response) 
{'PackageDetails': {'AvailablePackageVersion': 'string',
                    'LastUpdatedAt': 'timestamp'}}

Create a package for use with Amazon ES domains.

See also: AWS API Documentation

Request Syntax

client.create_package(
    PackageName='string',
    PackageType='TXT-DICTIONARY',
    PackageDescription='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    }
)
type PackageName:

string

param PackageName:

[REQUIRED]

Unique identifier for the package.

type PackageType:

string

param PackageType:

[REQUIRED]

Type of package. Currently supports only TXT-DICTIONARY.

type PackageDescription:

string

param PackageDescription:

Description of the package.

type PackageSource:

dict

param PackageSource:

[REQUIRED]

The customer S3 location PackageSource for importing the package.

  • S3BucketName (string) --

    Name of the bucket containing the package.

  • S3Key (string) --

    Key (file name) of the package.

rtype:

dict

returns:

Response Syntax

{
    'PackageDetails': {
        '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'
        }
    }
}

Response Structure

  • (dict) --

    Container for response returned by CreatePackage operation.

    • PackageDetails (dict) --

      Information about the package PackageDetails.

      • 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) --

DeletePackage (updated) Link ¶
Changes (response) 
{'PackageDetails': {'AvailablePackageVersion': 'string',
                    'LastUpdatedAt': 'timestamp'}}

Delete the package.

See also: AWS API Documentation

Request Syntax

client.delete_package(
    PackageID='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

rtype:

dict

returns:

Response Syntax

{
    'PackageDetails': {
        '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'
        }
    }
}

Response Structure

  • (dict) --

    Container for response parameters to DeletePackage operation.

    • PackageDetails (dict) --

      PackageDetails

      • 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) --

DescribePackages (updated) Link ¶
Changes (response) 
{'PackageDetailsList': {'AvailablePackageVersion': 'string',
                        'LastUpdatedAt': 'timestamp'}}

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

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

list

param Filters:

Only returns packages that match the DescribePackagesFilterList values.

  • (dict) --

    Filter to apply in DescribePackage response.

    • Name (string) --

      Any field from PackageDetails.

    • Value (list) --

      A list of values for the specified field.

      • (string) --

type MaxResults:

integer

param MaxResults:

Limits results to a maximum number of packages.

type NextToken:

string

param 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.

rtype:

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) --

DissociatePackage (updated) Link ¶
Changes (response) 
{'DomainPackageDetails': {'PackageVersion': 'string'}}

Dissociates a package from the Amazon ES domain.

See also: AWS API Documentation

Request Syntax

client.dissociate_package(
    PackageID='string',
    DomainName='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

type DomainName:

string

param DomainName:

[REQUIRED]

Name of the domain that you want to associate the package with.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetails': {
        'PackageID': 'string',
        'PackageName': 'string',
        'PackageType': 'TXT-DICTIONARY',
        'LastUpdated': datetime(2015, 1, 1),
        'DomainName': 'string',
        'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
        'PackageVersion': 'string',
        'ReferencePath': 'string',
        'ErrorDetails': {
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Container for response returned by DissociatePackage operation.

    • DomainPackageDetails (dict) --

      DomainPackageDetails

      • PackageID (string) --

        Internal ID of the package.

      • PackageName (string) --

        User specified name of the package.

      • PackageType (string) --

        Currently supports only TXT-DICTIONARY.

      • LastUpdated (datetime) --

        Timestamp of the most-recent update to the association status.

      • DomainName (string) --

        Name of the domain you've associated a package with.

      • DomainPackageStatus (string) --

        State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

      • PackageVersion (string) --

      • ReferencePath (string) --

        The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

      • ErrorDetails (dict) --

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

        • ErrorType (string) --

        • ErrorMessage (string) --

ListDomainsForPackage (updated) Link ¶
Changes (response) 
{'DomainPackageDetailsList': {'PackageVersion': 'string'}}

Lists all Amazon ES domains associated with the package.

See also: AWS API Documentation

Request Syntax

client.list_domains_for_package(
    PackageID='string',
    MaxResults=123,
    NextToken='string'
)
type PackageID:

string

param PackageID:

[REQUIRED]

The package for which to list domains.

type MaxResults:

integer

param MaxResults:

Limits results to a maximum number of domains.

type NextToken:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for response parameters to ListDomainsForPackage operation.

    • DomainPackageDetailsList (list) --

      List of DomainPackageDetails objects.

      • (dict) --

        Information on a package that is associated with a domain.

        • PackageID (string) --

          Internal ID of the package.

        • PackageName (string) --

          User specified name of the package.

        • PackageType (string) --

          Currently supports only TXT-DICTIONARY.

        • LastUpdated (datetime) --

          Timestamp of the most-recent update to the association status.

        • DomainName (string) --

          Name of the domain you've associated a package with.

        • DomainPackageStatus (string) --

          State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

        • PackageVersion (string) --

        • ReferencePath (string) --

          The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

        • ErrorDetails (dict) --

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

          • ErrorType (string) --

          • ErrorMessage (string) --

    • NextToken (string) --

ListPackagesForDomain (updated) Link ¶
Changes (response) 
{'DomainPackageDetailsList': {'PackageVersion': 'string'}}

Lists all packages associated with the Amazon ES domain.

See also: AWS API Documentation

Request Syntax

client.list_packages_for_domain(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

The name of the domain for which you want to list associated packages.

type MaxResults:

integer

param MaxResults:

Limits results to a maximum number of packages.

type NextToken:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'DomainPackageDetailsList': [
        {
            'PackageID': 'string',
            'PackageName': 'string',
            'PackageType': 'TXT-DICTIONARY',
            'LastUpdated': datetime(2015, 1, 1),
            'DomainName': 'string',
            'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
            'PackageVersion': 'string',
            'ReferencePath': 'string',
            'ErrorDetails': {
                'ErrorType': 'string',
                'ErrorMessage': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Container for response parameters to ListPackagesForDomain operation.

    • DomainPackageDetailsList (list) --

      List of DomainPackageDetails objects.

      • (dict) --

        Information on a package that is associated with a domain.

        • PackageID (string) --

          Internal ID of the package.

        • PackageName (string) --

          User specified name of the package.

        • PackageType (string) --

          Currently supports only TXT-DICTIONARY.

        • LastUpdated (datetime) --

          Timestamp of the most-recent update to the association status.

        • DomainName (string) --

          Name of the domain you've associated a package with.

        • DomainPackageStatus (string) --

          State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

        • PackageVersion (string) --

        • ReferencePath (string) --

          The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

        • ErrorDetails (dict) --

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

          • ErrorType (string) --

          • ErrorMessage (string) --

    • NextToken (string) --

      Pagination token that needs to be supplied to the next call to get the next page of results.