security_keys

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

Overview

Name	security_keys
Type	Resource
Id	aws.connect.security_keys

Fields

The following fields are returned by SELECT queries:

list_security_keys

Name	Datatype	Description
association_id	string	The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
creation_time	string (date-time)	When the security key was created.
key	string	The key of the security key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_security_keys	select	instance_id, region	nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all security keys associated with the instance.
disassociate_security_key	update	instance_id, association_id, region	clientToken	This API is in preview release for Connect Customer and is subject to change. Deletes the specified security key.
associate_security_key	update	instance_id, region		This API is in preview release for Connect Customer and is subject to change. Associates a security key to the instance.

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
association_id	string	The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

list_security_keys

This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of all security keys associated with the instance.

SELECT
association_id,
creation_time,
key
FROM aws.connect.security_keys
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

disassociate_security_key

This API is in preview release for Connect Customer and is subject to change. Deletes the specified security key.

UPDATE aws.connect.security_keys
SET 
-- No updatable properties
WHERE 
instance_id = '{{ instance_id }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken}}';

associate_security_key

This API is in preview release for Connect Customer and is subject to change. Associates a security key to the instance.

UPDATE aws.connect.security_keys
SET 
Key = '{{ Key }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
RETURNING
association_id;