OpenSearchService / Client / get_package_version_history

get_package_version_history#

OpenSearchService.Client.get_package_version_history(**kwargs)#

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.

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),
            'PluginProperties': {
                'Name': 'string',
                'Description': 'string',
                'Version': 'string',
                'ClassName': 'string',
                'UncompressedSizeInBytes': 123
            },
            'PackageConfiguration': {
                'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
                'LicenseFilepath': 'string',
                'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE',
                'RequiresRestartForConfigurationUpdate': True|False
            }
        },
    ],
    '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.
    - PackageConfiguration (dict) –
      
      The configuration details for a specific version of a package.
      - LicenseRequirement (string) –
        
        The license requirements for the package.
      - LicenseFilepath (string) –
        
        The relative file path for the license associated with the package.
      - ConfigurationRequirement (string) –
        
        The configuration requirements for the package.
      - RequiresRestartForConfigurationUpdate (boolean) –
        
        This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.
- 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