AWS API Changes

2024/12/12 - Amazon Connect Service - 7 new1 updated api methods

Changes Configure holidays and other overrides to hours of operation in advance. During contact handling, Amazon Connect automatically checks for overrides and provides customers with an appropriate flow path. After an override period passes call center automatically reverts to standard hours of operation.

DescribeHoursOfOperationOverride (new)

Link ¶

Describes the hours of operation override.

See also: AWS API Documentation

Request Syntax

client.describe_hours_of_operation_override(
    InstanceId='string',
    HoursOfOperationId='string',
    HoursOfOperationOverrideId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

type HoursOfOperationOverrideId:

string

param HoursOfOperationOverrideId:

[REQUIRED]

The identifier for the hours of operation override.

rtype:

dict

returns:

Response Syntax

{
    'HoursOfOperationOverride': {
        'HoursOfOperationOverrideId': 'string',
        'HoursOfOperationId': 'string',
        'HoursOfOperationArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'Config': [
            {
                'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                'StartTime': {
                    'Hours': 123,
                    'Minutes': 123
                },
                'EndTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            },
        ],
        'EffectiveFrom': 'string',
        'EffectiveTill': 'string'
    }
}

Response Structure

(dict) --
- HoursOfOperationOverride (dict) --
  
  Information about the hours of operations override.
  - HoursOfOperationOverrideId (string) --
    
    The identifier for the hours of operation override.
  - HoursOfOperationId (string) --
    
    The identifier for the hours of operation.
  - HoursOfOperationArn (string) --
    
    The Amazon Resource Name (ARN) for the hours of operation.
  - Name (string) --
    
    The name of the hours of operation override.
  - Description (string) --
    
    The description of the hours of operation override.
  - Config (list) --
    
    Configuration information for the hours of operation override: day, start time, and end time.
    - (dict) --
      
      Information about the hours of operation override config: day, start time, and end time.
      - Day (string) --
        
        The day that the hours of operation override applies to.
      - StartTime (dict) --
        
        The start time when your contact center opens if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
      - EndTime (dict) --
        
        The end time that your contact center closes if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
  - EffectiveFrom (string) --
    
    The date from which the hours of operation override would be effective.
  - EffectiveTill (string) --
    
    The date till which the hours of operation override would be effective.

CreateHoursOfOperationOverride (new)

Link ¶

Creates an hours of operation override in an Amazon Connect hours of operation resource

See also: AWS API Documentation

Request Syntax

