Connect / Client / list_security_keys

list_security_keys#

Connect.Client.list_security_keys(**kwargs)#

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

Returns a paginated list of all security keys associated with the instance.

Request Syntax

response = client.list_security_keys(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

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.
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.
MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityKeys': [
        {
            'AssociationId': 'string',
            'Key': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- SecurityKeys (list) –
  
  The security keys.
  - (dict) –
    
    Configuration information of the security key.
    - AssociationId (string) –
      
      The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
    - Key (string) –
      
      The key of the security key.
    - CreationTime (datetime) –
      
      When the security key was created.
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.

Exceptions

Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ThrottlingException