Connect / Client / list_contact_flow_aliases

list_contact_flow_aliases¶

Connect.Client.list_contact_flow_aliases(**kwargs)¶

Lists the aliases associated with a flow, including the version that each alias points to.

Request Syntax

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

Parameters:

InstanceId (string) –
[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
ContactFlowId (string) –
[REQUIRED]

The identifier of the flow.
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

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

Response Structure

(dict) –
- ContactFlowAliasSummaryList (list) –
  
  Information about the flow aliases.
  - (dict) –
    
    Contains summary information about a flow alias.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the flow alias.
    - AliasId (string) –
      
      The identifier of the alias.
    - Version (integer) –
      
      The version of the flow.
    - AliasName (string) –
      
      The name of the alias.
    - AliasDescription (string) –
      
      The description of the alias.
    - LastModifiedTime (datetime) –
      
      The timestamp when this resource was last modified.
    - LastModifiedRegion (string) –
      
      The Amazon Web Services Region where 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