ConnectClient
Auto-generated documentation for Connect type annotations stubs module types-aiobotocore-connect.
ConnectClient
Type annotations and code completion for session.client("connect")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_connect.client import ConnectClient
session = Session()
async with session.client("connect") as client:
client: ConnectClient
Exceptions
aioboto3 client exceptions are generated in runtime.
This class provides code completion for session.client("connect").exceptions structure.
async with session.client("connect") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ContactFlowNotPublishedException,
client.ContactNotFoundException,
client.DestinationNotAllowedException,
client.DuplicateResourceException,
client.IdempotencyException,
client.InternalServiceException,
client.InvalidContactFlowException,
client.InvalidContactFlowModuleException,
client.InvalidParameterException,
client.InvalidRequestException,
client.LimitExceededException,
client.OutboundContactNotPermittedException,
client.PropertyValidationException,
client.ResourceConflictException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.UserNotFoundException,
) as e:
print(e)
from types_aiobotocore_connect.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_approved_origin
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_approved_origin method.
boto3 documentation
await def associate_approved_origin(
self,
*,
InstanceId: str,
Origin: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociateApprovedOriginRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Origin": ...,
}
parent.associate_approved_origin(**kwargs)
associate_bot
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_bot method.
boto3 documentation
await def associate_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef = ..., # (1)
LexV2Bot: LexV2BotTypeDef = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See LexBotTypeDef
- See LexV2BotTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: AssociateBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.associate_bot(**kwargs)
associate_default_vocabulary
Associates an existing vocabulary as the default.
Type annotations and code completion for session.client("connect").associate_default_vocabulary method.
boto3 documentation
await def associate_default_vocabulary(
self,
*,
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: str = ...,
) -> Dict[str, Any]:
...
kwargs: AssociateDefaultVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LanguageCode": ...,
}
parent.associate_default_vocabulary(**kwargs)
associate_instance_storage_config
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_instance_storage_config method.
boto3 documentation
await def associate_instance_storage_config(
self,
*,
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
) -> AssociateInstanceStorageConfigResponseTypeDef: # (3)
...
- See InstanceStorageResourceTypeType
- See InstanceStorageConfigTypeDef
- See AssociateInstanceStorageConfigResponseTypeDef
kwargs: AssociateInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceType": ...,
"StorageConfig": ...,
}
parent.associate_instance_storage_config(**kwargs)
associate_lambda_function
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_lambda_function method.
boto3 documentation
await def associate_lambda_function(
self,
*,
InstanceId: str,
FunctionArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociateLambdaFunctionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FunctionArn": ...,
}
parent.associate_lambda_function(**kwargs)
associate_lex_bot
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_lex_bot method.
boto3 documentation
await def associate_lex_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: AssociateLexBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LexBot": ...,
}
parent.associate_lex_bot(**kwargs)
associate_phone_number_contact_flow
Associates a flow with a phone number claimed to your Amazon Connect instance.
Type annotations and code completion for session.client("connect").associate_phone_number_contact_flow method.
boto3 documentation
await def associate_phone_number_contact_flow(
self,
*,
PhoneNumberId: str,
InstanceId: str,
ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociatePhoneNumberContactFlowRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.associate_phone_number_contact_flow(**kwargs)
associate_queue_quick_connects
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_queue_quick_connects method.
boto3 documentation
await def associate_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: AssociateQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
parent.associate_queue_quick_connects(**kwargs)
associate_routing_profile_queues
Associates a set of queues with a routing profile.
Type annotations and code completion for session.client("connect").associate_routing_profile_queues method.
boto3 documentation
await def associate_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: AssociateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
parent.associate_routing_profile_queues(**kwargs)
associate_security_key
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").associate_security_key method.
boto3 documentation
await def associate_security_key(
self,
*,
InstanceId: str,
Key: str,
) -> AssociateSecurityKeyResponseTypeDef: # (1)
...
kwargs: AssociateSecurityKeyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Key": ...,
}
parent.associate_security_key(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("connect").can_paginate method.
boto3 documentation
claim_phone_number
Claims an available phone number to your Amazon Connect instance.
Type annotations and code completion for session.client("connect").claim_phone_number method.
boto3 documentation
await def claim_phone_number(
self,
*,
TargetArn: str,
PhoneNumber: str,
PhoneNumberDescription: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> ClaimPhoneNumberResponseTypeDef: # (1)
...
kwargs: ClaimPhoneNumberRequestRequestTypeDef = { # (1)
"TargetArn": ...,
"PhoneNumber": ...,
}
parent.claim_phone_number(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("connect").close method.
boto3 documentation
create_agent_status
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").create_agent_status method.
boto3 documentation
await def create_agent_status(
self,
*,
InstanceId: str,
Name: str,
State: AgentStatusStateType, # (1)
Description: str = ...,
DisplayOrder: int = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAgentStatusResponseTypeDef: # (2)
...
kwargs: CreateAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"State": ...,
}
parent.create_agent_status(**kwargs)
create_contact_flow
Creates a flow for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_contact_flow method.
boto3 documentation
await def create_contact_flow(
self,
*,
InstanceId: str,
Name: str,
Type: ContactFlowTypeType, # (1)
Content: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateContactFlowResponseTypeDef: # (2)
...
kwargs: CreateContactFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Type": ...,
"Content": ...,
}
parent.create_contact_flow(**kwargs)
create_contact_flow_module
Creates a flow module for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_contact_flow_module method.
boto3 documentation
await def create_contact_flow_module(
self,
*,
InstanceId: str,
Name: str,
Content: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> CreateContactFlowModuleResponseTypeDef: # (1)
...
kwargs: CreateContactFlowModuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Content": ...,
}
parent.create_contact_flow_module(**kwargs)
create_hours_of_operation
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").create_hours_of_operation method.
boto3 documentation
await def create_hours_of_operation(
self,
*,
InstanceId: str,
Name: str,
TimeZone: str,
Config: Sequence[HoursOfOperationConfigTypeDef], # (1)
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateHoursOfOperationResponseTypeDef: # (2)
...
kwargs: CreateHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"TimeZone": ...,
"Config": ...,
}
parent.create_hours_of_operation(**kwargs)
create_instance
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").create_instance method.
boto3 documentation
await def create_instance(
self,
*,
IdentityManagementType: DirectoryTypeType, # (1)
InboundCallsEnabled: bool,
OutboundCallsEnabled: bool,
ClientToken: str = ...,
InstanceAlias: str = ...,
DirectoryId: str = ...,
) -> CreateInstanceResponseTypeDef: # (2)
...
kwargs: CreateInstanceRequestRequestTypeDef = { # (1)
"IdentityManagementType": ...,
"InboundCallsEnabled": ...,
"OutboundCallsEnabled": ...,
}
parent.create_instance(**kwargs)
create_integration_association
Creates an Amazon Web Services resource association with an Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_integration_association method.
boto3 documentation
await def create_integration_association(
self,
*,
InstanceId: str,
IntegrationType: IntegrationTypeType, # (1)
IntegrationArn: str,
SourceApplicationUrl: str = ...,
SourceApplicationName: str = ...,
SourceType: SourceTypeType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateIntegrationAssociationResponseTypeDef: # (3)
...
kwargs: CreateIntegrationAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationType": ...,
"IntegrationArn": ...,
}
parent.create_integration_association(**kwargs)
create_queue
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").create_queue method.
boto3 documentation
await def create_queue(
self,
*,
InstanceId: str,
Name: str,
HoursOfOperationId: str,
Description: str = ...,
OutboundCallerConfig: OutboundCallerConfigTypeDef = ..., # (1)
MaxContacts: int = ...,
QuickConnectIds: Sequence[str] = ...,
Tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef: # (2)
...
kwargs: CreateQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"HoursOfOperationId": ...,
}
parent.create_queue(**kwargs)
create_quick_connect
Creates a quick connect for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_quick_connect method.
boto3 documentation
await def create_quick_connect(
self,
*,
InstanceId: str,
Name: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateQuickConnectResponseTypeDef: # (2)
...
kwargs: CreateQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"QuickConnectConfig": ...,
}
parent.create_quick_connect(**kwargs)
create_routing_profile
Creates a new routing profile.
Type annotations and code completion for session.client("connect").create_routing_profile method.
boto3 documentation
await def create_routing_profile(
self,
*,
InstanceId: str,
Name: str,
Description: str,
DefaultOutboundQueueId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef] = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateRoutingProfileResponseTypeDef: # (3)
...
- See MediaConcurrencyTypeDef
- See RoutingProfileQueueConfigTypeDef
- See CreateRoutingProfileResponseTypeDef
kwargs: CreateRoutingProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Description": ...,
"DefaultOutboundQueueId": ...,
"MediaConcurrencies": ...,
}
parent.create_routing_profile(**kwargs)
create_security_profile
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").create_security_profile method.
boto3 documentation
await def create_security_profile(
self,
*,
SecurityProfileName: str,
InstanceId: str,
Description: str = ...,
Permissions: Sequence[str] = ...,
Tags: Mapping[str, str] = ...,
) -> CreateSecurityProfileResponseTypeDef: # (1)
...
kwargs: CreateSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileName": ...,
"InstanceId": ...,
}
parent.create_security_profile(**kwargs)
create_task_template
Creates a new task template in the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_task_template method.
boto3 documentation
await def create_task_template(
self,
*,
InstanceId: str,
Name: str,
Fields: Sequence[TaskTemplateFieldTypeDef], # (1)
Description: str = ...,
ContactFlowId: str = ...,
Constraints: TaskTemplateConstraintsTypeDef = ..., # (2)
Defaults: TaskTemplateDefaultsTypeDef = ..., # (3)
Status: TaskTemplateStatusType = ..., # (4)
ClientToken: str = ...,
) -> CreateTaskTemplateResponseTypeDef: # (5)
...
- See TaskTemplateFieldTypeDef
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See CreateTaskTemplateResponseTypeDef
kwargs: CreateTaskTemplateRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Fields": ...,
}
parent.create_task_template(**kwargs)
create_use_case
Creates a use case for an integration association.
Type annotations and code completion for session.client("connect").create_use_case method.
boto3 documentation
await def create_use_case(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
UseCaseType: UseCaseTypeType, # (1)
Tags: Mapping[str, str] = ...,
) -> CreateUseCaseResponseTypeDef: # (2)
...
kwargs: CreateUseCaseRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseType": ...,
}
parent.create_use_case(**kwargs)
create_user
Creates a user account for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_user method.
boto3 documentation
await def create_user(
self,
*,
Username: str,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
SecurityProfileIds: Sequence[str],
RoutingProfileId: str,
InstanceId: str,
Password: str = ...,
IdentityInfo: UserIdentityInfoTypeDef = ..., # (2)
DirectoryUserId: str = ...,
HierarchyGroupId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateUserResponseTypeDef: # (3)
...
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"Username": ...,
"PhoneConfig": ...,
"SecurityProfileIds": ...,
"RoutingProfileId": ...,
"InstanceId": ...,
}
parent.create_user(**kwargs)
create_user_hierarchy_group
Creates a new user hierarchy group.
Type annotations and code completion for session.client("connect").create_user_hierarchy_group method.
boto3 documentation
await def create_user_hierarchy_group(
self,
*,
Name: str,
InstanceId: str,
ParentGroupId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateUserHierarchyGroupResponseTypeDef: # (1)
...
kwargs: CreateUserHierarchyGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceId": ...,
}
parent.create_user_hierarchy_group(**kwargs)
create_vocabulary
Creates a custom vocabulary associated with your Amazon Connect instance.
Type annotations and code completion for session.client("connect").create_vocabulary method.
boto3 documentation
await def create_vocabulary(
self,
*,
InstanceId: str,
VocabularyName: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
Content: str,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateVocabularyResponseTypeDef: # (2)
...
kwargs: CreateVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyName": ...,
"LanguageCode": ...,
"Content": ...,
}
parent.create_vocabulary(**kwargs)
delete_contact_flow
Deletes a flow for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").delete_contact_flow method.
boto3 documentation
await def delete_contact_flow(
self,
*,
InstanceId: str,
ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteContactFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.delete_contact_flow(**kwargs)
delete_contact_flow_module
Deletes the specified flow module.
Type annotations and code completion for session.client("connect").delete_contact_flow_module method.
boto3 documentation
await def delete_contact_flow_module(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteContactFlowModuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
parent.delete_contact_flow_module(**kwargs)
delete_hours_of_operation
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").delete_hours_of_operation method.
boto3 documentation
await def delete_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.delete_hours_of_operation(**kwargs)
delete_instance
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").delete_instance method.
boto3 documentation
await def delete_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.delete_instance(**kwargs)
delete_integration_association
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
Type annotations and code completion for session.client("connect").delete_integration_association method.
boto3 documentation
await def delete_integration_association(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIntegrationAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
parent.delete_integration_association(**kwargs)
delete_quick_connect
Deletes a quick connect.
Type annotations and code completion for session.client("connect").delete_quick_connect method.
boto3 documentation
await def delete_quick_connect(
self,
*,
InstanceId: str,
QuickConnectId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.delete_quick_connect(**kwargs)
delete_security_profile
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").delete_security_profile method.
boto3 documentation
await def delete_security_profile(
self,
*,
InstanceId: str,
SecurityProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteSecurityProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"SecurityProfileId": ...,
}
parent.delete_security_profile(**kwargs)
delete_task_template
Deletes the task template.
Type annotations and code completion for session.client("connect").delete_task_template method.
boto3 documentation
await def delete_task_template(
self,
*,
InstanceId: str,
TaskTemplateId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteTaskTemplateRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"TaskTemplateId": ...,
}
parent.delete_task_template(**kwargs)
delete_use_case
Deletes a use case from an integration association.
Type annotations and code completion for session.client("connect").delete_use_case method.
boto3 documentation
await def delete_use_case(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
UseCaseId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUseCaseRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseId": ...,
}
parent.delete_use_case(**kwargs)
delete_user
Deletes a user account from the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").delete_user method.
boto3 documentation
await def delete_user(
self,
*,
InstanceId: str,
UserId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
}
parent.delete_user(**kwargs)
delete_user_hierarchy_group
Deletes an existing user hierarchy group.
Type annotations and code completion for session.client("connect").delete_user_hierarchy_group method.
boto3 documentation
await def delete_user_hierarchy_group(
self,
*,
HierarchyGroupId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteUserHierarchyGroupRequestRequestTypeDef = { # (1)
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.delete_user_hierarchy_group(**kwargs)
delete_vocabulary
Deletes the vocabulary that has the given identifier.
Type annotations and code completion for session.client("connect").delete_vocabulary method.
boto3 documentation
await def delete_vocabulary(
self,
*,
InstanceId: str,
VocabularyId: str,
) -> DeleteVocabularyResponseTypeDef: # (1)
...
kwargs: DeleteVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyId": ...,
}
parent.delete_vocabulary(**kwargs)
describe_agent_status
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_agent_status method.
boto3 documentation
await def describe_agent_status(
self,
*,
InstanceId: str,
AgentStatusId: str,
) -> DescribeAgentStatusResponseTypeDef: # (1)
...
kwargs: DescribeAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AgentStatusId": ...,
}
parent.describe_agent_status(**kwargs)
describe_contact
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_contact method.
boto3 documentation
await def describe_contact(
self,
*,
InstanceId: str,
ContactId: str,
) -> DescribeContactResponseTypeDef: # (1)
...
kwargs: DescribeContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.describe_contact(**kwargs)
describe_contact_flow
Describes the specified flow.
Type annotations and code completion for session.client("connect").describe_contact_flow method.
boto3 documentation
await def describe_contact_flow(
self,
*,
InstanceId: str,
ContactFlowId: str,
) -> DescribeContactFlowResponseTypeDef: # (1)
...
kwargs: DescribeContactFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.describe_contact_flow(**kwargs)
describe_contact_flow_module
Describes the specified flow module.
Type annotations and code completion for session.client("connect").describe_contact_flow_module method.
boto3 documentation
await def describe_contact_flow_module(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
) -> DescribeContactFlowModuleResponseTypeDef: # (1)
...
kwargs: DescribeContactFlowModuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
parent.describe_contact_flow_module(**kwargs)
describe_hours_of_operation
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_hours_of_operation method.
boto3 documentation
await def describe_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
) -> DescribeHoursOfOperationResponseTypeDef: # (1)
...
kwargs: DescribeHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.describe_hours_of_operation(**kwargs)
describe_instance
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_instance method.
boto3 documentation
await def describe_instance(
self,
*,
InstanceId: str,
) -> DescribeInstanceResponseTypeDef: # (1)
...
kwargs: DescribeInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_instance(**kwargs)
describe_instance_attribute
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_instance_attribute method.
boto3 documentation
await def describe_instance_attribute(
self,
*,
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
) -> DescribeInstanceAttributeResponseTypeDef: # (2)
...
kwargs: DescribeInstanceAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AttributeType": ...,
}
parent.describe_instance_attribute(**kwargs)
describe_instance_storage_config
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_instance_storage_config method.
boto3 documentation
await def describe_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
) -> DescribeInstanceStorageConfigResponseTypeDef: # (2)
...
kwargs: DescribeInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
parent.describe_instance_storage_config(**kwargs)
describe_phone_number
Gets details and status of a phone number that’s claimed to your Amazon Connect instance See also: AWS API Documentation.
Type annotations and code completion for session.client("connect").describe_phone_number method.
boto3 documentation
await def describe_phone_number(
self,
*,
PhoneNumberId: str,
) -> DescribePhoneNumberResponseTypeDef: # (1)
...
kwargs: DescribePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.describe_phone_number(**kwargs)
describe_queue
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_queue method.
boto3 documentation
await def describe_queue(
self,
*,
InstanceId: str,
QueueId: str,
) -> DescribeQueueResponseTypeDef: # (1)
...
kwargs: DescribeQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.describe_queue(**kwargs)
describe_quick_connect
Describes the quick connect.
Type annotations and code completion for session.client("connect").describe_quick_connect method.
boto3 documentation
await def describe_quick_connect(
self,
*,
InstanceId: str,
QuickConnectId: str,
) -> DescribeQuickConnectResponseTypeDef: # (1)
...
kwargs: DescribeQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.describe_quick_connect(**kwargs)
describe_routing_profile
Describes the specified routing profile.
Type annotations and code completion for session.client("connect").describe_routing_profile method.
boto3 documentation
await def describe_routing_profile(
self,
*,
InstanceId: str,
RoutingProfileId: str,
) -> DescribeRoutingProfileResponseTypeDef: # (1)
...
kwargs: DescribeRoutingProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.describe_routing_profile(**kwargs)
describe_security_profile
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").describe_security_profile method.
boto3 documentation
await def describe_security_profile(
self,
*,
SecurityProfileId: str,
InstanceId: str,
) -> DescribeSecurityProfileResponseTypeDef: # (1)
...
kwargs: DescribeSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.describe_security_profile(**kwargs)
describe_user
Describes the specified user account.
Type annotations and code completion for session.client("connect").describe_user method.
boto3 documentation
await def describe_user(
self,
*,
UserId: str,
InstanceId: str,
) -> DescribeUserResponseTypeDef: # (1)
...
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"UserId": ...,
"InstanceId": ...,
}
parent.describe_user(**kwargs)
describe_user_hierarchy_group
Describes the specified hierarchy group.
Type annotations and code completion for session.client("connect").describe_user_hierarchy_group method.
boto3 documentation
await def describe_user_hierarchy_group(
self,
*,
HierarchyGroupId: str,
InstanceId: str,
) -> DescribeUserHierarchyGroupResponseTypeDef: # (1)
...
kwargs: DescribeUserHierarchyGroupRequestRequestTypeDef = { # (1)
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.describe_user_hierarchy_group(**kwargs)
describe_user_hierarchy_structure
Describes the hierarchy structure of the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").describe_user_hierarchy_structure method.
boto3 documentation
await def describe_user_hierarchy_structure(
self,
*,
InstanceId: str,
) -> DescribeUserHierarchyStructureResponseTypeDef: # (1)
...
kwargs: DescribeUserHierarchyStructureRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_user_hierarchy_structure(**kwargs)
describe_vocabulary
Describes the specified vocabulary.
Type annotations and code completion for session.client("connect").describe_vocabulary method.
boto3 documentation
await def describe_vocabulary(
self,
*,
InstanceId: str,
VocabularyId: str,
) -> DescribeVocabularyResponseTypeDef: # (1)
...
kwargs: DescribeVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyId": ...,
}
parent.describe_vocabulary(**kwargs)
disassociate_approved_origin
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_approved_origin method.
boto3 documentation
await def disassociate_approved_origin(
self,
*,
InstanceId: str,
Origin: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateApprovedOriginRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Origin": ...,
}
parent.disassociate_approved_origin(**kwargs)
disassociate_bot
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_bot method.
boto3 documentation
await def disassociate_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef = ..., # (1)
LexV2Bot: LexV2BotTypeDef = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See LexBotTypeDef
- See LexV2BotTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: DisassociateBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.disassociate_bot(**kwargs)
disassociate_instance_storage_config
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_instance_storage_config method.
boto3 documentation
await def disassociate_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: DisassociateInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
parent.disassociate_instance_storage_config(**kwargs)
disassociate_lambda_function
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_lambda_function method.
boto3 documentation
await def disassociate_lambda_function(
self,
*,
InstanceId: str,
FunctionArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateLambdaFunctionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FunctionArn": ...,
}
parent.disassociate_lambda_function(**kwargs)
disassociate_lex_bot
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_lex_bot method.
boto3 documentation
await def disassociate_lex_bot(
self,
*,
InstanceId: str,
BotName: str,
LexRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateLexBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"BotName": ...,
"LexRegion": ...,
}
parent.disassociate_lex_bot(**kwargs)
disassociate_phone_number_contact_flow
Removes the flow association from a phone number claimed to your Amazon Connect instance, if a flow association exists.
Type annotations and code completion for session.client("connect").disassociate_phone_number_contact_flow method.
boto3 documentation
await def disassociate_phone_number_contact_flow(
self,
*,
PhoneNumberId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociatePhoneNumberContactFlowRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
"InstanceId": ...,
}
parent.disassociate_phone_number_contact_flow(**kwargs)
disassociate_queue_quick_connects
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_queue_quick_connects method.
boto3 documentation
await def disassociate_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
parent.disassociate_queue_quick_connects(**kwargs)
disassociate_routing_profile_queues
Disassociates a set of queues from a routing profile.
Type annotations and code completion for session.client("connect").disassociate_routing_profile_queues method.
boto3 documentation
await def disassociate_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: DisassociateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueReferences": ...,
}
parent.disassociate_routing_profile_queues(**kwargs)
disassociate_security_key
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").disassociate_security_key method.
boto3 documentation
await def disassociate_security_key(
self,
*,
InstanceId: str,
AssociationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateSecurityKeyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
}
parent.disassociate_security_key(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("connect").generate_presigned_url method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_contact_attributes
Retrieves the contact attributes for the specified contact.
Type annotations and code completion for session.client("connect").get_contact_attributes method.
boto3 documentation
await def get_contact_attributes(
self,
*,
InstanceId: str,
InitialContactId: str,
) -> GetContactAttributesResponseTypeDef: # (1)
...
kwargs: GetContactAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"InitialContactId": ...,
}
parent.get_contact_attributes(**kwargs)
get_current_metric_data
Gets the real-time metric data from the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").get_current_metric_data method.
boto3 documentation
await def get_current_metric_data(
self,
*,
InstanceId: str,
Filters: FiltersTypeDef, # (1)
CurrentMetrics: Sequence[CurrentMetricTypeDef], # (2)
Groupings: Sequence[GroupingType] = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetCurrentMetricDataResponseTypeDef: # (4)
...
- See FiltersTypeDef
- See CurrentMetricTypeDef
- See GroupingType
- See GetCurrentMetricDataResponseTypeDef
kwargs: GetCurrentMetricDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Filters": ...,
"CurrentMetrics": ...,
}
parent.get_current_metric_data(**kwargs)
get_current_user_data
Gets the real-time active user data from the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").get_current_user_data method.
boto3 documentation
await def get_current_user_data(
self,
*,
InstanceId: str,
Filters: UserDataFiltersTypeDef, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetCurrentUserDataResponseTypeDef: # (2)
...
kwargs: GetCurrentUserDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Filters": ...,
}
parent.get_current_user_data(**kwargs)
get_federation_token
Retrieves a token for federation.
Type annotations and code completion for session.client("connect").get_federation_token method.
boto3 documentation
await def get_federation_token(
self,
*,
InstanceId: str,
) -> GetFederationTokenResponseTypeDef: # (1)
...
kwargs: GetFederationTokenRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.get_federation_token(**kwargs)
get_metric_data
Gets historical metric data from the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").get_metric_data method.
boto3 documentation
await def get_metric_data(
self,
*,
InstanceId: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: Sequence[GroupingType] = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetMetricDataResponseTypeDef: # (4)
...
kwargs: GetMetricDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"StartTime": ...,
"EndTime": ...,
"Filters": ...,
"HistoricalMetrics": ...,
}
parent.get_metric_data(**kwargs)
get_task_template
Gets details about a specific task template in the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").get_task_template method.
boto3 documentation
await def get_task_template(
self,
*,
InstanceId: str,
TaskTemplateId: str,
SnapshotVersion: str = ...,
) -> GetTaskTemplateResponseTypeDef: # (1)
...
kwargs: GetTaskTemplateRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"TaskTemplateId": ...,
}
parent.get_task_template(**kwargs)
list_agent_statuses
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_agent_statuses method.
boto3 documentation
await def list_agent_statuses(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
AgentStatusTypes: Sequence[AgentStatusTypeType] = ..., # (1)
) -> ListAgentStatusResponseTypeDef: # (2)
...
kwargs: ListAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_agent_statuses(**kwargs)
list_approved_origins
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_approved_origins method.
boto3 documentation
await def list_approved_origins(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListApprovedOriginsResponseTypeDef: # (1)
...
kwargs: ListApprovedOriginsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_approved_origins(**kwargs)
list_bots
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_bots method.
boto3 documentation
await def list_bots(
self,
*,
InstanceId: str,
LexVersion: LexVersionType, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBotsResponseTypeDef: # (2)
...
kwargs: ListBotsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LexVersion": ...,
}
parent.list_bots(**kwargs)
list_contact_flow_modules
Provides information about the flow modules for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_contact_flow_modules method.
boto3 documentation
await def list_contact_flow_modules(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
ContactFlowModuleState: ContactFlowModuleStateType = ..., # (1)
) -> ListContactFlowModulesResponseTypeDef: # (2)
...
kwargs: ListContactFlowModulesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_contact_flow_modules(**kwargs)
list_contact_flows
Provides information about the flows for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_contact_flows method.
boto3 documentation
await def list_contact_flows(
self,
*,
InstanceId: str,
ContactFlowTypes: Sequence[ContactFlowTypeType] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContactFlowsResponseTypeDef: # (2)
...
kwargs: ListContactFlowsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_contact_flows(**kwargs)
list_contact_references
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_contact_references method.
boto3 documentation
await def list_contact_references(
self,
*,
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
NextToken: str = ...,
) -> ListContactReferencesResponseTypeDef: # (2)
...
kwargs: ListContactReferencesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ReferenceTypes": ...,
}
parent.list_contact_references(**kwargs)
list_default_vocabularies
Lists the default vocabularies for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_default_vocabularies method.
boto3 documentation
await def list_default_vocabularies(
self,
*,
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDefaultVocabulariesResponseTypeDef: # (2)
...
kwargs: ListDefaultVocabulariesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_default_vocabularies(**kwargs)
list_hours_of_operations
Provides information about the hours of operation for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_hours_of_operations method.
boto3 documentation
await def list_hours_of_operations(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListHoursOfOperationsResponseTypeDef: # (1)
...
kwargs: ListHoursOfOperationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_hours_of_operations(**kwargs)
list_instance_attributes
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_instance_attributes method.
boto3 documentation
await def list_instance_attributes(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstanceAttributesResponseTypeDef: # (1)
...
kwargs: ListInstanceAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_instance_attributes(**kwargs)
list_instance_storage_configs
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_instance_storage_configs method.
boto3 documentation
await def list_instance_storage_configs(
self,
*,
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstanceStorageConfigsResponseTypeDef: # (2)
...
kwargs: ListInstanceStorageConfigsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceType": ...,
}
parent.list_instance_storage_configs(**kwargs)
list_instances
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_instances method.
boto3 documentation
await def list_instances(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstancesResponseTypeDef: # (1)
...
kwargs: ListInstancesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_instances(**kwargs)
list_integration_associations
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_integration_associations method.
boto3 documentation
await def list_integration_associations(
self,
*,
InstanceId: str,
IntegrationType: IntegrationTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIntegrationAssociationsResponseTypeDef: # (2)
...
kwargs: ListIntegrationAssociationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_integration_associations(**kwargs)
list_lambda_functions
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_lambda_functions method.
boto3 documentation
await def list_lambda_functions(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLambdaFunctionsResponseTypeDef: # (1)
...
kwargs: ListLambdaFunctionsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_lambda_functions(**kwargs)
list_lex_bots
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_lex_bots method.
boto3 documentation
await def list_lex_bots(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLexBotsResponseTypeDef: # (1)
...
kwargs: ListLexBotsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_lex_bots(**kwargs)
list_phone_numbers
Provides information about the phone numbers for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_phone_numbers method.
boto3 documentation
await def list_phone_numbers(
self,
*,
InstanceId: str,
PhoneNumberTypes: Sequence[PhoneNumberTypeType] = ..., # (1)
PhoneNumberCountryCodes: Sequence[PhoneNumberCountryCodeType] = ..., # (2)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPhoneNumbersResponseTypeDef: # (3)
...
kwargs: ListPhoneNumbersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_phone_numbers(**kwargs)
list_phone_numbers_v2
Lists phone numbers claimed to your Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_phone_numbers_v2 method.
boto3 documentation
await def list_phone_numbers_v2(
self,
*,
TargetArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
PhoneNumberCountryCodes: Sequence[PhoneNumberCountryCodeType] = ..., # (1)
PhoneNumberTypes: Sequence[PhoneNumberTypeType] = ..., # (2)
PhoneNumberPrefix: str = ...,
) -> ListPhoneNumbersV2ResponseTypeDef: # (3)
...
kwargs: ListPhoneNumbersV2RequestRequestTypeDef = { # (1)
"TargetArn": ...,
}
parent.list_phone_numbers_v2(**kwargs)
list_prompts
Provides information about the prompts for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_prompts method.
boto3 documentation
await def list_prompts(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPromptsResponseTypeDef: # (1)
...
kwargs: ListPromptsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_prompts(**kwargs)
list_queue_quick_connects
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_queue_quick_connects method.
boto3 documentation
await def list_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQueueQuickConnectsResponseTypeDef: # (1)
...
kwargs: ListQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.list_queue_quick_connects(**kwargs)
list_queues
Provides information about the queues for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_queues method.
boto3 documentation
await def list_queues(
self,
*,
InstanceId: str,
QueueTypes: Sequence[QueueTypeType] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQueuesResponseTypeDef: # (2)
...
kwargs: ListQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_queues(**kwargs)
list_quick_connects
Provides information about the quick connects for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_quick_connects method.
boto3 documentation
await def list_quick_connects(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
QuickConnectTypes: Sequence[QuickConnectTypeType] = ..., # (1)
) -> ListQuickConnectsResponseTypeDef: # (2)
...
kwargs: ListQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_quick_connects(**kwargs)
list_routing_profile_queues
Lists the queues associated with a routing profile.
Type annotations and code completion for session.client("connect").list_routing_profile_queues method.
boto3 documentation
await def list_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRoutingProfileQueuesResponseTypeDef: # (1)
...
kwargs: ListRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.list_routing_profile_queues(**kwargs)
list_routing_profiles
Provides summary information about the routing profiles for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_routing_profiles method.
boto3 documentation
await def list_routing_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRoutingProfilesResponseTypeDef: # (1)
...
kwargs: ListRoutingProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_routing_profiles(**kwargs)
list_security_keys
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_security_keys method.
boto3 documentation
await def list_security_keys(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityKeysResponseTypeDef: # (1)
...
kwargs: ListSecurityKeysRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_security_keys(**kwargs)
list_security_profile_permissions
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").list_security_profile_permissions method.
boto3 documentation
await def list_security_profile_permissions(
self,
*,
SecurityProfileId: str,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityProfilePermissionsResponseTypeDef: # (1)
...
kwargs: ListSecurityProfilePermissionsRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.list_security_profile_permissions(**kwargs)
list_security_profiles
Provides summary information about the security profiles for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_security_profiles method.
boto3 documentation
await def list_security_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityProfilesResponseTypeDef: # (1)
...
kwargs: ListSecurityProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_security_profiles(**kwargs)
list_tags_for_resource
Lists the tags for the specified resource.
Type annotations and code completion for session.client("connect").list_tags_for_resource method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_task_templates
Lists task templates for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_task_templates method.
boto3 documentation
await def list_task_templates(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
Status: TaskTemplateStatusType = ..., # (1)
Name: str = ...,
) -> ListTaskTemplatesResponseTypeDef: # (2)
...
kwargs: ListTaskTemplatesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_task_templates(**kwargs)
list_use_cases
Lists the use cases for the integration association.
Type annotations and code completion for session.client("connect").list_use_cases method.
boto3 documentation
await def list_use_cases(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUseCasesResponseTypeDef: # (1)
...
kwargs: ListUseCasesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
parent.list_use_cases(**kwargs)
list_user_hierarchy_groups
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_user_hierarchy_groups method.
boto3 documentation
await def list_user_hierarchy_groups(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUserHierarchyGroupsResponseTypeDef: # (1)
...
kwargs: ListUserHierarchyGroupsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_user_hierarchy_groups(**kwargs)
list_users
Provides summary information about the users for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").list_users method.
boto3 documentation
await def list_users(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_users(**kwargs)
put_user_status
Changes the current status of a user or agent in Amazon Connect.
Type annotations and code completion for session.client("connect").put_user_status method.
boto3 documentation
await def put_user_status(
self,
*,
UserId: str,
InstanceId: str,
AgentStatusId: str,
) -> Dict[str, Any]:
...
kwargs: PutUserStatusRequestRequestTypeDef = { # (1)
"UserId": ...,
"InstanceId": ...,
"AgentStatusId": ...,
}
parent.put_user_status(**kwargs)
release_phone_number
Releases a phone number previously claimed to an Amazon Connect instance.
Type annotations and code completion for session.client("connect").release_phone_number method.
boto3 documentation
await def release_phone_number(
self,
*,
PhoneNumberId: str,
ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ReleasePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.release_phone_number(**kwargs)
resume_contact_recording
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Type annotations and code completion for session.client("connect").resume_contact_recording method.
boto3 documentation
await def resume_contact_recording(
self,
*,
InstanceId: str,
ContactId: str,
InitialContactId: str,
) -> Dict[str, Any]:
...
kwargs: ResumeContactRecordingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
parent.resume_contact_recording(**kwargs)
search_available_phone_numbers
Searches for available phone numbers that you can claim to your Amazon Connect instance.
Type annotations and code completion for session.client("connect").search_available_phone_numbers method.
boto3 documentation
await def search_available_phone_numbers(
self,
*,
TargetArn: str,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
PhoneNumberPrefix: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> SearchAvailablePhoneNumbersResponseTypeDef: # (3)
...
- See PhoneNumberCountryCodeType
- See PhoneNumberTypeType
- See SearchAvailablePhoneNumbersResponseTypeDef
kwargs: SearchAvailablePhoneNumbersRequestRequestTypeDef = { # (1)
"TargetArn": ...,
"PhoneNumberCountryCode": ...,
"PhoneNumberType": ...,
}
parent.search_available_phone_numbers(**kwargs)
search_security_profiles
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").search_security_profiles method.
boto3 documentation
await def search_security_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchCriteria: SecurityProfileSearchCriteriaTypeDef = ..., # (1)
SearchFilter: SecurityProfilesSearchFilterTypeDef = ..., # (2)
) -> SearchSecurityProfilesResponseTypeDef: # (3)
...
- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfilesSearchFilterTypeDef
- See SearchSecurityProfilesResponseTypeDef
kwargs: SearchSecurityProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_security_profiles(**kwargs)
search_users
Searches users in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for session.client("connect").search_users method.
boto3 documentation
await def search_users(
self,
*,
InstanceId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: UserSearchFilterTypeDef = ..., # (1)
SearchCriteria: UserSearchCriteriaTypeDef = ..., # (2)
) -> SearchUsersResponseTypeDef: # (3)
...
kwargs: SearchUsersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_users(**kwargs)
search_vocabularies
Searches for vocabularies within a specific Amazon Connect instance using
State , NameStartsWith , and LanguageCode .
Type annotations and code completion for session.client("connect").search_vocabularies method.
boto3 documentation
await def search_vocabularies(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
State: VocabularyStateType = ..., # (1)
NameStartsWith: str = ...,
LanguageCode: VocabularyLanguageCodeType = ..., # (2)
) -> SearchVocabulariesResponseTypeDef: # (3)
...
kwargs: SearchVocabulariesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_vocabularies(**kwargs)
start_chat_contact
Initiates a flow to start a new chat for the customer.
Type annotations and code completion for session.client("connect").start_chat_contact method.
boto3 documentation
await def start_chat_contact(
self,
*,
InstanceId: str,
ContactFlowId: str,
ParticipantDetails: ParticipantDetailsTypeDef, # (1)
Attributes: Mapping[str, str] = ...,
InitialMessage: ChatMessageTypeDef = ..., # (2)
ClientToken: str = ...,
ChatDurationInMinutes: int = ...,
SupportedMessagingContentTypes: Sequence[str] = ...,
) -> StartChatContactResponseTypeDef: # (3)
...
kwargs: StartChatContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
"ParticipantDetails": ...,
}
parent.start_chat_contact(**kwargs)
start_contact_recording
Starts recording the contact * If the API is called before the agent joins the call, recording starts when the agent joins the call.
Type annotations and code completion for session.client("connect").start_contact_recording method.
boto3 documentation
await def start_contact_recording(
self,
*,
InstanceId: str,
ContactId: str,
InitialContactId: str,
VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: StartContactRecordingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
"VoiceRecordingConfiguration": ...,
}
parent.start_contact_recording(**kwargs)
start_contact_streaming
Initiates real-time message streaming for a new chat contact.
Type annotations and code completion for session.client("connect").start_contact_streaming method.
boto3 documentation
await def start_contact_streaming(
self,
*,
InstanceId: str,
ContactId: str,
ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef, # (1)
ClientToken: str,
) -> StartContactStreamingResponseTypeDef: # (2)
...
kwargs: StartContactStreamingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ChatStreamingConfiguration": ...,
"ClientToken": ...,
}
parent.start_contact_streaming(**kwargs)
start_outbound_voice_contact
Places an outbound call to a contact, and then initiates the flow.
Type annotations and code completion for session.client("connect").start_outbound_voice_contact method.
boto3 documentation
await def start_outbound_voice_contact(
self,
*,
DestinationPhoneNumber: str,
ContactFlowId: str,
InstanceId: str,
ClientToken: str = ...,
SourcePhoneNumber: str = ...,
QueueId: str = ...,
Attributes: Mapping[str, str] = ...,
AnswerMachineDetectionConfig: AnswerMachineDetectionConfigTypeDef = ..., # (1)
CampaignId: str = ...,
TrafficType: TrafficTypeType = ..., # (2)
) -> StartOutboundVoiceContactResponseTypeDef: # (3)
...
- See AnswerMachineDetectionConfigTypeDef
- See TrafficTypeType
- See StartOutboundVoiceContactResponseTypeDef
kwargs: StartOutboundVoiceContactRequestRequestTypeDef = { # (1)
"DestinationPhoneNumber": ...,
"ContactFlowId": ...,
"InstanceId": ...,
}
parent.start_outbound_voice_contact(**kwargs)
start_task_contact
Initiates a flow to start a new task.
Type annotations and code completion for session.client("connect").start_task_contact method.
boto3 documentation
await def start_task_contact(
self,
*,
InstanceId: str,
Name: str,
PreviousContactId: str = ...,
ContactFlowId: str = ...,
Attributes: Mapping[str, str] = ...,
References: Mapping[str, ReferenceTypeDef] = ..., # (1)
Description: str = ...,
ClientToken: str = ...,
ScheduledTime: Union[datetime, str] = ...,
TaskTemplateId: str = ...,
QuickConnectId: str = ...,
) -> StartTaskContactResponseTypeDef: # (2)
...
kwargs: StartTaskContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
}
parent.start_task_contact(**kwargs)
stop_contact
Ends the specified contact.
Type annotations and code completion for session.client("connect").stop_contact method.
boto3 documentation
await def stop_contact(
self,
*,
ContactId: str,
InstanceId: str,
) -> Dict[str, Any]:
...
kwargs: StopContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
}
parent.stop_contact(**kwargs)
stop_contact_recording
Stops recording a call when a contact is being recorded.
Type annotations and code completion for session.client("connect").stop_contact_recording method.
boto3 documentation
await def stop_contact_recording(
self,
*,
InstanceId: str,
ContactId: str,
InitialContactId: str,
) -> Dict[str, Any]:
...
kwargs: StopContactRecordingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
parent.stop_contact_recording(**kwargs)
stop_contact_streaming
Ends message streaming on a specified contact.
Type annotations and code completion for session.client("connect").stop_contact_streaming method.
boto3 documentation
await def stop_contact_streaming(
self,
*,
InstanceId: str,
ContactId: str,
StreamingId: str,
) -> Dict[str, Any]:
...
kwargs: StopContactStreamingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"StreamingId": ...,
}
parent.stop_contact_streaming(**kwargs)
suspend_contact_recording
When a contact is being recorded, this API suspends recording the call.
Type annotations and code completion for session.client("connect").suspend_contact_recording method.
boto3 documentation
await def suspend_contact_recording(
self,
*,
InstanceId: str,
ContactId: str,
InitialContactId: str,
) -> Dict[str, Any]:
...
kwargs: SuspendContactRecordingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
}
parent.suspend_contact_recording(**kwargs)
tag_resource
Adds the specified tags to the specified resource.
Type annotations and code completion for session.client("connect").tag_resource method.
boto3 documentation
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
transfer_contact
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
Type annotations and code completion for session.client("connect").transfer_contact method.
boto3 documentation
await def transfer_contact(
self,
*,
InstanceId: str,
ContactId: str,
ContactFlowId: str,
QueueId: str = ...,
UserId: str = ...,
ClientToken: str = ...,
) -> TransferContactResponseTypeDef: # (1)
...
kwargs: TransferContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ContactFlowId": ...,
}
parent.transfer_contact(**kwargs)
untag_resource
Removes the specified tags from the specified resource.
Type annotations and code completion for session.client("connect").untag_resource method.
boto3 documentation
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_agent_status
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_agent_status method.
boto3 documentation
await def update_agent_status(
self,
*,
InstanceId: str,
AgentStatusId: str,
Name: str = ...,
Description: str = ...,
State: AgentStatusStateType = ..., # (1)
DisplayOrder: int = ...,
ResetOrderNumber: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AgentStatusId": ...,
}
parent.update_agent_status(**kwargs)
update_contact
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_contact method.
boto3 documentation
await def update_contact(
self,
*,
InstanceId: str,
ContactId: str,
Name: str = ...,
Description: str = ...,
References: Mapping[str, ReferenceTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
- See ReferenceTypeDef
kwargs: UpdateContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.update_contact(**kwargs)
update_contact_attributes
Creates or updates user-defined contact attributes associated with the specified contact.
Type annotations and code completion for session.client("connect").update_contact_attributes method.
boto3 documentation
await def update_contact_attributes(
self,
*,
InitialContactId: str,
InstanceId: str,
Attributes: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: UpdateContactAttributesRequestRequestTypeDef = { # (1)
"InitialContactId": ...,
"InstanceId": ...,
"Attributes": ...,
}
parent.update_contact_attributes(**kwargs)
update_contact_flow_content
Updates the specified flow.
Type annotations and code completion for session.client("connect").update_contact_flow_content method.
boto3 documentation
await def update_contact_flow_content(
self,
*,
InstanceId: str,
ContactFlowId: str,
Content: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateContactFlowContentRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
"Content": ...,
}
parent.update_contact_flow_content(**kwargs)
update_contact_flow_metadata
Updates metadata about specified flow.
Type annotations and code completion for session.client("connect").update_contact_flow_metadata method.
boto3 documentation
await def update_contact_flow_metadata(
self,
*,
InstanceId: str,
ContactFlowId: str,
Name: str = ...,
Description: str = ...,
ContactFlowState: ContactFlowStateType = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateContactFlowMetadataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.update_contact_flow_metadata(**kwargs)
update_contact_flow_module_content
Updates specified flow module for the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").update_contact_flow_module_content method.
boto3 documentation
await def update_contact_flow_module_content(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
Content: str,
) -> Dict[str, Any]:
...
kwargs: UpdateContactFlowModuleContentRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
"Content": ...,
}
parent.update_contact_flow_module_content(**kwargs)
update_contact_flow_module_metadata
Updates metadata about specified flow module.
Type annotations and code completion for session.client("connect").update_contact_flow_module_metadata method.
boto3 documentation
await def update_contact_flow_module_metadata(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
Name: str = ...,
Description: str = ...,
State: ContactFlowModuleStateType = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateContactFlowModuleMetadataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
parent.update_contact_flow_module_metadata(**kwargs)
update_contact_flow_name
The name of the flow.
Type annotations and code completion for session.client("connect").update_contact_flow_name method.
boto3 documentation
await def update_contact_flow_name(
self,
*,
InstanceId: str,
ContactFlowId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateContactFlowNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.update_contact_flow_name(**kwargs)
update_contact_schedule
Updates the scheduled time of a task contact that is already scheduled.
Type annotations and code completion for session.client("connect").update_contact_schedule method.
boto3 documentation
await def update_contact_schedule(
self,
*,
InstanceId: str,
ContactId: str,
ScheduledTime: Union[datetime, str],
) -> Dict[str, Any]:
...
kwargs: UpdateContactScheduleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ScheduledTime": ...,
}
parent.update_contact_schedule(**kwargs)
update_hours_of_operation
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_hours_of_operation method.
boto3 documentation
await def update_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
Name: str = ...,
Description: str = ...,
TimeZone: str = ...,
Config: Sequence[HoursOfOperationConfigTypeDef] = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.update_hours_of_operation(**kwargs)
update_instance_attribute
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_instance_attribute method.
boto3 documentation
await def update_instance_attribute(
self,
*,
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
Value: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateInstanceAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AttributeType": ...,
"Value": ...,
}
parent.update_instance_attribute(**kwargs)
update_instance_storage_config
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_instance_storage_config method.
boto3 documentation
await def update_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See InstanceStorageResourceTypeType
- See InstanceStorageConfigTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: UpdateInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
"StorageConfig": ...,
}
parent.update_instance_storage_config(**kwargs)
update_phone_number
Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.
Type annotations and code completion for session.client("connect").update_phone_number method.
boto3 documentation
await def update_phone_number(
self,
*,
PhoneNumberId: str,
TargetArn: str,
ClientToken: str = ...,
) -> UpdatePhoneNumberResponseTypeDef: # (1)
...
kwargs: UpdatePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
"TargetArn": ...,
}
parent.update_phone_number(**kwargs)
update_queue_hours_of_operation
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_queue_hours_of_operation method.
boto3 documentation
await def update_queue_hours_of_operation(
self,
*,
InstanceId: str,
QueueId: str,
HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateQueueHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"HoursOfOperationId": ...,
}
parent.update_queue_hours_of_operation(**kwargs)
update_queue_max_contacts
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_queue_max_contacts method.
boto3 documentation
await def update_queue_max_contacts(
self,
*,
InstanceId: str,
QueueId: str,
MaxContacts: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateQueueMaxContactsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.update_queue_max_contacts(**kwargs)
update_queue_name
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_queue_name method.
boto3 documentation
await def update_queue_name(
self,
*,
InstanceId: str,
QueueId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateQueueNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.update_queue_name(**kwargs)
update_queue_outbound_caller_config
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_queue_outbound_caller_config method.
boto3 documentation
await def update_queue_outbound_caller_config(
self,
*,
InstanceId: str,
QueueId: str,
OutboundCallerConfig: OutboundCallerConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateQueueOutboundCallerConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"OutboundCallerConfig": ...,
}
parent.update_queue_outbound_caller_config(**kwargs)
update_queue_status
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_queue_status method.
boto3 documentation
await def update_queue_status(
self,
*,
InstanceId: str,
QueueId: str,
Status: QueueStatusType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateQueueStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"Status": ...,
}
parent.update_queue_status(**kwargs)
update_quick_connect_config
Updates the configuration settings for the specified quick connect.
Type annotations and code completion for session.client("connect").update_quick_connect_config method.
boto3 documentation
await def update_quick_connect_config(
self,
*,
InstanceId: str,
QuickConnectId: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateQuickConnectConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
"QuickConnectConfig": ...,
}
parent.update_quick_connect_config(**kwargs)
update_quick_connect_name
Updates the name and description of a quick connect.
Type annotations and code completion for session.client("connect").update_quick_connect_name method.
boto3 documentation
await def update_quick_connect_name(
self,
*,
InstanceId: str,
QuickConnectId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateQuickConnectNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.update_quick_connect_name(**kwargs)
update_routing_profile_concurrency
Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
Type annotations and code completion for session.client("connect").update_routing_profile_concurrency method.
boto3 documentation
await def update_routing_profile_concurrency(
self,
*,
InstanceId: str,
RoutingProfileId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateRoutingProfileConcurrencyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"MediaConcurrencies": ...,
}
parent.update_routing_profile_concurrency(**kwargs)
update_routing_profile_default_outbound_queue
Updates the default outbound queue of a routing profile.
Type annotations and code completion for session.client("connect").update_routing_profile_default_outbound_queue method.
boto3 documentation
await def update_routing_profile_default_outbound_queue(
self,
*,
InstanceId: str,
RoutingProfileId: str,
DefaultOutboundQueueId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"DefaultOutboundQueueId": ...,
}
parent.update_routing_profile_default_outbound_queue(**kwargs)
update_routing_profile_name
Updates the name and description of a routing profile.
Type annotations and code completion for session.client("connect").update_routing_profile_name method.
boto3 documentation
await def update_routing_profile_name(
self,
*,
InstanceId: str,
RoutingProfileId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateRoutingProfileNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.update_routing_profile_name(**kwargs)
update_routing_profile_queues
Updates the properties associated with a set of queues for a routing profile.
Type annotations and code completion for session.client("connect").update_routing_profile_queues method.
boto3 documentation
await def update_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
parent.update_routing_profile_queues(**kwargs)
update_security_profile
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for session.client("connect").update_security_profile method.
boto3 documentation
await def update_security_profile(
self,
*,
SecurityProfileId: str,
InstanceId: str,
Description: str = ...,
Permissions: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.update_security_profile(**kwargs)
update_task_template
Updates details about a specific task template in the specified Amazon Connect instance.
Type annotations and code completion for session.client("connect").update_task_template method.
boto3 documentation
await def update_task_template(
self,
*,
TaskTemplateId: str,
InstanceId: str,
Name: str = ...,
Description: str = ...,
ContactFlowId: str = ...,
Constraints: TaskTemplateConstraintsTypeDef = ..., # (1)
Defaults: TaskTemplateDefaultsTypeDef = ..., # (2)
Status: TaskTemplateStatusType = ..., # (3)
Fields: Sequence[TaskTemplateFieldTypeDef] = ..., # (4)
) -> UpdateTaskTemplateResponseTypeDef: # (5)
...
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See TaskTemplateFieldTypeDef
- See UpdateTaskTemplateResponseTypeDef
kwargs: UpdateTaskTemplateRequestRequestTypeDef = { # (1)
"TaskTemplateId": ...,
"InstanceId": ...,
}
parent.update_task_template(**kwargs)
update_user_hierarchy
Assigns the specified hierarchy group to the specified user.
Type annotations and code completion for session.client("connect").update_user_hierarchy method.
boto3 documentation
await def update_user_hierarchy(
self,
*,
UserId: str,
InstanceId: str,
HierarchyGroupId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserHierarchyRequestRequestTypeDef = { # (1)
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy(**kwargs)
update_user_hierarchy_group_name
Updates the name of the user hierarchy group.
Type annotations and code completion for session.client("connect").update_user_hierarchy_group_name method.
boto3 documentation
await def update_user_hierarchy_group_name(
self,
*,
Name: str,
HierarchyGroupId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserHierarchyGroupNameRequestRequestTypeDef = { # (1)
"Name": ...,
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy_group_name(**kwargs)
update_user_hierarchy_structure
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
Type annotations and code completion for session.client("connect").update_user_hierarchy_structure method.
boto3 documentation
await def update_user_hierarchy_structure(
self,
*,
HierarchyStructure: HierarchyStructureUpdateTypeDef, # (1)
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateUserHierarchyStructureRequestRequestTypeDef = { # (1)
"HierarchyStructure": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy_structure(**kwargs)
update_user_identity_info
Updates the identity information for the specified user.
Type annotations and code completion for session.client("connect").update_user_identity_info method.
boto3 documentation
await def update_user_identity_info(
self,
*,
IdentityInfo: UserIdentityInfoTypeDef, # (1)
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateUserIdentityInfoRequestRequestTypeDef = { # (1)
"IdentityInfo": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_identity_info(**kwargs)
update_user_phone_config
Updates the phone configuration settings for the specified user.
Type annotations and code completion for session.client("connect").update_user_phone_config method.
boto3 documentation
await def update_user_phone_config(
self,
*,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateUserPhoneConfigRequestRequestTypeDef = { # (1)
"PhoneConfig": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_phone_config(**kwargs)
update_user_routing_profile
Assigns the specified routing profile to the specified user.
Type annotations and code completion for session.client("connect").update_user_routing_profile method.
boto3 documentation
await def update_user_routing_profile(
self,
*,
RoutingProfileId: str,
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserRoutingProfileRequestRequestTypeDef = { # (1)
"RoutingProfileId": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_routing_profile(**kwargs)
update_user_security_profiles
Assigns the specified security profiles to the specified user.
Type annotations and code completion for session.client("connect").update_user_security_profiles method.
boto3 documentation
await def update_user_security_profiles(
self,
*,
SecurityProfileIds: Sequence[str],
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateUserSecurityProfilesRequestRequestTypeDef = { # (1)
"SecurityProfileIds": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_security_profiles(**kwargs)
__aenter__
Type annotations and code completion for session.client("connect").__aenter__ method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("connect").__aexit__ method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("connect").get_paginator method with overloads.
client.get_paginator("get_metric_data")-> GetMetricDataPaginatorclient.get_paginator("list_agent_statuses")-> ListAgentStatusesPaginatorclient.get_paginator("list_approved_origins")-> ListApprovedOriginsPaginatorclient.get_paginator("list_bots")-> ListBotsPaginatorclient.get_paginator("list_contact_flow_modules")-> ListContactFlowModulesPaginatorclient.get_paginator("list_contact_flows")-> ListContactFlowsPaginatorclient.get_paginator("list_contact_references")-> ListContactReferencesPaginatorclient.get_paginator("list_default_vocabularies")-> ListDefaultVocabulariesPaginatorclient.get_paginator("list_hours_of_operations")-> ListHoursOfOperationsPaginatorclient.get_paginator("list_instance_attributes")-> ListInstanceAttributesPaginatorclient.get_paginator("list_instance_storage_configs")-> ListInstanceStorageConfigsPaginatorclient.get_paginator("list_instances")-> ListInstancesPaginatorclient.get_paginator("list_integration_associations")-> ListIntegrationAssociationsPaginatorclient.get_paginator("list_lambda_functions")-> ListLambdaFunctionsPaginatorclient.get_paginator("list_lex_bots")-> ListLexBotsPaginatorclient.get_paginator("list_phone_numbers")-> ListPhoneNumbersPaginatorclient.get_paginator("list_phone_numbers_v2")-> ListPhoneNumbersV2Paginatorclient.get_paginator("list_prompts")-> ListPromptsPaginatorclient.get_paginator("list_queue_quick_connects")-> ListQueueQuickConnectsPaginatorclient.get_paginator("list_queues")-> ListQueuesPaginatorclient.get_paginator("list_quick_connects")-> ListQuickConnectsPaginatorclient.get_paginator("list_routing_profile_queues")-> ListRoutingProfileQueuesPaginatorclient.get_paginator("list_routing_profiles")-> ListRoutingProfilesPaginatorclient.get_paginator("list_security_keys")-> ListSecurityKeysPaginatorclient.get_paginator("list_security_profile_permissions")-> ListSecurityProfilePermissionsPaginatorclient.get_paginator("list_security_profiles")-> ListSecurityProfilesPaginatorclient.get_paginator("list_task_templates")-> ListTaskTemplatesPaginatorclient.get_paginator("list_use_cases")-> ListUseCasesPaginatorclient.get_paginator("list_user_hierarchy_groups")-> ListUserHierarchyGroupsPaginatorclient.get_paginator("list_users")-> ListUsersPaginatorclient.get_paginator("search_available_phone_numbers")-> SearchAvailablePhoneNumbersPaginatorclient.get_paginator("search_security_profiles")-> SearchSecurityProfilesPaginatorclient.get_paginator("search_users")-> SearchUsersPaginatorclient.get_paginator("search_vocabularies")-> SearchVocabulariesPaginator