OpenSearchService / Client / describe_packages

describe_packages#

OpenSearchService.Client.describe_packages(**kwargs)#

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

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) –
  
  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) –
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 DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in 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 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.
- 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.

Exceptions

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