2023/10/16 - Amazon OpenSearch Service - 9 updated api methods
Changes This release allows customers to list and associate optional plugin packages with compatible Amazon OpenSearch Service clusters for enhanced functionality.
{'DomainPackageDetails': {'PackageType': {'ZIP-PLUGIN'}}}
Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.associate_package(
PackageID='string',
DomainName='string'
)
string
[REQUIRED]
Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
string
[REQUIRED]
Name of the domain to associate the package with.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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 the response returned by the AssociatePackage operation.
DomainPackageDetails (dict) --
Information about 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) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
{'PackageType': {'ZIP-PLUGIN'}}
Response {'PackageDetails': {'AvailablePluginProperties': {'ClassName': 'string',
'Description': 'string',
'Name': 'string',
'UncompressedSizeInBytes': 'long',
'Version': 'string'},
'EngineVersion': 'string',
'PackageType': {'ZIP-PLUGIN'}}}
Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.create_package(
PackageName='string',
PackageType='TXT-DICTIONARY'|'ZIP-PLUGIN',
PackageDescription='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
}
)
string
[REQUIRED]
Unique name for the package.
string
[REQUIRED]
The type of package.
string
Description of the package.
dict
[REQUIRED]
The Amazon S3 location from which to import the package.
S3BucketName (string) --
The name of the Amazon S3 bucket containing the package.
S3Key (string) --
Key (file name) of the package.
dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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'
},
'EngineVersion': 'string',
'AvailablePluginProperties': {
'Name': 'string',
'Description': 'string',
'Version': 'string',
'ClassName': 'string',
'UncompressedSizeInBytes': 123
}
}
}
Response Structure
(dict) --
Container for the response returned by the CreatePackage operation.
PackageDetails (dict) --
Basic information about an OpenSearch Service package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
The user-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
The current status of the package. The available options are AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
EngineVersion (string) --
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties (dict) --
If the package is a ZIP-PLUGIN package, additional information about plugin properties.
Name (string) --
The name of the plugin.
Description (string) --
The description of the plugin.
Version (string) --
The version of the plugin.
ClassName (string) --
The name of the class to load.
UncompressedSizeInBytes (integer) --
The uncompressed size of the plugin.
{'PackageDetails': {'AvailablePluginProperties': {'ClassName': 'string',
'Description': 'string',
'Name': 'string',
'UncompressedSizeInBytes': 'long',
'Version': 'string'},
'EngineVersion': 'string',
'PackageType': {'ZIP-PLUGIN'}}}
Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.delete_package(
PackageID='string'
)
string
[REQUIRED]
The internal ID of the package you want to delete. Use DescribePackages to find this value.
dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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'
},
'EngineVersion': 'string',
'AvailablePluginProperties': {
'Name': 'string',
'Description': 'string',
'Version': 'string',
'ClassName': 'string',
'UncompressedSizeInBytes': 123
}
}
}
Response Structure
(dict) --
Container for the response parameters to the DeletePackage operation.
PackageDetails (dict) --
Information about the deleted package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
The user-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
The current status of the package. The available options are AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
EngineVersion (string) --
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties (dict) --
If the package is a ZIP-PLUGIN package, additional information about plugin properties.
Name (string) --
The name of the plugin.
Description (string) --
The description of the plugin.
Version (string) --
The version of the plugin.
ClassName (string) --
The name of the class to load.
UncompressedSizeInBytes (integer) --
The uncompressed size of the plugin.
{'Filters': {'Name': {'EngineVersion', 'PackageType'}}}
Response {'PackageDetailsList': {'AvailablePluginProperties': {'ClassName': 'string',
'Description': 'string',
'Name': 'string',
'UncompressedSizeInBytes': 'long',
'Version': 'string'},
'EngineVersion': 'string',
'PackageType': {'ZIP-PLUGIN'}}}
Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.describe_packages(
Filters=[
{
'Name': 'PackageID'|'PackageName'|'PackageStatus'|'PackageType'|'EngineVersion',
'Value': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
Only returns packages that match the DescribePackagesFilterList values.
(dict) --
A filter to apply to the DescribePackage response.
Name (string) --
Any field from PackageDetails .
Value (list) --
A non-empty list of values for the specified filter field.
(string) --
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial DescribePackageFilters operation returns a nextToken , you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
dict
Response Syntax
{
'PackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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'
},
'EngineVersion': 'string',
'AvailablePluginProperties': {
'Name': 'string',
'Description': 'string',
'Version': 'string',
'ClassName': 'string',
'UncompressedSizeInBytes': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the response returned by the DescribePackages operation.
PackageDetailsList (list) --
Basic information about a package.
(dict) --
Basic information about a package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
The user-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
The current status of the package. The available options are AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
EngineVersion (string) --
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties (dict) --
If the package is a ZIP-PLUGIN package, additional information about plugin properties.
Name (string) --
The name of the plugin.
Description (string) --
The description of the plugin.
Version (string) --
The version of the plugin.
ClassName (string) --
The name of the class to load.
UncompressedSizeInBytes (integer) --
The uncompressed size of the plugin.
NextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
{'DomainPackageDetails': {'PackageType': {'ZIP-PLUGIN'}}}
Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.dissociate_package(
PackageID='string',
DomainName='string'
)
string
[REQUIRED]
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
string
[REQUIRED]
Name of the domain to dissociate the package from.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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 the response returned by an DissociatePackage operation.
DomainPackageDetails (dict) --
Information about a package that has been dissociated from the domain.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
{'PackageVersionHistoryList': {'PluginProperties': {'ClassName': 'string',
'Description': 'string',
'Name': 'string',
'UncompressedSizeInBytes': 'long',
'Version': 'string'}}}
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.get_package_version_history(
PackageID='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the package.
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial GetPackageVersionHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
dict
Response Syntax
{
'PackageID': 'string',
'PackageVersionHistoryList': [
{
'PackageVersion': 'string',
'CommitMessage': 'string',
'CreatedAt': datetime(2015, 1, 1),
'PluginProperties': {
'Name': 'string',
'Description': 'string',
'Version': 'string',
'ClassName': 'string',
'UncompressedSizeInBytes': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response returned by GetPackageVersionHistory operation.
PackageID (string) --
The unique identifier of the package.
PackageVersionHistoryList (list) --
A list of package versions, along with their creation time and commit message.
(dict) --
Details about a package version.
PackageVersion (string) --
The package version.
CommitMessage (string) --
A message associated with the package version when it was uploaded.
CreatedAt (datetime) --
The date and time when the package was created.
PluginProperties (dict) --
Additional information about plugin properties if the package is a ZIP-PLUGIN package.
Name (string) --
The name of the plugin.
Description (string) --
The description of the plugin.
Version (string) --
The version of the plugin.
ClassName (string) --
The name of the class to load.
UncompressedSizeInBytes (integer) --
The uncompressed size of the plugin.
NextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
{'DomainPackageDetailsList': {'PackageType': {'ZIP-PLUGIN'}}}
Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.list_domains_for_package(
PackageID='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The unique identifier of the package for which to list associated domains.
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial ListDomainsForPackage operation returns a nextToken , you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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 the response parameters to the ListDomainsForPackage operation.
DomainPackageDetailsList (list) --
Information about all domains associated with a package.
(dict) --
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
NextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
{'DomainPackageDetailsList': {'PackageType': {'ZIP-PLUGIN'}}}
Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.list_packages_for_domain(
DomainName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name of the domain for which you want to list associated packages.
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial ListPackagesForDomain operation returns a nextToken , you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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 the response parameters to the ListPackagesForDomain operation.
DomainPackageDetailsList (list) --
List of all packages associated with a domain.
(dict) --
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
NextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
{'PackageDetails': {'AvailablePluginProperties': {'ClassName': 'string',
'Description': 'string',
'Name': 'string',
'UncompressedSizeInBytes': 'long',
'Version': 'string'},
'EngineVersion': 'string',
'PackageType': {'ZIP-PLUGIN'}}}
Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.update_package(
PackageID='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
},
PackageDescription='string',
CommitMessage='string'
)
string
[REQUIRED]
The unique identifier for the package.
dict
[REQUIRED]
Amazon S3 bucket and key for the package.
S3BucketName (string) --
The name of the Amazon S3 bucket containing the package.
S3Key (string) --
Key (file name) of the package.
string
A new description of the package.
string
Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse .
dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN',
'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'
},
'EngineVersion': 'string',
'AvailablePluginProperties': {
'Name': 'string',
'Description': 'string',
'Version': 'string',
'ClassName': 'string',
'UncompressedSizeInBytes': 123
}
}
}
Response Structure
(dict) --
Container for the response returned by the UpdatePackage operation.
PackageDetails (dict) --
Information about a package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
The user-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
The current status of the package. The available options are AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
EngineVersion (string) --
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties (dict) --
If the package is a ZIP-PLUGIN package, additional information about plugin properties.
Name (string) --
The name of the plugin.
Description (string) --
The description of the plugin.
Version (string) --
The version of the plugin.
ClassName (string) --
The name of the class to load.
UncompressedSizeInBytes (integer) --
The uncompressed size of the plugin.