2025/11/21 - Amazon Connect Service - 8 new4 updated api methods
Changes New APIs to support aliases and versions for ContactFlowModule. Updated ContactFlowModule APIs to support custom blocks.
Creates a named alias that points to a specific version of a contact flow module.
See also: AWS API Documentation
Request Syntax
client.create_contact_flow_module_alias(
InstanceId='string',
Description='string',
ContactFlowModuleId='string',
ContactFlowModuleVersion=123,
AliasName='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The description of the alias.
string
[REQUIRED]
The identifier of the flow module.
integer
[REQUIRED]
The version of the flow module.
string
[REQUIRED]
The name of the alias.
dict
Response Syntax
{
'ContactFlowModuleArn': 'string',
'Id': 'string'
}
Response Structure
(dict) --
ContactFlowModuleArn (string) --
The Amazon Resource Name (ARN) of the flow module.
Id (string) --
The identifier of the alias.
Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.
See also: AWS API Documentation
Request Syntax
client.describe_contact_flow_module_alias(
InstanceId='string',
ContactFlowModuleId='string',
AliasId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
string
[REQUIRED]
The identifier of the alias.
dict
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.
Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.
See also: AWS API Documentation
Request Syntax
client.create_contact_flow_module_version(
InstanceId='string',
Description='string',
ContactFlowModuleId='string',
FlowModuleContentSha256='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The description of the flow module version.
string
[REQUIRED]
The identifier of the flow module.
string
Indicates the checksum value of the flow module content.
dict
Response Syntax
{
'ContactFlowModuleArn': 'string',
'Version': 123
}
Response Structure
(dict) --
ContactFlowModuleArn (string) --
The Amazon Resource Name (ARN) of the flow module.
Version (integer) --
The version of the flow module.
Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.
See also: AWS API Documentation
Request Syntax
client.list_contact_flow_module_aliases(
InstanceId='string',
ContactFlowModuleId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
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.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'ContactFlowModuleAliasSummaryList': [
{
'Arn': 'string',
'AliasId': 'string',
'Version': 123,
'AliasName': 'string',
'AliasDescription': 'string',
'LastModifiedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactFlowModuleAliasSummaryList (list) --
Information about the flow module aliases.
(dict) --
Contains information about an alias.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module alias.
AliasId (string) --
The identifier of the alias.
Version (integer) --
The version of the flow module.
AliasName (string) --
The name of the alias.
AliasDescription (string) --
The description of the alias.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Retrieves a paginated list of all versions for a specific contact flow module.
See also: AWS API Documentation
Request Syntax
client.list_contact_flow_module_versions(
InstanceId='string',
ContactFlowModuleId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
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.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'ContactFlowModuleVersionSummaryList': [
{
'Arn': 'string',
'VersionDescription': 'string',
'Version': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactFlowModuleVersionSummaryList (list) --
Information about the flow module versions.
(dict) --
Contains information about a version.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module version.
VersionDescription (string) --
The description of the flow module version.
Version (integer) --
The version of the flow module.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Removes a specific version of a contact flow module.
See also: AWS API Documentation
Request Syntax
client.delete_contact_flow_module_version(
InstanceId='string',
ContactFlowModuleId='string',
ContactFlowModuleVersion=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
integer
[REQUIRED]
The version of the flow module to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.
See also: AWS API Documentation
Request Syntax
client.delete_contact_flow_module_alias(
InstanceId='string',
ContactFlowModuleId='string',
AliasId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
string
[REQUIRED]
The identifier of the alias.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
See also: AWS API Documentation
Request Syntax
client.update_contact_flow_module_alias(
InstanceId='string',
ContactFlowModuleId='string',
AliasId='string',
Name='string',
Description='string',
ContactFlowModuleVersion=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
string
[REQUIRED]
The identifier of the alias.
string
The name of the alias.
string
The description of the alias.
integer
The version of the flow module.
dict
Response Syntax
{}
Response Structure
(dict) --
{'ExternalInvocationConfiguration': {'Enabled': 'boolean'},
'Settings': 'string'}
Creates a flow module for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.create_contact_flow_module(
InstanceId='string',
Name='string',
Description='string',
Content='string',
Tags={
'string': 'string'
},
ClientToken='string',
Settings='string',
ExternalInvocationConfiguration={
'Enabled': True|False
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The name of the flow module.
string
The description of the flow module.
string
[REQUIRED]
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
string
The configuration settings for the flow module.
dict
The external invocation configuration for the flow module.
Enabled (boolean) --
Enable external invocation.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The identifier of the flow module.
Arn (string) --
The Amazon Resource Name (ARN) of the flow module.
{'ContactFlowModule': {'ExternalInvocationConfiguration': {'Enabled': 'boolean'},
'FlowModuleContentSha256': 'string',
'Settings': 'string',
'Version': 'long',
'VersionDescription': 'string'}}
Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
See also: AWS API Documentation
Request Syntax
client.describe_contact_flow_module(
InstanceId='string',
ContactFlowModuleId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
dict
Response Syntax
{
'ContactFlowModule': {
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Content': 'string',
'Description': 'string',
'State': 'ACTIVE'|'ARCHIVED',
'Status': 'PUBLISHED'|'SAVED',
'Tags': {
'string': 'string'
},
'FlowModuleContentSha256': 'string',
'Version': 123,
'VersionDescription': 'string',
'Settings': 'string',
'ExternalInvocationConfiguration': {
'Enabled': True|False
}
}
}
Response Structure
(dict) --
ContactFlowModule (dict) --
Information about the flow module.
Arn (string) --
The Amazon Resource Name (ARN).
Id (string) --
The identifier of the flow module.
Name (string) --
The name of the flow module.
Content (string) --
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Description (string) --
The description of the flow module.
State (string) --
The type of flow module.
Status (string) --
The status of the flow module.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
FlowModuleContentSha256 (string) --
Hash of the module content for integrity verification.
Version (integer) --
The version of the flow module.
VersionDescription (string) --
Description of the version.
Settings (string) --
The configuration settings for the flow module.
ExternalInvocationConfiguration (dict) --
The external invocation configuration for the flow module
Enabled (boolean) --
Enable external invocation.
{'ContactFlowModules': {'ExternalInvocationConfiguration': {'Enabled': 'boolean'},
'FlowModuleContentSha256': 'string',
'Settings': 'string',
'Version': 'long',
'VersionDescription': 'string'}}
Searches the flow modules in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_contact_flow_modules(
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'
},
'StateCondition': 'ACTIVE'|'ARCHIVED',
'StatusCondition': 'PUBLISHED'|'SAVED'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
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.
dict
The search criteria to be used to return flow modules.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return flow modules.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return flow modules.
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.
StateCondition (string) --
The state of the flow.
StatusCondition (string) --
The status of the flow.
dict
Response Syntax
{
'ContactFlowModules': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Content': 'string',
'Description': 'string',
'State': 'ACTIVE'|'ARCHIVED',
'Status': 'PUBLISHED'|'SAVED',
'Tags': {
'string': 'string'
},
'FlowModuleContentSha256': 'string',
'Version': 123,
'VersionDescription': 'string',
'Settings': 'string',
'ExternalInvocationConfiguration': {
'Enabled': True|False
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
ContactFlowModules (list) --
The search criteria to be used to return flow modules.
(dict) --
Contains information about a flow module.
Arn (string) --
The Amazon Resource Name (ARN).
Id (string) --
The identifier of the flow module.
Name (string) --
The name of the flow module.
Content (string) --
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Description (string) --
The description of the flow module.
State (string) --
The type of flow module.
Status (string) --
The status of the flow module.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
FlowModuleContentSha256 (string) --
Hash of the module content for integrity verification.
Version (integer) --
The version of the flow module.
VersionDescription (string) --
Description of the version.
Settings (string) --
The configuration settings for the flow module.
ExternalInvocationConfiguration (dict) --
The external invocation configuration for the flow module
Enabled (boolean) --
Enable external invocation.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of flows which matched your search query.
{'Settings': 'string'}
Updates specified flow module for the specified Amazon Connect instance.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
See also: AWS API Documentation
Request Syntax
client.update_contact_flow_module_content(
InstanceId='string',
ContactFlowModuleId='string',
Content='string',
Settings='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the flow module.
string
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
string
Serialized JSON string of the flow module Settings schema.
dict
Response Syntax
{}
Response Structure
(dict) --