Skip to content

ConnectClient#

Index > Connect > 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

# ConnectClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("connect")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ContactFlowNotPublishedException,
    client.exceptions.ContactNotFoundException,
    client.exceptions.DestinationNotAllowedException,
    client.exceptions.DuplicateResourceException,
    client.exceptions.IdempotencyException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidContactFlowException,
    client.exceptions.InvalidContactFlowModuleException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.MaximumResultReturnedException,
    client.exceptions.OutboundContactNotPermittedException,
    client.exceptions.PropertyValidationException,
    client.exceptions.ResourceConflictException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceNotReadyException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UserNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_connect.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

activate_evaluation_form#

Activates an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for boto3.client("connect").activate_evaluation_form method. boto3 documentation

# activate_evaluation_form method definition

def activate_evaluation_form(
    self,
    *,
    InstanceId: str,
    EvaluationFormId: str,
    EvaluationFormVersion: int,
) -> ActivateEvaluationFormResponseTypeDef:  # (1)
    ...
  1. See ActivateEvaluationFormResponseTypeDef 
# activate_evaluation_form method usage example with argument unpacking

kwargs: ActivateEvaluationFormRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "EvaluationFormId": ...,
    "EvaluationFormVersion": ...,
}

parent.activate_evaluation_form(**kwargs)
  1. See ActivateEvaluationFormRequestRequestTypeDef

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

# associate_approved_origin method definition

def associate_approved_origin(
    self,
    *,
    InstanceId: str,
    Origin: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_approved_origin method usage example with argument unpacking

kwargs: AssociateApprovedOriginRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Origin": ...,
}

parent.associate_approved_origin(**kwargs)
  1. See AssociateApprovedOriginRequestRequestTypeDef

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

# associate_bot method definition

def associate_bot(
    self,
    *,
    InstanceId: str,
    LexBot: LexBotTypeDef = ...,  # (1)
    LexV2Bot: LexV2BotTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See LexBotTypeDef
  2. See LexV2BotTypeDef
  3. See EmptyResponseMetadataTypeDef 
# associate_bot method usage example with argument unpacking

kwargs: AssociateBotRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.associate_bot(**kwargs)
  1. See AssociateBotRequestRequestTypeDef

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

# associate_default_vocabulary method definition

def associate_default_vocabulary(
    self,
    *,
    InstanceId: str,
    LanguageCode: VocabularyLanguageCodeType,  # (1)
    VocabularyId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See VocabularyLanguageCodeType 
# associate_default_vocabulary method usage example with argument unpacking

kwargs: AssociateDefaultVocabularyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "LanguageCode": ...,
}

parent.associate_default_vocabulary(**kwargs)
  1. See AssociateDefaultVocabularyRequestRequestTypeDef

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

# associate_instance_storage_config method definition

def associate_instance_storage_config(
    self,
    *,
    InstanceId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
    StorageConfig: InstanceStorageConfigTypeDef,  # (2)
) -> AssociateInstanceStorageConfigResponseTypeDef:  # (3)
    ...
  1. See InstanceStorageResourceTypeType
  2. See InstanceStorageConfigTypeDef
  3. See AssociateInstanceStorageConfigResponseTypeDef 
# associate_instance_storage_config method usage example with argument unpacking

kwargs: AssociateInstanceStorageConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ResourceType": ...,
    "StorageConfig": ...,
}

parent.associate_instance_storage_config(**kwargs)
  1. See AssociateInstanceStorageConfigRequestRequestTypeDef

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

# associate_lambda_function method definition

def associate_lambda_function(
    self,
    *,
    InstanceId: str,
    FunctionArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_lambda_function method usage example with argument unpacking

kwargs: AssociateLambdaFunctionRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "FunctionArn": ...,
}

parent.associate_lambda_function(**kwargs)
  1. See AssociateLambdaFunctionRequestRequestTypeDef

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

# associate_lex_bot method definition

def associate_lex_bot(
    self,
    *,
    InstanceId: str,
    LexBot: LexBotTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LexBotTypeDef
  2. See EmptyResponseMetadataTypeDef 
# associate_lex_bot method usage example with argument unpacking

kwargs: AssociateLexBotRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "LexBot": ...,
}

parent.associate_lex_bot(**kwargs)
  1. See AssociateLexBotRequestRequestTypeDef

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

# associate_phone_number_contact_flow method definition

