Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_package

create_package(**kwargs)

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

response = client.create_package(
    PackageName='string',
    PackageType='TXT-DICTIONARY',
    PackageDescription='string',
    PackageSource={
        'S3BucketName': 'string',
        'S3Key': 'string'
    }
)
Parameters
  • PackageName (string) --

    [REQUIRED]

    Unique name for the package.

  • PackageType (string) --

    [REQUIRED]

    Type of package.

  • PackageDescription (string) -- Description of the package.
  • PackageSource (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.

Return type

dict

Returns

Response Syntax

{
    'PackageDetails': {
        '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'
        }
    }
}

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

        User-specified name of the package.

      • PackageType (string) --

        The type of package.

      • PackageDescription (string) --

        User-specified description of the package.

      • PackageStatus (string) --

        Current status of the package.

      • 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.

Exceptions

  • OpenSearchService.Client.exceptions.BaseException
  • OpenSearchService.Client.exceptions.InternalException
  • OpenSearchService.Client.exceptions.LimitExceededException
  • OpenSearchService.Client.exceptions.InvalidTypeException
  • OpenSearchService.Client.exceptions.ResourceAlreadyExistsException
  • OpenSearchService.Client.exceptions.AccessDeniedException
  • OpenSearchService.Client.exceptions.ValidationException