Connect / Client / describe_contact_flow_alias

describe_contact_flow_alias¶

Connect.Client.describe_contact_flow_alias(**kwargs)¶

Returns information about a specific flow alias, including the version that it points to.

Request Syntax

response = client.describe_contact_flow_alias(
    InstanceId='string',
    ContactFlowId='string',
    AliasId='string'
)

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.
AliasId (string) –
[REQUIRED]

The identifier of the alias.

Return type:

dict

Returns:

Response Syntax

{
    'ContactFlowAlias': {
        'ContactFlowId': 'string',
        'ContactFlowArn': 'string',
        'AliasId': 'string',
        'Version': 123,
        'Name': 'string',
        'Description': 'string',
        'LastModifiedRegion': 'string',
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- ContactFlowAlias (dict) –
  
  Information about the flow alias.
  - ContactFlowId (string) –
    
    The identifier of the flow.
  - ContactFlowArn (string) –
    
    The Amazon Resource Name (ARN) of the flow.
  - AliasId (string) –
    
    The identifier of the alias.
  - Version (integer) –
    
    The version of the flow.
  - Name (string) –
    
    The name of the alias.
  - Description (string) –
    
    The description of the alias.
  - LastModifiedRegion (string) –
    
    The Amazon Web Services Region where this resource was last modified.
  - LastModifiedTime (datetime) –
    
    The timestamp when this resource was last modified.

Exceptions

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