get_package_version_history

get_package_version_history(**kwargs)

Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

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

Parameters

• PackageID (string) --

  [REQUIRED]

  The unique identifier of the package.

• 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 GetPackageVersionHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

Return type

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

    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.

  • 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