AWS API Changes

2021/11/22 - Amazon Connect Service - 8 new 2 updated api methods

Changes This release adds support for UpdateContactFlowMetadata, DeleteContactFlow and module APIs. For details, see the Release Notes in the Amazon Connect Administrator Guide.

UpdateContactFlowMetadata (new)

Link ¶

Updates metadata about specified contact flow.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_metadata(
    InstanceId='string',
    ContactFlowId='string',
    Name='string',
    Description='string',
    ContactFlowState='ACTIVE'|'ARCHIVED'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowId

string

param ContactFlowId

[REQUIRED]

The identifier of the contact flow.

type Name

string

param Name

TThe name of the contact flow.

type Description

string

param Description

The description of the contact flow.

type ContactFlowState

string

param ContactFlowState

The state of contact flow.

returns

None

UpdateContactFlowModuleContent (new)

Link ¶

Updates specified contact flow module for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_module_content(
    InstanceId='string',
    ContactFlowModuleId='string',
    Content='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowModuleId

string

param ContactFlowModuleId

[REQUIRED]

The identifier of the contact flow module.

type Content

string

param Content

[REQUIRED]

The content of the contact flow module.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateContactFlowModuleMetadata (new)

Link ¶

Updates metadata about specified contact flow module.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_module_metadata(
    InstanceId='string',
    ContactFlowModuleId='string',
    Name='string',
    Description='string',
    State='ACTIVE'|'ARCHIVED'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowModuleId

string

param ContactFlowModuleId

[REQUIRED]

The identifier of the contact flow module.

type Name

string

param Name

The name of the contact flow module.

type Description

string

param Description

The description of the contact flow module.

type State

string

param State

The state of contact flow module.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeContactFlowModule (new)

Link ¶

Describes the specified contact flow module.

See also: AWS API Documentation

Request Syntax

client.describe_contact_flow_module(
    InstanceId='string',
    ContactFlowModuleId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowModuleId

string

param ContactFlowModuleId

[REQUIRED]

The identifier of the contact flow module.

rtype

dict

returns

Response Syntax

{
    'ContactFlowModule': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'Content': 'string',
        'Description': 'string',
        'State': 'ACTIVE'|'ARCHIVED',
        'Status': 'PUBLISHED'|'SAVED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- ContactFlowModule (dict) --
  
  Information about the contact flow module.
  - Arn (string) --
    
    The Amazon Resource Name (ARN).
  - Id (string) --
    
    The identifier of the contact flow module.
  - Name (string) --
    
    The name of the contact flow module.
  - Content (string) --
    
    The content of the contact flow module.
  - Description (string) --
    
    The description of the contact flow module.
  - State (string) --
    
    The type of contact flow module.
  - Status (string) --
    
    The status of the contact flow module.
  - Tags (dict) --
    
    The tags used to organize, track, or control access for this resource.
    - (string) --
      - (string) --

ListContactFlowModules (new)

Link ¶

Provides information about the contact flow modules for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_contact_flow_modules(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    ContactFlowModuleState='ACTIVE'|'ARCHIVED'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the 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 ContactFlowModuleState

string

param ContactFlowModuleState

The state of the contact flow module.

rtype

dict

returns

Response Syntax

{
    'ContactFlowModulesSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'State': 'ACTIVE'|'ARCHIVED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ContactFlowModulesSummaryList (list) --
  
  Information about the contact flow module.
  - (dict) --
    
    Contains summary information about a contact flow.
    - Id (string) --
      
      The identifier of the contact flow module.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the contact flow module.
    - Name (string) --
      
      The name of the contact flow module.
    - State (string) --
      
      The type of contact flow module.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.

DeleteContactFlowModule (new)

Link ¶

Deletes the specified contact flow module.

See also: AWS API Documentation

Request Syntax

client.delete_contact_flow_module(
    InstanceId='string',
    ContactFlowModuleId='string'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowModuleId

string

param ContactFlowModuleId

[REQUIRED]

The identifier of the contact flow module.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateContactFlowModule (new)

Link ¶

Creates a contact 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'
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Name

string

param Name

[REQUIRED]

The name of the contact flow module.

type Description

string

param Description

The description of the contact flow module.

type Content

string

param Content

[REQUIRED]

The content of the contact flow module.

type Tags

dict

param Tags

The tags used to organize, track, or control access for this resource.

(string) --
- (string) --

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'Id': 'string',
    'Arn': 'string'
}

Response Structure

(dict) --
- Id (string) --
  
  The identifier of the contact flow module.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the contact flow module.

DeleteContactFlow (new)

Link ¶

Deletes a contact flow for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

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

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowId

string

param ContactFlowId

[REQUIRED]

The identifier of the contact flow.

returns

None

DescribeContactFlow (updated)

Link ¶
Changes (response)

{'ContactFlow': {'State': 'ACTIVE | ARCHIVED'}}

Describes the specified contact flow.

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

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 contact 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',
        'Description': 'string',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- ContactFlow (dict) --
  
  Information about the contact flow.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the contact flow.
  - Id (string) --
    
    The identifier of the contact flow.
  - Name (string) --
    
    The name of the contact flow.
  - Type (string) --
    
    The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide .
  - State (string) --
    
    The type of contact flow.
  - Description (string) --
    
    The description of the contact flow.
  - Content (string) --
    
    The content of the contact flow.
  - Tags (dict) --
    
    One or more tags.
    - (string) --
      - (string) --

ListContactFlows (updated)

Link ¶
Changes (response)

{'ContactFlowSummaryList': {'ContactFlowState': 'ACTIVE | ARCHIVED'}}

Provides information about the contact flows for the specified Amazon Connect instance.

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

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.list_contact_flows(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type ContactFlowTypes

list

param ContactFlowTypes

The type of contact flow.

(string) --

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

{
    'ContactFlowSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
            'ContactFlowState': 'ACTIVE'|'ARCHIVED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ContactFlowSummaryList (list) --
  
  Information about the contact flows.
  - (dict) --
    
    Contains summary information about a contact flow.
    
    You can also create and update contact flows using the Amazon Connect Flow language .
    - Id (string) --
      
      The identifier of the contact flow.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the contact flow.
    - Name (string) --
      
      The name of the contact flow.
    - ContactFlowType (string) --
      
      The type of contact flow.
    - ContactFlowState (string) --
      
      The type of contact flow.
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.