Connect / Client / list_contact_flow_module_aliases

list_contact_flow_module_aliases

Connect.Client.list_contact_flow_module_aliases(**kwargs)

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

See also: AWS API Documentation

Request Syntax

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

  • ContactFlowModuleId (string) –

    [REQUIRED]

    The identifier of the flow module.

  • 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

{
    'ContactFlowModuleAliasSummaryList': [
        {
            'Arn': 'string',
            'AliasId': 'string',
            'Version': 123,
            'AliasName': 'string',
            'AliasDescription': 'string',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ContactFlowModuleAliasSummaryList (list) –

      Information about the flow module aliases.

      • (dict) –

        Contains information about an alias.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the flow module alias.

        • AliasId (string) –

          The identifier of the alias.

        • Version (integer) –

          The version of the flow module.

        • AliasName (string) –

          The name of the alias.

        • AliasDescription (string) –

          The description of the alias.

        • LastModifiedTime (datetime) –

          The timestamp when this resource was last modified.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ThrottlingException