Connect / Client / describe_contact_flow_module_alias

describe_contact_flow_module_alias

Connect.Client.describe_contact_flow_module_alias(**kwargs)

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

See also: AWS API Documentation

Request Syntax

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

  • AliasId (string) –

    [REQUIRED]

    The identifier of the alias.

Return type:

dict

Returns:

Response Syntax

{
    'ContactFlowModuleAlias': {
        'ContactFlowModuleId': 'string',
        'ContactFlowModuleArn': 'string',
        'AliasId': 'string',
        'Version': 123,
        'Name': 'string',
        'Description': 'string',
        'LastModifiedRegion': 'string',
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • ContactFlowModuleAlias (dict) –

      Information about the flow module alias.

      • ContactFlowModuleId (string) –

        The identifier of the flow module.

      • ContactFlowModuleArn (string) –

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

      • AliasId (string) –

        The identifier of the alias.

      • Version (integer) –

        The version of the flow module.

      • 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