packages

Creates, updates, deletes, gets or lists a packages resource.

Overview

Name	packages
Type	Resource
Id	aws.opensearch.packages

Fields

The following fields are returned by SELECT queries:

describe_packages

Name	Datatype	Description
next_token	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.
package_details_list	array	Basic information about a package.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_packages	select	region		Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
create_package	insert	region, PackageName, PackageType, PackageSource		Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
associate_package	update	package_id, domain_name, region		Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
associate_packages	update	region, PackageList, DomainName		Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.
update_package	update	region, PackageID, PackageSource		Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
update_package_scope	update	region, PackageID, PackageUserList		Updates the scope of a package. Scope of the package defines users who can view and associate a package.
delete_package	delete	package_id, region		Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
dissociate_package	exec	package_id, domain_name, region		Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
dissociate_packages	exec	region, PackageList, DomainName		Dissociates multiple packages from a domain simultaneously.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	Name of the domain to dissociate the package from.
package_id	string	Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_packages

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

SELECT
next_token,
package_details_list
FROM aws.opensearch.packages
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_package

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

INSERT INTO aws.opensearch.packages (
PackageName,
PackageType,
PackageDescription,
PackageSource,
PackageConfiguration,
EngineVersion,
PackageVendingOptions,
PackageEncryptionOptions,
region
)
SELECT 
'{{ PackageName }}' /* required */,
'{{ PackageType }}' /* required */,
'{{ PackageDescription }}',
'{{ PackageSource }}' /* required */,
'{{ PackageConfiguration }}',
'{{ EngineVersion }}',
'{{ PackageVendingOptions }}',
'{{ PackageEncryptionOptions }}',
'{{ region }}'
RETURNING
package_details
;

Manifest

# Description fields are for documentation purposes
- name: packages
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the packages resource.
  - name: PackageName
    value: "{{ PackageName }}"
  - name: PackageType
    value: "{{ PackageType }}"
    valid_values: ['TXT-DICTIONARY', 'ZIP-PLUGIN', 'PACKAGE-LICENSE', 'PACKAGE-CONFIG']
  - name: PackageDescription
    value: "{{ PackageDescription }}"
  - name: PackageSource
    description: |
      The Amazon S3 location to import the package from.
    value:
      S3BucketName: "{{ S3BucketName }}"
      S3Key: "{{ S3Key }}"
  - name: PackageConfiguration
    description: |
      The configuration parameters for a package.
    value:
      LicenseRequirement: "{{ LicenseRequirement }}"
      LicenseFilepath: "{{ LicenseFilepath }}"
      ConfigurationRequirement: "{{ ConfigurationRequirement }}"
      RequiresRestartForConfigurationUpdate: {{ RequiresRestartForConfigurationUpdate }}
  - name: EngineVersion
    value: "{{ EngineVersion }}"
  - name: PackageVendingOptions
    description: |
      Configuration options for determining whether a package can be made available for use by other users.
    value:
      VendingEnabled: {{ VendingEnabled }}
  - name: PackageEncryptionOptions
    description: |
      Encryption options for a package.
    value:
      KmsKeyIdentifier: "{{ KmsKeyIdentifier }}"
      EncryptionEnabled: {{ EncryptionEnabled }}

UPDATE examples

associate_package

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

UPDATE aws.opensearch.packages
SET 
PrerequisitePackageIDList = '{{ PrerequisitePackageIDList }}',
AssociationConfiguration = '{{ AssociationConfiguration }}'
WHERE 
package_id = '{{ package_id }}' --required
AND domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_package_details;

associate_packages

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

UPDATE aws.opensearch.packages
SET 
PackageList = '{{ PackageList }}',
DomainName = '{{ DomainName }}'
WHERE 
region = '{{ region }}' --required
AND PackageList = '{{ PackageList }}' --required
AND DomainName = '{{ DomainName }}' --required
RETURNING
domain_package_details_list;

update_package

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

UPDATE aws.opensearch.packages
SET 
PackageID = '{{ PackageID }}',
PackageSource = '{{ PackageSource }}',
PackageDescription = '{{ PackageDescription }}',
CommitMessage = '{{ CommitMessage }}',
PackageConfiguration = '{{ PackageConfiguration }}',
PackageEncryptionOptions = '{{ PackageEncryptionOptions }}'
WHERE 
region = '{{ region }}' --required
AND PackageID = '{{ PackageID }}' --required
AND PackageSource = '{{ PackageSource }}' --required
RETURNING
package_details;

update_package_scope

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

UPDATE aws.opensearch.packages
SET 
PackageID = '{{ PackageID }}',
Operation = '{{ Operation }}',
PackageUserList = '{{ PackageUserList }}'
WHERE 
region = '{{ region }}' --required
AND PackageID = '{{ PackageID }}' --required
AND PackageUserList = '{{ PackageUserList }}' --required
RETURNING
operation,
package_id,
package_user_list;

DELETE examples

delete_package

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

DELETE FROM aws.opensearch.packages
WHERE package_id = '{{ package_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

dissociate_package

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

EXEC aws.opensearch.packages.dissociate_package 
@package_id='{{ package_id }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@region='{{ region }}' --required
;

dissociate_packages

Dissociates multiple packages from a domain simultaneously.

EXEC aws.opensearch.packages.dissociate_packages 
@region='{{ region }}' --required 
@@json=
'{
"PackageList": "{{ PackageList }}", 
"DomainName": "{{ DomainName }}"
}'
;