AWS API Changes

2024/11/18 - Amazon Connect Service - 2 new5 updated api methods

Changes Adds CreateContactFlowVersion and ListContactFlowVersions APIs to create and view the versions of a contact flow.

CreateContactFlowVersion (new)

Link ¶

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.

See also: AWS API Documentation

Request Syntax

client.create_contact_flow_version(
    InstanceId='string',
    Description='string',
    ContactFlowId='string',
    FlowContentSha256='string',
    LastModifiedTime=datetime(2015, 1, 1),
    LastModifiedRegion='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type Description:

string

param Description:

The description of the flow version.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

type FlowContentSha256:

string

param FlowContentSha256:

Indicates the checksum value of the flow content.

type LastModifiedTime:

datetime

param LastModifiedTime:

The Amazon Web Services Region where this resource was last modified.

type LastModifiedRegion:

string

param LastModifiedRegion:

The Amazon Web Services Region where this resource was last modified.

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowArn': 'string',
    'Version': 123
}

Response Structure

(dict) --
- ContactFlowArn (string) --
  
  The Amazon Resource Name (ARN) of the flow.
- Version (integer) --
  
  The identifier of the flow version.

ListContactFlowVersions (new)

Link ¶

Returns all the available versions for the specified Amazon Connect 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 Amazon Connect 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
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ContactFlowVersionSummaryList (list) --
  
  A list of flow version summaries.
  - (dict) --
    
    A summary of a contact flow version's metadata.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the view version.
    - VersionDescription (string) --
      
      The description of the flow version.
    - Version (integer) --
      
      The identifier of the flow version.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

CreateContactFlow (updated)

Link ¶
Changes (response)

{'FlowContentSha256': 'string'}

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the Amazon Connect Flow language.

See also: AWS API Documentation

Request Syntax

client.create_contact_flow(
    InstanceId='string',
    Name='string',
    Type='CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    Description='string',
    Content='string',
    Status='PUBLISHED'|'SAVED',
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type Name:

string

param Name:

[REQUIRED]

The name of the flow.

type Type:

string

param Type:

[REQUIRED]

The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

type Description:

string

param Description:

The description of the flow.

type Content:

string

param Content:

[REQUIRED]

The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

Length Constraints: Minimum length of 1. Maximum length of 256000.

type Status:

string

param Status:

Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. the SAVED status does not initiate validation of the content. SAVED | PUBLISHED.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowId': 'string',
    'ContactFlowArn': 'string',
    'FlowContentSha256': 'string'
}

Response Structure

(dict) --
- ContactFlowId (string) --
  
  The identifier of the flow.
- ContactFlowArn (string) --
  
  The Amazon Resource Name (ARN) of the flow.
- FlowContentSha256 (string) --
  
  Indicates the checksum value of the flow content.

CreateIntegrationAssociation (updated)

Link ¶
Changes (request)

{'IntegrationType': {'Q_MESSAGE_TEMPLATES'}}

Creates an Amazon Web Services resource association with an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_integration_association(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
    IntegrationArn='string',
    SourceApplicationUrl='string',
    SourceApplicationName='string',
    SourceType='SALESFORCE'|'ZENDESK'|'CASES',
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type IntegrationType:

string

param IntegrationType:

[REQUIRED]

The type of information to be ingested.

type IntegrationArn:

string

param IntegrationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the integration.

type SourceApplicationUrl:

string

param SourceApplicationUrl:

The URL for the external application. This field is only required for the EVENT integration type.

type SourceApplicationName:

string

param SourceApplicationName:

The name of the external application. This field is only required for the EVENT integration type.

type SourceType:

string

param SourceType:

The type of the data source. This field is only required for the EVENT integration type.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'IntegrationAssociationId': 'string',
    'IntegrationAssociationArn': 'string'
}

Response Structure

(dict) --
- IntegrationAssociationId (string) --
  
  The identifier for the integration association.
