AWS API Changes

2020/03/25 - Amazon Elasticsearch Service - 7 new api methods

Changes Adding support for customer packages (dictionary files) to Amazon Elasticsearch Service

CreatePackage (new)

Create a package for use with Amazon ES domains.

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),
        '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.
  - ErrorDetails (dict) --
    
    Additional information if the package is in an error state. Null otherwise.
    - ErrorType (string) --
    - ErrorMessage (string) --

ListDomainsForPackage (new)

Link ¶

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',
            '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.
    - 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) --

DissociatePackage (new)

Link ¶

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',
        '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.
  - 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) --

AssociatePackage (new)

Link ¶

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',
        '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.
  - 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) --

ListPackagesForDomain (new)

Link ¶

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',
            '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.
    - 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.

DeletePackage (new)

Link ¶

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),
        '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.
  - ErrorDetails (dict) --
    
    Additional information if the package is in an error state. Null otherwise.
    - ErrorType (string) --
    - ErrorMessage (string) --

DescribePackages (new)

Link ¶

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),
            '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.
    - ErrorDetails (dict) --
      
      Additional information if the package is in an error state. Null otherwise.
      - ErrorType (string) --
      - ErrorMessage (string) --
- NextToken (string) --