Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_use_cases

list_use_cases(**kwargs)

Lists the use cases for the integration association.

See also: AWS API Documentation

Request Syntax

response = client.list_use_cases(
    InstanceId='string',
    IntegrationAssociationId='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.

  • IntegrationAssociationId (string) --

    [REQUIRED]

    The identifier for the integration association.

  • 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

{
    'UseCaseSummaryList': [
        {
            'UseCaseId': 'string',
            'UseCaseArn': 'string',
            'UseCaseType': 'RULES_EVALUATION'|'CONNECT_CAMPAIGNS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • UseCaseSummaryList (list) --

      The use cases.

      • (dict) --

        Contains the use case.

        • UseCaseId (string) --

          The identifier for the use case.

        • UseCaseArn (string) --

          The Amazon Resource Name (ARN) for the use case.

        • UseCaseType (string) --

          The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

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