Connect / Client / associate_security_key

associate_security_key#

Connect.Client.associate_security_key(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

See also: AWS API Documentation

Request Syntax

response = client.associate_security_key(
    InstanceId='string',
    Key='string',
    ClientToken='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Key (string) –

    [REQUIRED]

    A valid security key in PEM format as a String.

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string'
}

Response Structure

  • (dict) –

    • AssociationId (string) –

      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Exceptions