OpenSearchService / Client / list_domains_for_package

list_domains_for_package#

OpenSearchService.Client.list_domains_for_package(**kwargs)#

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Request Syntax

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

Parameters:

PackageID (string) –
[REQUIRED]

The unique identifier of the package for which to list associated domains.
MaxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
NextToken (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.

Return type:

dict

Returns:

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. Send the request again using the returned token to retrieve the next page.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.ValidationException