Connect / Client / list_entity_security_profiles

list_entity_security_profiles

Connect.Client.list_entity_security_profiles(**kwargs)

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_entity_security_profiles(
    InstanceId='string',
    EntityType='USER'|'AI_AGENT',
    EntityArn='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.

  • EntityType (string) –

    [REQUIRED]

    Only supported type is AI_AGENT.

  • EntityArn (string) –

    [REQUIRED]

    ARN of a Q in Connect AI Agent.

  • 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. The default MaxResult size is 100.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityProfiles': [
        {
            'Id': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • SecurityProfiles (list) –

      List of Security Profile Object.

      • (dict) –

        Security profile items.

        • Id (string) –

          Id of a security profile item.

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException