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

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.

Usage example
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.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.UserNotFoundException,
) as e:
    print(e)
Type checking example
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

Method definition
def associate_approved_origin(
    self,
    *,
    InstanceId: str,
    Origin: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def associate_default_vocabulary(
    self,
    *,
    InstanceId: str,
    LanguageCode: VocabularyLanguageCodeType,  # (1)
    VocabularyId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See VocabularyLanguageCodeType
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def associate_lambda_function(
    self,
    *,
    InstanceId: str,
    FunctionArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def associate_lex_bot(
    self,
    *,
    InstanceId: str,
    LexBot: LexBotTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LexBotTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def associate_phone_number_contact_flow(
    self,
    *,
    PhoneNumberId: str,
    InstanceId: str,
    ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def associate_queue_quick_connects(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def associate_routing_profile_queues(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See RoutingProfileQueueConfigTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def associate_security_key(
    self,
    *,
    InstanceId: str,
    Key: str,
) -> AssociateSecurityKeyResponseTypeDef:  # (1)
    ...
  1. See AssociateSecurityKeyResponseTypeDef
Usage example with kwargs
kwargs: AssociateSecurityKeyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Key": ...,
}

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

can_paginate

Check if an operation can be paginated.

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

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

claim_phone_number

Claims an available phone number to your Amazon Connect instance.

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

Method definition
def claim_phone_number(
    self,
    *,
    TargetArn: str,
    PhoneNumber: str,
    PhoneNumberDescription: str = ...,
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
) -> ClaimPhoneNumberResponseTypeDef:  # (1)
    ...
  1. See ClaimPhoneNumberResponseTypeDef
Usage example with kwargs
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

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

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
Usage example with kwargs
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

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
Usage example with kwargs
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. boto3 documentation

Method definition
def create_contact_flow_module(
    self,
    *,
    InstanceId: str,
    Name: str,
    Content: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    ClientToken: str = ...,
) -> CreateContactFlowModuleResponseTypeDef:  # (1)
    ...
  1. See CreateContactFlowModuleResponseTypeDef
Usage example with kwargs
kwargs: CreateContactFlowModuleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Content": ...,
}

parent.create_contact_flow_module(**kwargs)
  1. See CreateContactFlowModuleRequestRequestTypeDef

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

Method definition
def create_hours_of_operation(
    self,
    *,
    InstanceId: str,
    Name: str,
    TimeZone: str,
    Config: Sequence[HoursOfOperationConfigTypeDef],  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateHoursOfOperationResponseTypeDef:  # (2)
    ...
  1. See HoursOfOperationConfigTypeDef
  2. See CreateHoursOfOperationResponseTypeDef
Usage example with kwargs
kwargs: CreateHoursOfOperationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "TimeZone": ...,
    "Config": ...,
}

parent.create_hours_of_operation(**kwargs)
  1. See CreateHoursOfOperationRequestRequestTypeDef

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

Method definition
def create_instance(
    self,
    *,
    IdentityManagementType: DirectoryTypeType,  # (1)
    InboundCallsEnabled: bool,
    OutboundCallsEnabled: bool,
    ClientToken: str = ...,
    InstanceAlias: str = ...,
    DirectoryId: str = ...,
) -> CreateInstanceResponseTypeDef:  # (2)
    ...
  1. See DirectoryTypeType
  2. See CreateInstanceResponseTypeDef
Usage example with kwargs
kwargs: CreateInstanceRequestRequestTypeDef = {  # (1)
    "IdentityManagementType": ...,
    "InboundCallsEnabled": ...,
    "OutboundCallsEnabled": ...,
}

parent.create_instance(**kwargs)
  1. See CreateInstanceRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See IntegrationTypeType
  2. See SourceTypeType
  3. See CreateIntegrationAssociationResponseTypeDef
Usage example with kwargs
kwargs: CreateIntegrationAssociationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IntegrationType": ...,
    "IntegrationArn": ...,
}

parent.create_integration_association(**kwargs)
  1. See CreateIntegrationAssociationRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See OutboundCallerConfigTypeDef
  2. See CreateQueueResponseTypeDef
Usage example with kwargs
kwargs: CreateQueueRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "HoursOfOperationId": ...,
}

parent.create_queue(**kwargs)
  1. See CreateQueueRequestRequestTypeDef

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

Method definition
def create_quick_connect(
    self,
    *,
    InstanceId: str,
    Name: str,
    QuickConnectConfig: QuickConnectConfigTypeDef,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateQuickConnectResponseTypeDef:  # (2)
    ...
  1. See QuickConnectConfigTypeDef
  2. See CreateQuickConnectResponseTypeDef
Usage example with kwargs
kwargs: CreateQuickConnectRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "QuickConnectConfig": ...,
}

parent.create_quick_connect(**kwargs)
  1. See CreateQuickConnectRequestRequestTypeDef

create_routing_profile

Creates a new routing profile.

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

Method definition
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)
    ...
  1. See MediaConcurrencyTypeDef
  2. See RoutingProfileQueueConfigTypeDef
  3. See CreateRoutingProfileResponseTypeDef
Usage example with kwargs
kwargs: CreateRoutingProfileRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Description": ...,
    "DefaultOutboundQueueId": ...,
    "MediaConcurrencies": ...,
}

parent.create_routing_profile(**kwargs)
  1. See CreateRoutingProfileRequestRequestTypeDef

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

Method definition
def create_security_profile(
    self,
    *,
    SecurityProfileName: str,
    InstanceId: str,
    Description: str = ...,
    Permissions: Sequence[str] = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateSecurityProfileResponseTypeDef:  # (1)
    ...
  1. See CreateSecurityProfileResponseTypeDef
Usage example with kwargs
kwargs: CreateSecurityProfileRequestRequestTypeDef = {  # (1)
    "SecurityProfileName": ...,
    "InstanceId": ...,
}

parent.create_security_profile(**kwargs)
  1. See CreateSecurityProfileRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See TaskTemplateFieldTypeDef
  2. See TaskTemplateConstraintsTypeDef
  3. See TaskTemplateDefaultsTypeDef
  4. See TaskTemplateStatusType
  5. See CreateTaskTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateTaskTemplateRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Fields": ...,
}

parent.create_task_template(**kwargs)
  1. See CreateTaskTemplateRequestRequestTypeDef

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

Method definition
def create_use_case(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
    UseCaseType: UseCaseTypeType,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateUseCaseResponseTypeDef:  # (2)
    ...
  1. See UseCaseTypeType
  2. See CreateUseCaseResponseTypeDef
Usage example with kwargs
kwargs: CreateUseCaseRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IntegrationAssociationId": ...,
    "UseCaseType": ...,
}

parent.create_use_case(**kwargs)
  1. See CreateUseCaseRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See UserPhoneConfigTypeDef
  2. See UserIdentityInfoTypeDef
  3. See CreateUserResponseTypeDef
Usage example with kwargs
kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "Username": ...,
    "PhoneConfig": ...,
    "SecurityProfileIds": ...,
    "RoutingProfileId": ...,
    "InstanceId": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

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

Method definition
def create_user_hierarchy_group(
    self,
    *,
    Name: str,
    InstanceId: str,
    ParentGroupId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateUserHierarchyGroupResponseTypeDef:  # (1)
    ...
  1. See CreateUserHierarchyGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateUserHierarchyGroupRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceId": ...,
}

parent.create_user_hierarchy_group(**kwargs)
  1. See CreateUserHierarchyGroupRequestRequestTypeDef

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

Method definition
def create_vocabulary(
    self,
    *,
    InstanceId: str,
    VocabularyName: str,
    LanguageCode: VocabularyLanguageCodeType,  # (1)
    Content: str,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateVocabularyResponseTypeDef:  # (2)
    ...
  1. See VocabularyLanguageCodeType
  2. See CreateVocabularyResponseTypeDef
Usage example with kwargs
kwargs: CreateVocabularyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "VocabularyName": ...,
    "LanguageCode": ...,
    "Content": ...,
}

parent.create_vocabulary(**kwargs)
  1. See CreateVocabularyRequestRequestTypeDef

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

Method definition
def delete_contact_flow(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteContactFlowRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowId": ...,
}

parent.delete_contact_flow(**kwargs)
  1. See DeleteContactFlowRequestRequestTypeDef

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

Method definition
def delete_contact_flow_module(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteContactFlowModuleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowModuleId": ...,
}

parent.delete_contact_flow_module(**kwargs)
  1. See DeleteContactFlowModuleRequestRequestTypeDef

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

Method definition
def delete_hours_of_operation(
    self,
    *,
    InstanceId: str,
    HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteHoursOfOperationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "HoursOfOperationId": ...,
}

parent.delete_hours_of_operation(**kwargs)
  1. See DeleteHoursOfOperationRequestRequestTypeDef

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

Method definition
def delete_instance(
    self,
    *,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.delete_instance(**kwargs)
  1. See DeleteInstanceRequestRequestTypeDef

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

Method definition
def delete_integration_association(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIntegrationAssociationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IntegrationAssociationId": ...,
}

parent.delete_integration_association(**kwargs)
  1. See DeleteIntegrationAssociationRequestRequestTypeDef

delete_quick_connect

Deletes a quick connect.

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

Method definition
def delete_quick_connect(
    self,
    *,
    InstanceId: str,
    QuickConnectId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteQuickConnectRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QuickConnectId": ...,
}

parent.delete_quick_connect(**kwargs)
  1. See DeleteQuickConnectRequestRequestTypeDef

delete_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").delete_security_profile method. boto3 documentation

Method definition
def delete_security_profile(
    self,
    *,
    InstanceId: str,
    SecurityProfileId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteSecurityProfileRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "SecurityProfileId": ...,
}

parent.delete_security_profile(**kwargs)
  1. See DeleteSecurityProfileRequestRequestTypeDef

delete_task_template

Deletes the task template.

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

Method definition
def delete_task_template(
    self,
    *,
    InstanceId: str,
    TaskTemplateId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteTaskTemplateRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "TaskTemplateId": ...,
}

parent.delete_task_template(**kwargs)
  1. See DeleteTaskTemplateRequestRequestTypeDef

delete_use_case

Deletes a use case from an integration association.

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

Method definition
def delete_use_case(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
    UseCaseId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUseCaseRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IntegrationAssociationId": ...,
    "UseCaseId": ...,
}

parent.delete_use_case(**kwargs)
  1. See DeleteUseCaseRequestRequestTypeDef

delete_user

Deletes a user account from the specified Amazon Connect instance.

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

Method definition
def delete_user(
    self,
    *,
    InstanceId: str,
    UserId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "UserId": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

delete_user_hierarchy_group

Deletes an existing user hierarchy group.

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

Method definition
def delete_user_hierarchy_group(
    self,
    *,
    HierarchyGroupId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUserHierarchyGroupRequestRequestTypeDef = {  # (1)
    "HierarchyGroupId": ...,
    "InstanceId": ...,
}

parent.delete_user_hierarchy_group(**kwargs)
  1. See DeleteUserHierarchyGroupRequestRequestTypeDef

delete_vocabulary

Deletes the vocabulary that has the given identifier.

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

Method definition
def delete_vocabulary(
    self,
    *,
    InstanceId: str,
    VocabularyId: str,
) -> DeleteVocabularyResponseTypeDef:  # (1)
    ...
  1. See DeleteVocabularyResponseTypeDef
Usage example with kwargs
kwargs: DeleteVocabularyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "VocabularyId": ...,
}

parent.delete_vocabulary(**kwargs)
  1. See DeleteVocabularyRequestRequestTypeDef

describe_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").describe_agent_status method. boto3 documentation

Method definition
def describe_agent_status(
    self,
    *,
    InstanceId: str,
    AgentStatusId: str,
) -> DescribeAgentStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAgentStatusResponseTypeDef
Usage example with kwargs
kwargs: DescribeAgentStatusRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "AgentStatusId": ...,
}

parent.describe_agent_status(**kwargs)
  1. See DescribeAgentStatusRequestRequestTypeDef

describe_contact

This API is in preview release for Amazon Connect and is subject to change.

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

Method definition
def describe_contact(
    self,
    *,
    InstanceId: str,
    ContactId: str,
) -> DescribeContactResponseTypeDef:  # (1)
    ...
  1. See DescribeContactResponseTypeDef
Usage example with kwargs
kwargs: DescribeContactRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
}

parent.describe_contact(**kwargs)
  1. See DescribeContactRequestRequestTypeDef

describe_contact_flow

Describes the specified flow.

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

Method definition
def describe_contact_flow(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
) -> DescribeContactFlowResponseTypeDef:  # (1)
    ...
  1. See DescribeContactFlowResponseTypeDef
Usage example with kwargs
kwargs: DescribeContactFlowRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowId": ...,
}