client.create_hours_of_operation_override(
    InstanceId='string',
    HoursOfOperationId='string',
    Name='string',
    Description='string',
    Config=[
        {
            'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
            'StartTime': {
                'Hours': 123,
                'Minutes': 123
            },
            'EndTime': {
                'Hours': 123,
                'Minutes': 123
            }
        },
    ],
    EffectiveFrom='string',
    EffectiveTill='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation

type Name:

string

param Name:

[REQUIRED]

The name of the hours of operation override.

type Description:

string

param Description:

The description of the hours of operation override.

type Config:

list

param Config:

[REQUIRED]

Configuration information for the hours of operation override: day, start time, and end time.

(dict) --

Information about the hours of operation override config: day, start time, and end time.
- Day (string) --
  
  The day that the hours of operation override applies to.
- StartTime (dict) --
  
  The start time when your contact center opens if overrides are applied.
  - Hours (integer) -- [REQUIRED]
    
    The hours.
  - Minutes (integer) -- [REQUIRED]
    
    The minutes.
- EndTime (dict) --
  
  The end time that your contact center closes if overrides are applied.
  - Hours (integer) -- [REQUIRED]
    
    The hours.
  - Minutes (integer) -- [REQUIRED]
    
    The minutes.

type EffectiveFrom:

string

param EffectiveFrom:

[REQUIRED]

The date from when the hours of operation override would be effective.

type EffectiveTill:

string

param EffectiveTill:

[REQUIRED]

The date until when the hours of operation override would be effective.

rtype:

dict

returns:

Response Syntax

{
    'HoursOfOperationOverrideId': 'string'
}

Response Structure

(dict) --
- HoursOfOperationOverrideId (string) --
  
  The identifier for the hours of operation override.

DeleteHoursOfOperationOverride (new)

Link ¶

Deletes an hours of operation override in an Amazon Connect hours of operation resource

See also: AWS API Documentation

Request Syntax

client.delete_hours_of_operation_override(
    InstanceId='string',
    HoursOfOperationId='string',
    HoursOfOperationOverrideId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

type HoursOfOperationOverrideId:

string

param HoursOfOperationOverrideId:

[REQUIRED]

The identifier for the hours of operation override.

returns:

None

GetEffectiveHoursOfOperations (new)

Link ¶

Get the hours of operations with the effective override applied.

See also: AWS API Documentation

Request Syntax

client.get_effective_hours_of_operations(
    InstanceId='string',
    HoursOfOperationId='string',
    FromDate='string',
    ToDate='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

type FromDate:

string

param FromDate:

[REQUIRED]

The Date from when the hours of operation are listed.

type ToDate:

string

param ToDate:

[REQUIRED]

The Date until when the hours of operation are listed.

rtype:

dict

returns:

Response Syntax

{
    'EffectiveHoursOfOperationList': [
        {
            'Date': 'string',
            'OperationalHours': [
                {
                    'Start': {
                        'Hours': 123,
                        'Minutes': 123
                    },
                    'End': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                },
            ]
        },
    ],
    'TimeZone': 'string'
}

Response Structure

(dict) --
- EffectiveHoursOfOperationList (list) --
  
  Information about the effective hours of operations
  - (dict) --
    
    Information about the hours of operations with the effective override applied.
    - Date (string) --
      
      The date that the hours of operation or overrides applies to.
    - OperationalHours (list) --
      
      Information about the hours of operations with the effective override applied.
      - (dict) --
        
        Information about the hours of operations with the effective override applied.
        
        Start (dict) --
        
        The start time that your contact center opens.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
        
        End (dict) --
        
        The end time that your contact center closes.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
- TimeZone (string) --
  
  The time zone for the hours of operation.

ListHoursOfOperationOverrides (new)

Link ¶

List the hours of operation overrides.

See also: AWS API Documentation

Request Syntax

client.list_hours_of_operation_overrides(
    InstanceId='string',
    HoursOfOperationId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation

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. Valid Range: Minimum value of 1. Maximum value of 1000.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'HoursOfOperationOverrideList': [
        {
            'HoursOfOperationOverrideId': 'string',
            'HoursOfOperationId': 'string',
            'HoursOfOperationArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Config': [
                {
                    'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                    'StartTime': {
                        'Hours': 123,
                        'Minutes': 123
                    },
                    'EndTime': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                },
            ],
            'EffectiveFrom': 'string',
            'EffectiveTill': 'string'
        },
    ],
    'LastModifiedRegion': 'string',
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- NextToken (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.
- HoursOfOperationOverrideList (list) --
  
  Information about the hours of operation override.
  - (dict) --
    
    Information about the hours of operations override.
    - HoursOfOperationOverrideId (string) --
      
      The identifier for the hours of operation override.
    - HoursOfOperationId (string) --
      
      The identifier for the hours of operation.
    - HoursOfOperationArn (string) --
      
      The Amazon Resource Name (ARN) for the hours of operation.
    - Name (string) --
      
      The name of the hours of operation override.
    - Description (string) --
      
      The description of the hours of operation override.
    - Config (list) --
      
      Configuration information for the hours of operation override: day, start time, and end time.
      - (dict) --
        
        Information about the hours of operation override config: day, start time, and end time.
        
        Day (string) --
        
        The day that the hours of operation override applies to.
        
        StartTime (dict) --
        
        The start time when your contact center opens if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
        
        EndTime (dict) --
        
        The end time that your contact center closes if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
    - EffectiveFrom (string) --
      
      The date from which the hours of operation override would be effective.
    - EffectiveTill (string) --
      
      The date till which the hours of operation override would be effective.
- LastModifiedRegion (string) --
  
  The AWS Region where this resource was last modified.
- LastModifiedTime (datetime) --
  
  The timestamp when this resource was last modified.

SearchHoursOfOperationOverrides (new)

Link ¶

Searches the hours of operation overrides.

See also: AWS API Documentation

Request Syntax

client.search_hours_of_operation_overrides(
    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'
        },
        'DateCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'
        }
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect 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. Length Constraints: Minimum length of 1. Maximum length of 2500.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 100.

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 hours of operations overrides.

OrConditions (list) --

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

A list of conditions which would be applied together with an AND condition.
- (dict) --
  
  The search criteria to be used to return hours of operations overrides.
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.
DateCondition (dict) --

A leaf node condition which can be used to specify a date condition.
- FieldName (string) --
  
  An object to specify the hours of operation override date field.
- Value (string) --
  
  An object to specify the hours of operation override date value.
- ComparisonType (string) --
  
  An object to specify the hours of operation override date condition comparisonType.

rtype:

dict

returns:

Response Syntax

{
    'HoursOfOperationOverrides': [
        {
            'HoursOfOperationOverrideId': 'string',
            'HoursOfOperationId': 'string',
            'HoursOfOperationArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'Config': [
                {
                    'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                    'StartTime': {
                        'Hours': 123,
                        'Minutes': 123
                    },
                    'EndTime': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                },
            ],
            'EffectiveFrom': 'string',
            'EffectiveTill': 'string'
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

(dict) --
- HoursOfOperationOverrides (list) --
  
  Information about the hours of operations overrides.
  - (dict) --
    
    Information about the hours of operations override.
    - HoursOfOperationOverrideId (string) --
      
      The identifier for the hours of operation override.
    - HoursOfOperationId (string) --
      
      The identifier for the hours of operation.
    - HoursOfOperationArn (string) --
      
      The Amazon Resource Name (ARN) for the hours of operation.
    - Name (string) --
      
      The name of the hours of operation override.
    - Description (string) --
      
      The description of the hours of operation override.
    - Config (list) --
      
      Configuration information for the hours of operation override: day, start time, and end time.
      - (dict) --
        
        Information about the hours of operation override config: day, start time, and end time.
        
        Day (string) --
        
        The day that the hours of operation override applies to.
        
        StartTime (dict) --
        
        The start time when your contact center opens if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
        
        EndTime (dict) --
        
        The end time that your contact center closes if overrides are applied.
        
        Hours (integer) --
        
        The hours.
        
        Minutes (integer) --
        
        The minutes.
    - EffectiveFrom (string) --
      
      The date from which the hours of operation override would be effective.
    - EffectiveTill (string) --
      
      The date till which the hours of operation override would be effective.
- NextToken (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. Length Constraints: Minimum length of 1. Maximum length of 2500.
- ApproximateTotalCount (integer) --
  
  The total number of hours of operations which matched your search query.

UpdateHoursOfOperationOverride (new)

Link ¶

Update the hours of operation override.

See also: AWS API Documentation

Request Syntax

client.update_hours_of_operation_override(
    InstanceId='string',
    HoursOfOperationId='string',
    HoursOfOperationOverrideId='string',
    Name='string',
    Description='string',
    Config=[
        {
            'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
            'StartTime': {
                'Hours': 123,
                'Minutes': 123
            },
            'EndTime': {
                'Hours': 123,
                'Minutes': 123
            }
        },
    ],
    EffectiveFrom='string',
    EffectiveTill='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

type HoursOfOperationOverrideId:

string

param HoursOfOperationOverrideId:

[REQUIRED]

The identifier for the hours of operation override.

type Name:

string

param Name:

The name of the hours of operation override.

type Description:

string

param Description:

The description of the hours of operation override.

type Config:

list

param Config:

Configuration information for the hours of operation override: day, start time, and end time.

(dict) --

Information about the hours of operation override config: day, start time, and end time.
- Day (string) --
  
  The day that the hours of operation override applies to.
- StartTime (dict) --
  
  The start time when your contact center opens if overrides are applied.
  - Hours (integer) -- [REQUIRED]
    
    The hours.
  - Minutes (integer) -- [REQUIRED]
    
    The minutes.
- EndTime (dict) --
  
  The end time that your contact center closes if overrides are applied.
  - Hours (integer) -- [REQUIRED]
    
    The hours.
  - Minutes (integer) -- [REQUIRED]
    
    The minutes.

type EffectiveFrom:

string

param EffectiveFrom:

The date from when the hours of operation override would be effective.

type EffectiveTill:

string

param EffectiveTill:

The date till when the hours of operation override would be effective.

returns:

None

SearchContactFlowModules (updated)

Link ¶
Changes (request)

{'SearchCriteria': {'StateCondition': 'ACTIVE | ARCHIVED',
                    'StatusCondition': 'PUBLISHED | SAVED'}}

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'
    }
)

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

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowModules': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Content': 'string',
            'Description': 'string',
            'State': 'ACTIVE'|'ARCHIVED',
            'Status': 'PUBLISHED'|'SAVED',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    '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) --
- 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.