Amazon Connect Service

Updates the name, description, or flow version associated with an alias.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_alias(
    InstanceId='string',
    ContactFlowId='string',
    AliasId='string',
    Name='string',
    Description='string',
    ContactFlowVersion=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the alias.

type Name:

string

param Name:

The name of the alias.

type Description:

string

param Description:

The description of the alias.

type ContactFlowVersion:

integer

param ContactFlowVersion:

The version of the flow.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

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

See also: AWS API Documentation

Request Syntax

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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the alias.

rtype:

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.

Deletes an alias from a flow without deleting the version that the alias points to.

See also: AWS API Documentation

Request Syntax

client.delete_contact_flow_alias(
    InstanceId='string',
    ContactFlowId='string',
    AliasId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type AliasId:

string

param AliasId:

[REQUIRED]

The identifier of the alias.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Creates a named alias that points to a specific version of a flow.

See also: AWS API Documentation

Request Syntax

client.create_contact_flow_alias(
    InstanceId='string',
    Description='string',
    ContactFlowId='string',
    ContactFlowVersion=123,
    AliasName='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type Description:

string

param Description:

The description of the alias.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type ContactFlowVersion:

integer

param ContactFlowVersion:

[REQUIRED]

The version of the flow.

type AliasName:

string

param AliasName:

[REQUIRED]

The name of the alias.

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowArn': 'string',
    'Id': 'string'
}

Response Structure

• (dict) --

  • ContactFlowArn (string) --

    The Amazon Resource Name (ARN) of the flow.

  • Id (string) --

    The identifier of the alias.

{'ContactFlowVersionSummaryList': {'LastModifiedRegion': 'string',
                                   'LastModifiedTime': 'timestamp'}}

Returns all the available versions for the specified Connect Customer instance and flow identifier.

See also: AWS API Documentation

Request Syntax

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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page. The default MaxResult size is 100.

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowVersionSummaryList': [
        {
            'Arn': 'string',
            'VersionDescription': 'string',
            'Version': 123,
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ContactFlowVersionSummaryList (list) --

    A list of flow version summaries.

    • (dict) --

      A summary of a flow version's metadata.

      • Arn (string) --

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

      • VersionDescription (string) --

        The description of the flow version.

      • Version (integer) --

        The identifier of the flow version.

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