ConnectClient
Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.
ConnectClient
Type annotations and code completion for boto3.client("connect")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_connect.client import ConnectClient
def get_connect_client() -> ConnectClient:
return Session().client("connect")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("connect").exceptions
structure.
client = boto3.client("connect")
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.ResourceNotReadyException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.UserNotFoundException,
) as e:
print(e)
from mypy_boto3_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 boto3.client("connect").associate_approved_origin
method.
boto3 documentation
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 boto3.client("connect").associate_bot
method.
boto3 documentation
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 boto3.client("connect").associate_default_vocabulary
method.
boto3 documentation
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 boto3.client("connect").associate_instance_storage_config
method.
boto3 documentation
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 boto3.client("connect").associate_lambda_function
method.
boto3 documentation
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 boto3.client("connect").associate_lex_bot
method.
boto3 documentation
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 boto3.client("connect").associate_phone_number_contact_flow
method.
boto3 documentation
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 boto3.client("connect").associate_queue_quick_connects
method.
boto3 documentation
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 boto3.client("connect").associate_routing_profile_queues
method.
boto3 documentation
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 boto3.client("connect").associate_security_key
method.
boto3 documentation
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 boto3.client("connect").can_paginate
method.
boto3 documentation
claim_phone_number
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
Type annotations and code completion for boto3.client("connect").claim_phone_number
method.
boto3 documentation
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 boto3.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 boto3.client("connect").create_agent_status
method.
boto3 documentation
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 boto3.client("connect").create_contact_flow
method.
boto3 documentation
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 boto3.client("connect").create_contact_flow_module
method.
boto3 documentation
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 boto3.client("connect").create_hours_of_operation
method.
boto3 documentation
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 boto3.client("connect").create_instance
method.
boto3 documentation
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 boto3.client("connect").create_integration_association
method.
boto3 documentation
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 boto3.client("connect").create_queue
method.
boto3 documentation
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 boto3.client("connect").create_quick_connect
method.
boto3 documentation
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 boto3.client("connect").create_routing_profile
method.
boto3 documentation
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_rule
Creates a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_rule
method.
boto3 documentation
def create_rule(
self,
*,
InstanceId: str,
Name: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: Sequence[RuleActionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
ClientToken: str = ...,
) -> CreateRuleResponseTypeDef: # (4)
...
- See RuleTriggerEventSourceTypeDef
- See RuleActionTypeDef
- See RulePublishStatusType
- See CreateRuleResponseTypeDef
kwargs: CreateRuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"TriggerEventSource": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
}
parent.create_rule(**kwargs)
create_security_profile
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").create_security_profile
method.
boto3 documentation
def create_security_profile(
self,
*,
SecurityProfileName: str,
InstanceId: str,
Description: str = ...,
Permissions: Sequence[str] = ...,
Tags: Mapping[str, str] = ...,
AllowedAccessControlTags: Mapping[str, str] = ...,
TagRestrictedResources: Sequence[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 boto3.client("connect").create_task_template
method.
boto3 documentation
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_traffic_distribution_group
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
Type annotations and code completion for boto3.client("connect").create_traffic_distribution_group
method.
boto3 documentation
def create_traffic_distribution_group(
self,
*,
Name: str,
InstanceId: str,
Description: str = ...,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateTrafficDistributionGroupResponseTypeDef: # (1)
...
kwargs: CreateTrafficDistributionGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceId": ...,
}
parent.create_traffic_distribution_group(**kwargs)
create_use_case
Creates a use case for an integration association.
Type annotations and code completion for boto3.client("connect").create_use_case
method.
boto3 documentation
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 boto3.client("connect").create_user
method.
boto3 documentation
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 boto3.client("connect").create_user_hierarchy_group
method.
boto3 documentation
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 boto3.client("connect").create_vocabulary
method.
boto3 documentation
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 boto3.client("connect").delete_contact_flow
method.
boto3 documentation
def delete_contact_flow(
self,
*,
InstanceId: str,
ContactFlowId: str,
) -> Dict[str, Any]:
...
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 boto3.client("connect").delete_contact_flow_module
method.
boto3 documentation
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 boto3.client("connect").delete_hours_of_operation
method.
boto3 documentation
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 boto3.client("connect").delete_instance
method.
boto3 documentation
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 boto3.client("connect").delete_integration_association
method.
boto3 documentation
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 boto3.client("connect").delete_quick_connect
method.
boto3 documentation
def delete_quick_connect(
self,
*,
InstanceId: str,
QuickConnectId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.delete_quick_connect(**kwargs)
delete_rule
Deletes a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_rule
method.
boto3 documentation