packages

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

Overview

Name	packages
Type	Resource
Id	aws.es.packages

Fields

The following fields are returned by SELECT queries:

describe_packages

Name	Datatype	Description
next_token	string
package_details_list	array	List of PackageDetails objects.

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 Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
create_package	insert	region, PackageName, PackageType, PackageSource		Create a package for use with Amazon ES domains.
associate_package	update	package_id, domain_name, region		Associates a package with an Amazon ES domain.
update_package	update	region, PackageID, PackageSource		Updates a package for use with Amazon ES domains.
delete_package	delete	package_id, region		Delete the package.
dissociate_package	exec	package_id, domain_name, region		Dissociates a package from the Amazon ES domain.

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 that you want to associate the package with.
package_id	string	Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_packages

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

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

INSERT examples

create_package

Create a package for use with Amazon ES domains.

INSERT INTO aws.es.packages (
PackageName,
PackageType,
PackageDescription,
PackageSource,
region
)
SELECT 
'{{ PackageName }}' /* required */,
'{{ PackageType }}' /* required */,
'{{ PackageDescription }}',
'{{ PackageSource }}' /* required */,
'{{ 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']
  - name: PackageDescription
    value: "{{ PackageDescription }}"
  - name: PackageSource
    description: |
      The S3 location for importing the package specified as S3BucketName and S3Key
    value:
      S3BucketName: "{{ S3BucketName }}"
      S3Key: "{{ S3Key }}"

UPDATE examples

associate_package

Associates a package with an Amazon ES domain.

UPDATE aws.es.packages
SET 
-- No updatable properties
WHERE 
package_id = '{{ package_id }}' --required
AND domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_package_details;

update_package

Updates a package for use with Amazon ES domains.

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

DELETE examples

delete_package

Delete the package.

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

Lifecycle Methods

dissociate_package

Dissociates a package from the Amazon ES domain.

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