parent.describe_contact_flow(**kwargs)
  1. See DescribeContactFlowRequestRequestTypeDef

describe_contact_flow_module

Describes the specified flow module.

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

Method definition
def describe_contact_flow_module(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
) -> DescribeContactFlowModuleResponseTypeDef:  # (1)
    ...
  1. See DescribeContactFlowModuleResponseTypeDef
Usage example with kwargs
kwargs: DescribeContactFlowModuleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowModuleId": ...,
}

parent.describe_contact_flow_module(**kwargs)
  1. See DescribeContactFlowModuleRequestRequestTypeDef

describe_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").describe_hours_of_operation method. boto3 documentation

Method definition
def describe_hours_of_operation(
    self,
    *,
    InstanceId: str,
    HoursOfOperationId: str,
) -> DescribeHoursOfOperationResponseTypeDef:  # (1)
    ...
  1. See DescribeHoursOfOperationResponseTypeDef
Usage example with kwargs
kwargs: DescribeHoursOfOperationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "HoursOfOperationId": ...,
}

parent.describe_hours_of_operation(**kwargs)
  1. See DescribeHoursOfOperationRequestRequestTypeDef

describe_instance

This API is in preview release for Amazon Connect and is subject to change.

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

Method definition
def describe_instance(
    self,
    *,
    InstanceId: str,
) -> DescribeInstanceResponseTypeDef:  # (1)
    ...
  1. See DescribeInstanceResponseTypeDef
Usage example with kwargs
kwargs: DescribeInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_instance(**kwargs)
  1. See DescribeInstanceRequestRequestTypeDef

describe_instance_attribute

This API is in preview release for Amazon Connect and is subject to change.

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