- IntegrationAssociationArn (string) --
  
  The Amazon Resource Name (ARN) for the association.

DescribeContactFlow (updated)

Link ¶
Changes (response)

{'ContactFlow': {'FlowContentSha256': 'string',
                 'IsDefault': 'boolean',
                 'LastModifiedRegion': 'string',
                 'LastModifiedTime': 'timestamp',
                 'Version': 'long',
                 'VersionDescription': 'string'}}

Describes the specified flow.

You can also create and update flows using the Amazon Connect Flow language.

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

See also: AWS API Documentation

Request Syntax

client.describe_contact_flow(
    InstanceId='string',
    ContactFlowId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the flow.

rtype:

dict

returns:

Response Syntax

{
    'ContactFlow': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
        'State': 'ACTIVE'|'ARCHIVED',
        'Status': 'PUBLISHED'|'SAVED',
        'Description': 'string',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        },
        'IsDefault': True|False,
        'FlowContentSha256': 'string',
        'Version': 123,
        'VersionDescription': 'string',
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string'
    }
}

Response Structure

(dict) --
- ContactFlow (dict) --
  
  Information about the flow.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the flow.
  - Id (string) --
    
    The identifier of the flow.
  - Name (string) --
    
    The name of the flow.
  - Type (string) --
    
    The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
  - State (string) --
    
    The type of flow.
  - Status (string) --
    
    The status of the contact flow.
  - Description (string) --
    
    The description of the flow.
  - Content (string) --
    
    The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
    
    Length Constraints: Minimum length of 1. Maximum length of 256000.
  - Tags (dict) --
    
    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
    - (string) --
      - (string) --
  - IsDefault (boolean) --
    
    Amazon Connect includes a set of default flows that have already been published. It uses them to power your contact center.
  - FlowContentSha256 (string) --
    
    Indicates the checksum value of the flow content.
  - Version (integer) --
    
    The identifier of the flow version.
  - VersionDescription (string) --
    
    The description of the flow version.
  - LastModifiedTime (datetime) --
    
    The time at which the contact flow was last modified.
  - LastModifiedRegion (string) --
    
    The region in which the contact flow was last modified

ListIntegrationAssociations (updated)

Link ¶
Changes (request, response)
Request

{'IntegrationType': {'Q_MESSAGE_TEMPLATES'}}

Response

{'IntegrationAssociationSummaryList': {'IntegrationType': {'Q_MESSAGE_TEMPLATES'}}}

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_integration_associations(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
    NextToken='string',
    MaxResults=123,
    IntegrationArn='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

type IntegrationType:

string

param IntegrationType:

The integration type.

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.

type IntegrationArn:

string

param IntegrationArn:

The Amazon Resource Name (ARN) of the integration.

rtype:

dict

returns:

Response Syntax

{
    'IntegrationAssociationSummaryList': [
        {
            'IntegrationAssociationId': 'string',
            'IntegrationAssociationArn': 'string',
            'InstanceId': 'string',
            'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
            'IntegrationArn': 'string',
            'SourceApplicationUrl': 'string',
            'SourceApplicationName': 'string',
            'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- IntegrationAssociationSummaryList (list) --
  
  The associations.
  - (dict) --
    
    Contains summary information about the associated AppIntegrations.
    - IntegrationAssociationId (string) --
      
      The identifier for the AppIntegration association.
    - IntegrationAssociationArn (string) --
      
      The Amazon Resource Name (ARN) for the AppIntegration association.
    - InstanceId (string) --
      
      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    - IntegrationType (string) --
      
      The integration type.
    - IntegrationArn (string) --
      
      The Amazon Resource Name (ARN) for the AppIntegration.
    - SourceApplicationUrl (string) --
      
      The URL for the external application.
    - SourceApplicationName (string) --
      
      The user-provided, friendly name for the external application.
    - SourceType (string) --
      
      The name of the source.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

SearchContactFlows (updated)

Link ¶
Changes (response)

{'ContactFlows': {'FlowContentSha256': 'string',
                  'IsDefault': 'boolean',
                  'LastModifiedRegion': 'string',
                  'LastModifiedTime': 'timestamp',
                  'Version': 'long',
                  'VersionDescription': 'string'}}

Searches the contact flows in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.search_contact_flows(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        },
        'TypeCondition': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
        'StateCondition': 'ACTIVE'|'ARCHIVED',
        'StatusCondition': 'PUBLISHED'|'SAVED'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

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

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.

type SearchFilter:

dict

param SearchFilter:

Filters to be applied to search results.

TagFilter (dict) --

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
- Top level list specifies conditions that need to be applied with OR operator
- Inner list specifies conditions that need to be applied with AND operator.
- OrConditions (list) --
  
  A list of conditions which would be applied together with an OR condition.
  - (list) --
    - (dict) --
      
      A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
      - TagKey (string) --
        
        The tag key in the tag condition.
      - TagValue (string) --
        
        The tag value in the tag condition.
- AndConditions (list) --
  
  A list of conditions which would be applied together with an AND condition.
  - (dict) --
    
    A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
    - TagKey (string) --
      
      The tag key in the tag condition.
    - TagValue (string) --
      
      The tag value in the tag condition.
- TagCondition (dict) --
  
  A leaf node condition which can be used to specify a tag condition.
  - TagKey (string) --
    
    The tag key in the tag condition.
  - TagValue (string) --
    
    The tag value in the tag condition.

type SearchCriteria:

dict

param SearchCriteria:

The search criteria to be used to return flows.

OrConditions (list) --

A list of conditions which would be applied together with an OR condition.
- (dict) --
  
  The search criteria to be used to return contact flows.
AndConditions (list) --

A list of conditions which would be applied together with an AND condition.
- (dict) --
  
  The search criteria to be used to return contact flows.
StringCondition (dict) --

A leaf node condition which can be used to specify a string condition.
- FieldName (string) --
  
  The name of the field in the string condition.
- Value (string) --
  
  The value of the string.
- ComparisonType (string) --
  
  The type of comparison to be made when evaluating the string condition.
TypeCondition (string) --

The type of flow.
StateCondition (string) --

The state of the flow.
StatusCondition (string) --

The status of the flow.

rtype:

dict

returns:

Response Syntax

{
    'ContactFlows': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
            'State': 'ACTIVE'|'ARCHIVED',
            'Status': 'PUBLISHED'|'SAVED',
            'Description': 'string',
            'Content': 'string',
            'Tags': {
                'string': 'string'
            },
            'IsDefault': True|False,
            'FlowContentSha256': 'string',
            'Version': 123,
            'VersionDescription': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

(dict) --
- ContactFlows (list) --
  
  Information about the flows.
  - (dict) --
    
    Contains information about a flow.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the flow.
    - Id (string) --
      
      The identifier of the flow.
    - Name (string) --
      
      The name of the flow.
    - Type (string) --
      
      The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
    - State (string) --
      
      The type of flow.
    - Status (string) --
      
      The status of the contact flow.
    - Description (string) --
      
      The description of the flow.
    - Content (string) --
      
      The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
      
      Length Constraints: Minimum length of 1. Maximum length of 256000.
    - Tags (dict) --
      
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
      - (string) --
        
        (string) --
    - IsDefault (boolean) --
      
      Amazon Connect includes a set of default flows that have already been published. It uses them to power your contact center.
    - FlowContentSha256 (string) --
      
      Indicates the checksum value of the flow content.
    - Version (integer) --
      
      The identifier of the flow version.
    - VersionDescription (string) --
      
      The description of the flow version.
    - LastModifiedTime (datetime) --
      
      The time at which the contact flow was last modified.
    - LastModifiedRegion (string) --
      
      The region in which the contact flow was last modified
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
- ApproximateTotalCount (integer) --
  
  The total number of contact flows which matched your search query.