def associate_phone_number_contact_flow(
    self,
    *,
    PhoneNumberId: str,
    InstanceId: str,
    ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_phone_number_contact_flow method usage example with argument unpacking

kwargs: AssociatePhoneNumberContactFlowRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
    "InstanceId": ...,
    "ContactFlowId": ...,
}

parent.associate_phone_number_contact_flow(**kwargs)
  1. See AssociatePhoneNumberContactFlowRequestRequestTypeDef

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

# associate_queue_quick_connects method definition

def associate_queue_quick_connects(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_queue_quick_connects method usage example with argument unpacking

kwargs: AssociateQueueQuickConnectsRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QueueId": ...,
    "QuickConnectIds": ...,
}

parent.associate_queue_quick_connects(**kwargs)
  1. See AssociateQueueQuickConnectsRequestRequestTypeDef

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

# associate_routing_profile_queues method definition

def associate_routing_profile_queues(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See RoutingProfileQueueConfigTypeDef
  2. See EmptyResponseMetadataTypeDef 
# associate_routing_profile_queues method usage example with argument unpacking

kwargs: AssociateRoutingProfileQueuesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "RoutingProfileId": ...,
    "QueueConfigs": ...,
}

parent.associate_routing_profile_queues(**kwargs)
  1. See AssociateRoutingProfileQueuesRequestRequestTypeDef

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

# associate_security_key method definition

def associate_security_key(
    self,
    *,
    InstanceId: str,
    Key: str,
) -> AssociateSecurityKeyResponseTypeDef:  # (1)
    ...
  1. See AssociateSecurityKeyResponseTypeDef 
# associate_security_key method usage example with argument unpacking

kwargs: AssociateSecurityKeyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Key": ...,
}

parent.associate_security_key(**kwargs)
  1. See AssociateSecurityKeyRequestRequestTypeDef

associate_traffic_distribution_group_user#

Associates an agent with a traffic distribution group.

Type annotations and code completion for boto3.client("connect").associate_traffic_distribution_group_user method. boto3 documentation

# associate_traffic_distribution_group_user method definition

def associate_traffic_distribution_group_user(
    self,
    *,
    TrafficDistributionGroupId: str,
    UserId: str,
    InstanceId: str,
) -> Dict[str, Any]:
    ...
# associate_traffic_distribution_group_user method usage example with argument unpacking

kwargs: AssociateTrafficDistributionGroupUserRequestRequestTypeDef = {  # (1)
    "TrafficDistributionGroupId": ...,
    "UserId": ...,
    "InstanceId": ...,
}

parent.associate_traffic_distribution_group_user(**kwargs)
  1. See AssociateTrafficDistributionGroupUserRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("connect").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

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

# claim_phone_number method definition

def claim_phone_number(
    self,
    *,
    TargetArn: str,
    PhoneNumber: str,
    PhoneNumberDescription: str = ...,
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
) -> ClaimPhoneNumberResponseTypeDef:  # (1)
    ...
  1. See ClaimPhoneNumberResponseTypeDef 
# claim_phone_number method usage example with argument unpacking

kwargs: ClaimPhoneNumberRequestRequestTypeDef = {  # (1)
    "TargetArn": ...,
    "PhoneNumber": ...,
}

parent.claim_phone_number(**kwargs)
  1. See ClaimPhoneNumberRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("connect").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

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

# create_agent_status method definition

def create_agent_status(
    self,
    *,
    InstanceId: str,
    Name: str,
    State: AgentStatusStateType,  # (1)
    Description: str = ...,
    DisplayOrder: int = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateAgentStatusResponseTypeDef:  # (2)
    ...
  1. See AgentStatusStateType
  2. See CreateAgentStatusResponseTypeDef 
# create_agent_status method usage example with argument unpacking

kwargs: CreateAgentStatusRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "State": ...,
}

parent.create_agent_status(**kwargs)
  1. See CreateAgentStatusRequestRequestTypeDef

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

# create_contact_flow method definition

def create_contact_flow(
    self,
    *,
    InstanceId: str,
    Name: str,
    Type: ContactFlowTypeType,  # (1)
    Content: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateContactFlowResponseTypeDef:  # (2)
    ...
  1. See ContactFlowTypeType
  2. See CreateContactFlowResponseTypeDef 
# create_contact_flow method usage example with argument unpacking

kwargs: CreateContactFlowRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Type": ...,
    "Content": ...,
}

parent.create_contact_flow(**kwargs)
  1. See CreateContactFlowRequestRequestTypeDef

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.