Skip to content

ConnectClient#

Index > Connect > ConnectClient

Auto-generated documentation for Connect type annotations stubs module types-aiobotocore-connect.

ConnectClient#

Type annotations and code completion for session.create_client("connect") boto3 documentation

ConnectClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_connect.client import ConnectClient

session = get_session()
async with session.create_client("connect") as client:
    client: ConnectClient

Exceptions#

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("connect").exceptions structure.

ConnectClient.exceptions usage example

async with session.create_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.MaximumResultReturnedException,
        client.OutboundContactNotPermittedException,
        client.PropertyValidationException,
        client.ResourceConflictException,
        client.ResourceInUseException,
        client.ResourceNotFoundException,
        client.ResourceNotReadyException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.UserNotFoundException,
    ) as e:
        print(e)
ConnectClient usage type checking example

from types_aiobotocore_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 session.create_client("connect").activate_evaluation_form method. boto3 documentation

# activate_evaluation_form method definition

await 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 session.create_client("connect").associate_approved_origin method. boto3 documentation

# associate_approved_origin method definition

await 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 session.create_client("connect").associate_bot method. boto3 documentation

# associate_bot method definition

await 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 session.create_client("connect").associate_default_vocabulary method. boto3 documentation

# associate_default_vocabulary method definition

await 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 session.create_client("connect").associate_instance_storage_config method. boto3 documentation

# associate_instance_storage_config method definition

await 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 session.create_client("connect").associate_lambda_function method. boto3 documentation

# associate_lambda_function method definition

await 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 session.create_client("connect").associate_lex_bot method. boto3 documentation

# associate_lex_bot method definition

await 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 session.create_client("connect").associate_phone_number_contact_flow method. boto3 documentation

# associate_phone_number_contact_flow method definition

await 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 session.create_client("connect").associate_queue_quick_connects method. boto3 documentation

# associate_queue_quick_connects method definition

await 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 session.create_client("connect").associate_routing_profile_queues method. boto3 documentation

# associate_routing_profile_queues method definition

await 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 session.create_client("connect").associate_security_key method. boto3 documentation

# associate_security_key method definition

await 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 session.create_client("connect").associate_traffic_distribution_group_user method. boto3 documentation

# associate_traffic_distribution_group_user method definition

await 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 session.create_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 session.create_client("connect").claim_phone_number method. boto3 documentation

# claim_phone_number method definition

await 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 session.create_client("connect").close method. boto3 documentation

# close method definition

await 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 session.create_client("connect").create_agent_status method. boto3 documentation

# create_agent_status method definition

await 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 session.create_client("connect").create_contact_flow method. boto3 documentation

# create_contact_flow method definition

await 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 session.create_client("connect").create_contact_flow_module method. boto3 documentation

# create_contact_flow_module method definition

await 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
# create_contact_flow_module method usage example with argument unpacking

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

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

create_evaluation_form#

Creates an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").create_evaluation_form method. boto3 documentation

# create_evaluation_form method definition

await def create_evaluation_form(
    self,
    *,
    InstanceId: str,
    Title: str,
    Items: Sequence[EvaluationFormItemTypeDef],  # (1)
    Description: str = ...,
    ScoringStrategy: EvaluationFormScoringStrategyTypeDef = ...,  # (2)
    ClientToken: str = ...,
) -> CreateEvaluationFormResponseTypeDef:  # (3)
    ...
  1. See EvaluationFormItemTypeDef
  2. See EvaluationFormScoringStrategyTypeDef
  3. See CreateEvaluationFormResponseTypeDef
# create_evaluation_form method usage example with argument unpacking

kwargs: CreateEvaluationFormRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Title": ...,
    "Items": ...,
}

parent.create_evaluation_form(**kwargs)
  1. See CreateEvaluationFormRequestRequestTypeDef

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.create_client("connect").create_hours_of_operation method. boto3 documentation

# create_hours_of_operation method definition

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)
    ...
  1. See HoursOfOperationConfigTypeDef
  2. See CreateHoursOfOperationResponseTypeDef
# create_hours_of_operation method usage example with argument unpacking

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 session.create_client("connect").create_instance method. boto3 documentation

# create_instance method definition

await 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
# create_instance method usage example with argument unpacking

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 session.create_client("connect").create_integration_association method. boto3 documentation

# create_integration_association method definition

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)
    ...
  1. See IntegrationTypeType
  2. See SourceTypeType
  3. See CreateIntegrationAssociationResponseTypeDef
# create_integration_association method usage example with argument unpacking

kwargs: CreateIntegrationAssociationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IntegrationType": ...,
    "IntegrationArn": ...,
}

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

create_participant#

Adds a new participant into an on-going chat contact.

Type annotations and code completion for session.create_client("connect").create_participant method. boto3 documentation

# create_participant method definition

await def create_participant(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ParticipantDetails: ParticipantDetailsToAddTypeDef,  # (1)
    ClientToken: str = ...,
) -> CreateParticipantResponseTypeDef:  # (2)
    ...
  1. See ParticipantDetailsToAddTypeDef
  2. See CreateParticipantResponseTypeDef
# create_participant method usage example with argument unpacking

kwargs: CreateParticipantRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ParticipantDetails": ...,
}

parent.create_participant(**kwargs)
  1. See CreateParticipantRequestRequestTypeDef

create_prompt#

Creates a prompt.

Type annotations and code completion for session.create_client("connect").create_prompt method. boto3 documentation

# create_prompt method definition

await def create_prompt(
    self,
    *,
    InstanceId: str,
    Name: str,
    S3Uri: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreatePromptResponseTypeDef:  # (1)
    ...
  1. See CreatePromptResponseTypeDef
# create_prompt method usage example with argument unpacking

kwargs: CreatePromptRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "S3Uri": ...,
}

parent.create_prompt(**kwargs)
  1. See CreatePromptRequestRequestTypeDef

create_queue#

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

Type annotations and code completion for session.create_client("connect").create_queue method. boto3 documentation

# create_queue method definition

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)
    ...
  1. See OutboundCallerConfigTypeDef
  2. See CreateQueueResponseTypeDef
# create_queue method usage example with argument unpacking

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 session.create_client("connect").create_quick_connect method. boto3 documentation

# create_quick_connect method definition

await 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
# create_quick_connect method usage example with argument unpacking

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 session.create_client("connect").create_routing_profile method. boto3 documentation

# create_routing_profile method definition

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] = ...,
    AgentAvailabilityTimer: AgentAvailabilityTimerType = ...,  # (3)
) -> CreateRoutingProfileResponseTypeDef:  # (4)
    ...
  1. See MediaConcurrencyTypeDef
  2. See RoutingProfileQueueConfigTypeDef
  3. See AgentAvailabilityTimerType
  4. See CreateRoutingProfileResponseTypeDef
# create_routing_profile method usage example with argument unpacking

kwargs: CreateRoutingProfileRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Description": ...,
    "DefaultOutboundQueueId": ...,
    "MediaConcurrencies": ...,
}

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

create_rule#

Creates a rule for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").create_rule method. boto3 documentation

# create_rule method definition

await def create_rule(
    self,
    *,
    InstanceId: str,
    Name: str,
    TriggerEventSource: RuleTriggerEventSourceTypeDef,  # (1)
    Function: str,
    Actions: Sequence[RuleActionTypeDef],  # (2)
    PublishStatus: RulePublishStatusType,  # (3)
    ClientToken: str = ...,
) -> CreateRuleResponseTypeDef:  # (4)
    ...
  1. See RuleTriggerEventSourceTypeDef
  2. See RuleActionTypeDef
  3. See RulePublishStatusType
  4. See CreateRuleResponseTypeDef
# create_rule method usage example with argument unpacking

kwargs: CreateRuleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "TriggerEventSource": ...,
    "Function": ...,
    "Actions": ...,
    "PublishStatus": ...,
}

parent.create_rule(**kwargs)
  1. See CreateRuleRequestRequestTypeDef

create_security_profile#

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

Type annotations and code completion for session.create_client("connect").create_security_profile method. boto3 documentation

# create_security_profile method definition

await 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)
    ...
  1. See CreateSecurityProfileResponseTypeDef
# create_security_profile method usage example with argument unpacking

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 session.create_client("connect").create_task_template method. boto3 documentation

# create_task_template method definition

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)
    ...
  1. See TaskTemplateFieldTypeDef
  2. See TaskTemplateConstraintsTypeDef
  3. See TaskTemplateDefaultsTypeDef
  4. See TaskTemplateStatusType
  5. See CreateTaskTemplateResponseTypeDef
# create_task_template method usage example with argument unpacking

kwargs: CreateTaskTemplateRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Name": ...,
    "Fields": ...,
}

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

create_traffic_distribution_group#

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

Type annotations and code completion for session.create_client("connect").create_traffic_distribution_group method. boto3 documentation

# create_traffic_distribution_group method definition

await def create_traffic_distribution_group(
    self,
    *,
    Name: str,
    InstanceId: str,
    Description: str = ...,
    ClientToken: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateTrafficDistributionGroupResponseTypeDef:  # (1)
    ...
  1. See CreateTrafficDistributionGroupResponseTypeDef
# create_traffic_distribution_group method usage example with argument unpacking

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

parent.create_traffic_distribution_group(**kwargs)
  1. See CreateTrafficDistributionGroupRequestRequestTypeDef

create_use_case#

Creates a use case for an integration association.

Type annotations and code completion for session.create_client("connect").create_use_case method. boto3 documentation

# create_use_case method definition

await def create_use_case(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
    UseCaseType: UseCaseTypeType,  # (1)
    Tags: Mapping[str, str] = ...,
) -> CreateUseCaseResponseTypeDef:  # (2)
    ...
  1. See UseCaseTypeType
  2. See CreateUseCaseResponseTypeDef
# create_use_case method usage example with argument unpacking

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 session.create_client("connect").create_user method. boto3 documentation

# create_user method definition

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)
    ...
  1. See UserPhoneConfigTypeDef
  2. See UserIdentityInfoTypeDef
  3. See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking

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 session.create_client("connect").create_user_hierarchy_group method. boto3 documentation

# create_user_hierarchy_group method definition

await def create_user_hierarchy_group(
    self,
    *,
    Name: str,
    InstanceId: str,
    ParentGroupId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateUserHierarchyGroupResponseTypeDef:  # (1)
    ...
  1. See CreateUserHierarchyGroupResponseTypeDef
# create_user_hierarchy_group method usage example with argument unpacking

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 session.create_client("connect").create_vocabulary method. boto3 documentation

# create_vocabulary method definition

await 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
# create_vocabulary method usage example with argument unpacking

kwargs: CreateVocabularyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "VocabularyName": ...,
    "LanguageCode": ...,
    "Content": ...,
}

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

deactivate_evaluation_form#

Deactivates an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").deactivate_evaluation_form method. boto3 documentation

# deactivate_evaluation_form method definition

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

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

parent.deactivate_evaluation_form(**kwargs)
  1. See DeactivateEvaluationFormRequestRequestTypeDef

delete_contact_evaluation#

Deletes a contact evaluation in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").delete_contact_evaluation method. boto3 documentation

# delete_contact_evaluation method definition

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

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

parent.delete_contact_evaluation(**kwargs)
  1. See DeleteContactEvaluationRequestRequestTypeDef

delete_contact_flow#

Deletes a flow for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").delete_contact_flow method. boto3 documentation

# delete_contact_flow method definition

await def delete_contact_flow(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
) -> Dict[str, Any]:
    ...
# delete_contact_flow method usage example with argument unpacking

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 session.create_client("connect").delete_contact_flow_module method. boto3 documentation

# delete_contact_flow_module method definition

await def delete_contact_flow_module(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
) -> Dict[str, Any]:
    ...
# delete_contact_flow_module method usage example with argument unpacking

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

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

delete_evaluation_form#

Deletes an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").delete_evaluation_form method. boto3 documentation

# delete_evaluation_form method definition

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

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

parent.delete_evaluation_form(**kwargs)
  1. See DeleteEvaluationFormRequestRequestTypeDef

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.create_client("connect").delete_hours_of_operation method. boto3 documentation

# delete_hours_of_operation method definition

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

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 session.create_client("connect").delete_instance method. boto3 documentation

# delete_instance method definition

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

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 session.create_client("connect").delete_integration_association method. boto3 documentation

# delete_integration_association method definition

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

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

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

delete_prompt#

Deletes a prompt.

Type annotations and code completion for session.create_client("connect").delete_prompt method. boto3 documentation

# delete_prompt method definition

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

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

parent.delete_prompt(**kwargs)
  1. See DeletePromptRequestRequestTypeDef

delete_queue#

Deletes a queue.

Type annotations and code completion for session.create_client("connect").delete_queue method. boto3 documentation

# delete_queue method definition

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

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

parent.delete_queue(**kwargs)
  1. See DeleteQueueRequestRequestTypeDef

delete_quick_connect#

Deletes a quick connect.

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

# delete_quick_connect method definition

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

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

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

delete_routing_profile#

Deletes a routing profile.

Type annotations and code completion for session.create_client("connect").delete_routing_profile method. boto3 documentation

# delete_routing_profile method definition

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

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

parent.delete_routing_profile(**kwargs)
  1. See DeleteRoutingProfileRequestRequestTypeDef

delete_rule#

Deletes a rule for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").delete_rule method. boto3 documentation

# delete_rule method definition

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

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

parent.delete_rule(**kwargs)
  1. See DeleteRuleRequestRequestTypeDef

delete_security_profile#

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

Type annotations and code completion for session.create_client("connect").delete_security_profile method. boto3 documentation

# delete_security_profile method definition

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

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 session.create_client("connect").delete_task_template method. boto3 documentation

# delete_task_template method definition

await def delete_task_template(
    self,
    *,
    InstanceId: str,
    TaskTemplateId: str,
) -> Dict[str, Any]:
    ...
# delete_task_template method usage example with argument unpacking

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

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

delete_traffic_distribution_group#

Deletes a traffic distribution group.

Type annotations and code completion for session.create_client("connect").delete_traffic_distribution_group method. boto3 documentation

# delete_traffic_distribution_group method definition

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

kwargs: DeleteTrafficDistributionGroupRequestRequestTypeDef = {  # (1)
    "TrafficDistributionGroupId": ...,
}

parent.delete_traffic_distribution_group(**kwargs)
  1. See DeleteTrafficDistributionGroupRequestRequestTypeDef

delete_use_case#

Deletes a use case from an integration association.

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

# delete_use_case method definition

await def delete_use_case(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
    UseCaseId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_use_case method usage example with argument unpacking

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 session.create_client("connect").delete_user method. boto3 documentation

# delete_user method definition

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

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 session.create_client("connect").delete_user_hierarchy_group method. boto3 documentation

# delete_user_hierarchy_group method definition

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

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 session.create_client("connect").delete_vocabulary method. boto3 documentation

# delete_vocabulary method definition

await def delete_vocabulary(
    self,
    *,
    InstanceId: str,
    VocabularyId: str,
) -> DeleteVocabularyResponseTypeDef:  # (1)
    ...
  1. See DeleteVocabularyResponseTypeDef
# delete_vocabulary method usage example with argument unpacking

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 session.create_client("connect").describe_agent_status method. boto3 documentation

# describe_agent_status method definition

await def describe_agent_status(
    self,
    *,
    InstanceId: str,
    AgentStatusId: str,
) -> DescribeAgentStatusResponseTypeDef:  # (1)
    ...
  1. See DescribeAgentStatusResponseTypeDef
# describe_agent_status method usage example with argument unpacking

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 session.create_client("connect").describe_contact method. boto3 documentation

# describe_contact method definition

await def describe_contact(
    self,
    *,
    InstanceId: str,
    ContactId: str,
) -> DescribeContactResponseTypeDef:  # (1)
    ...
  1. See DescribeContactResponseTypeDef
# describe_contact method usage example with argument unpacking

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

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

describe_contact_evaluation#

Describes a contact evaluation in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").describe_contact_evaluation method. boto3 documentation

# describe_contact_evaluation method definition

await def describe_contact_evaluation(
    self,
    *,
    InstanceId: str,
    EvaluationId: str,
) -> DescribeContactEvaluationResponseTypeDef:  # (1)
    ...
  1. See DescribeContactEvaluationResponseTypeDef
# describe_contact_evaluation method usage example with argument unpacking

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

parent.describe_contact_evaluation(**kwargs)
  1. See DescribeContactEvaluationRequestRequestTypeDef

describe_contact_flow#

Describes the specified flow.

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

# describe_contact_flow method definition

await def describe_contact_flow(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
) -> DescribeContactFlowResponseTypeDef:  # (1)
    ...
  1. See DescribeContactFlowResponseTypeDef
# describe_contact_flow method usage example with argument unpacking

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 session.create_client("connect").describe_contact_flow_module method. boto3 documentation

# describe_contact_flow_module method definition

await def describe_contact_flow_module(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
) -> DescribeContactFlowModuleResponseTypeDef:  # (1)
    ...
  1. See DescribeContactFlowModuleResponseTypeDef
# describe_contact_flow_module method usage example with argument unpacking

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

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

describe_evaluation_form#

Describes an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").describe_evaluation_form method. boto3 documentation

# describe_evaluation_form method definition

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

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

parent.describe_evaluation_form(**kwargs)
  1. See DescribeEvaluationFormRequestRequestTypeDef

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.create_client("connect").describe_hours_of_operation method. boto3 documentation

# describe_hours_of_operation method definition

await def describe_hours_of_operation(
    self,
    *,
    InstanceId: str,
    HoursOfOperationId: str,
) -> DescribeHoursOfOperationResponseTypeDef:  # (1)
    ...
  1. See DescribeHoursOfOperationResponseTypeDef
# describe_hours_of_operation method usage example with argument unpacking

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 session.create_client("connect").describe_instance method. boto3 documentation

# describe_instance method definition

await def describe_instance(
    self,
    *,
    InstanceId: str,
) -> DescribeInstanceResponseTypeDef:  # (1)
    ...
  1. See DescribeInstanceResponseTypeDef
# describe_instance method usage example with argument unpacking

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 session.create_client("connect").describe_instance_attribute method. boto3 documentation

# describe_instance_attribute method definition

await def describe_instance_attribute(
    self,
    *,
    InstanceId: str,
    AttributeType: InstanceAttributeTypeType,  # (1)
) -> DescribeInstanceAttributeResponseTypeDef:  # (2)
    ...
  1. See InstanceAttributeTypeType
  2. See DescribeInstanceAttributeResponseTypeDef
# describe_instance_attribute method usage example with argument unpacking

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

parent.describe_instance_attribute(**kwargs)
  1. See DescribeInstanceAttributeRequestRequestTypeDef

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.create_client("connect").describe_instance_storage_config method. boto3 documentation

# describe_instance_storage_config method definition

await def describe_instance_storage_config(
    self,
    *,
    InstanceId: str,
    AssociationId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
) -> DescribeInstanceStorageConfigResponseTypeDef:  # (2)
    ...
  1. See InstanceStorageResourceTypeType
  2. See DescribeInstanceStorageConfigResponseTypeDef
# describe_instance_storage_config method usage example with argument unpacking

kwargs: DescribeInstanceStorageConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "AssociationId": ...,
    "ResourceType": ...,
}

parent.describe_instance_storage_config(**kwargs)
  1. See DescribeInstanceStorageConfigRequestRequestTypeDef

describe_phone_number#

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

Type annotations and code completion for session.create_client("connect").describe_phone_number method. boto3 documentation

# describe_phone_number method definition

await def describe_phone_number(
    self,
    *,
    PhoneNumberId: str,
) -> DescribePhoneNumberResponseTypeDef:  # (1)
    ...
  1. See DescribePhoneNumberResponseTypeDef
# describe_phone_number method usage example with argument unpacking

kwargs: DescribePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.describe_phone_number(**kwargs)
  1. See DescribePhoneNumberRequestRequestTypeDef

describe_prompt#

Describes the prompt.

Type annotations and code completion for session.create_client("connect").describe_prompt method. boto3 documentation

# describe_prompt method definition

await def describe_prompt(
    self,
    *,
    InstanceId: str,
    PromptId: str,
) -> DescribePromptResponseTypeDef:  # (1)
    ...
  1. See DescribePromptResponseTypeDef
# describe_prompt method usage example with argument unpacking

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

parent.describe_prompt(**kwargs)
  1. See DescribePromptRequestRequestTypeDef

describe_queue#

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

Type annotations and code completion for session.create_client("connect").describe_queue method. boto3 documentation

# describe_queue method definition

await def describe_queue(
    self,
    *,
    InstanceId: str,
    QueueId: str,
) -> DescribeQueueResponseTypeDef:  # (1)
    ...
  1. See DescribeQueueResponseTypeDef
# describe_queue method usage example with argument unpacking

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

parent.describe_queue(**kwargs)
  1. See DescribeQueueRequestRequestTypeDef

describe_quick_connect#

Describes the quick connect.

Type annotations and code completion for session.create_client("connect").describe_quick_connect method. boto3 documentation

# describe_quick_connect method definition

await def describe_quick_connect(
    self,
    *,
    InstanceId: str,
    QuickConnectId: str,
) -> DescribeQuickConnectResponseTypeDef:  # (1)
    ...
  1. See DescribeQuickConnectResponseTypeDef
# describe_quick_connect method usage example with argument unpacking

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

parent.describe_quick_connect(**kwargs)
  1. See DescribeQuickConnectRequestRequestTypeDef

describe_routing_profile#

Describes the specified routing profile.

Type annotations and code completion for session.create_client("connect").describe_routing_profile method. boto3 documentation

# describe_routing_profile method definition

await def describe_routing_profile(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
) -> DescribeRoutingProfileResponseTypeDef:  # (1)
    ...
  1. See DescribeRoutingProfileResponseTypeDef
# describe_routing_profile method usage example with argument unpacking

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

parent.describe_routing_profile(**kwargs)
  1. See DescribeRoutingProfileRequestRequestTypeDef

describe_rule#

Describes a rule for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").describe_rule method. boto3 documentation

# describe_rule method definition

await def describe_rule(
    self,
    *,
    InstanceId: str,
    RuleId: str,
) -> DescribeRuleResponseTypeDef:  # (1)
    ...
  1. See DescribeRuleResponseTypeDef
# describe_rule method usage example with argument unpacking

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

parent.describe_rule(**kwargs)
  1. See DescribeRuleRequestRequestTypeDef

describe_security_profile#

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

Type annotations and code completion for session.create_client("connect").describe_security_profile method. boto3 documentation

# describe_security_profile method definition

await def describe_security_profile(
    self,
    *,
    SecurityProfileId: str,
    InstanceId: str,
) -> DescribeSecurityProfileResponseTypeDef:  # (1)
    ...
  1. See DescribeSecurityProfileResponseTypeDef
# describe_security_profile method usage example with argument unpacking

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

parent.describe_security_profile(**kwargs)
  1. See DescribeSecurityProfileRequestRequestTypeDef

describe_traffic_distribution_group#

Gets details and status of a traffic distribution group.

Type annotations and code completion for session.create_client("connect").describe_traffic_distribution_group method. boto3 documentation

# describe_traffic_distribution_group method definition

await def describe_traffic_distribution_group(
    self,
    *,
    TrafficDistributionGroupId: str,
) -> DescribeTrafficDistributionGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeTrafficDistributionGroupResponseTypeDef
# describe_traffic_distribution_group method usage example with argument unpacking

kwargs: DescribeTrafficDistributionGroupRequestRequestTypeDef = {  # (1)
    "TrafficDistributionGroupId": ...,
}

parent.describe_traffic_distribution_group(**kwargs)
  1. See DescribeTrafficDistributionGroupRequestRequestTypeDef

describe_user#

Describes the specified user account.

Type annotations and code completion for session.create_client("connect").describe_user method. boto3 documentation

# describe_user method definition

await def describe_user(
    self,
    *,
    UserId: str,
    InstanceId: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
# describe_user method usage example with argument unpacking

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

parent.describe_user(**kwargs)
  1. See DescribeUserRequestRequestTypeDef

describe_user_hierarchy_group#

Describes the specified hierarchy group.

Type annotations and code completion for session.create_client("connect").describe_user_hierarchy_group method. boto3 documentation

# describe_user_hierarchy_group method definition

await def describe_user_hierarchy_group(
    self,
    *,
    HierarchyGroupId: str,
    InstanceId: str,
) -> DescribeUserHierarchyGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeUserHierarchyGroupResponseTypeDef
# describe_user_hierarchy_group method usage example with argument unpacking

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

parent.describe_user_hierarchy_group(**kwargs)
  1. See DescribeUserHierarchyGroupRequestRequestTypeDef

describe_user_hierarchy_structure#

Describes the hierarchy structure of the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").describe_user_hierarchy_structure method. boto3 documentation

# describe_user_hierarchy_structure method definition

await def describe_user_hierarchy_structure(
    self,
    *,
    InstanceId: str,
) -> DescribeUserHierarchyStructureResponseTypeDef:  # (1)
    ...
  1. See DescribeUserHierarchyStructureResponseTypeDef
# describe_user_hierarchy_structure method usage example with argument unpacking

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

parent.describe_user_hierarchy_structure(**kwargs)
  1. See DescribeUserHierarchyStructureRequestRequestTypeDef

describe_vocabulary#

Describes the specified vocabulary.

Type annotations and code completion for session.create_client("connect").describe_vocabulary method. boto3 documentation

# describe_vocabulary method definition

await def describe_vocabulary(
    self,
    *,
    InstanceId: str,
    VocabularyId: str,
) -> DescribeVocabularyResponseTypeDef:  # (1)
    ...
  1. See DescribeVocabularyResponseTypeDef
# describe_vocabulary method usage example with argument unpacking

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

parent.describe_vocabulary(**kwargs)
  1. See DescribeVocabularyRequestRequestTypeDef

disassociate_approved_origin#

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

Type annotations and code completion for session.create_client("connect").disassociate_approved_origin method. boto3 documentation

# disassociate_approved_origin method definition

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

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

parent.disassociate_approved_origin(**kwargs)
  1. See DisassociateApprovedOriginRequestRequestTypeDef

disassociate_bot#

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

Type annotations and code completion for session.create_client("connect").disassociate_bot method. boto3 documentation

# disassociate_bot method definition

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

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

parent.disassociate_bot(**kwargs)
  1. See DisassociateBotRequestRequestTypeDef

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.create_client("connect").disassociate_instance_storage_config method. boto3 documentation

# disassociate_instance_storage_config method definition

await def disassociate_instance_storage_config(
    self,
    *,
    InstanceId: str,
    AssociationId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See InstanceStorageResourceTypeType
  2. See EmptyResponseMetadataTypeDef
# disassociate_instance_storage_config method usage example with argument unpacking

kwargs: DisassociateInstanceStorageConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "AssociationId": ...,
    "ResourceType": ...,
}

parent.disassociate_instance_storage_config(**kwargs)
  1. See DisassociateInstanceStorageConfigRequestRequestTypeDef

disassociate_lambda_function#

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

Type annotations and code completion for session.create_client("connect").disassociate_lambda_function method. boto3 documentation

# disassociate_lambda_function method definition

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

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

parent.disassociate_lambda_function(**kwargs)
  1. See DisassociateLambdaFunctionRequestRequestTypeDef

disassociate_lex_bot#

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

Type annotations and code completion for session.create_client("connect").disassociate_lex_bot method. boto3 documentation

# disassociate_lex_bot method definition

await def disassociate_lex_bot(
    self,
    *,
    InstanceId: str,
    BotName: str,
    LexRegion: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# disassociate_lex_bot method usage example with argument unpacking

kwargs: DisassociateLexBotRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "BotName": ...,
    "LexRegion": ...,
}

parent.disassociate_lex_bot(**kwargs)
  1. See DisassociateLexBotRequestRequestTypeDef

disassociate_phone_number_contact_flow#

Removes the flow association from a phone number claimed to your Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").disassociate_phone_number_contact_flow method. boto3 documentation

# disassociate_phone_number_contact_flow method definition

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

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

parent.disassociate_phone_number_contact_flow(**kwargs)
  1. See DisassociatePhoneNumberContactFlowRequestRequestTypeDef

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.create_client("connect").disassociate_queue_quick_connects method. boto3 documentation

# disassociate_queue_quick_connects method definition

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

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

parent.disassociate_queue_quick_connects(**kwargs)
  1. See DisassociateQueueQuickConnectsRequestRequestTypeDef

disassociate_routing_profile_queues#

Disassociates a set of queues from a routing profile.

Type annotations and code completion for session.create_client("connect").disassociate_routing_profile_queues method. boto3 documentation

# disassociate_routing_profile_queues method definition

await def disassociate_routing_profile_queues(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See RoutingProfileQueueReferenceTypeDef
  2. See EmptyResponseMetadataTypeDef
# disassociate_routing_profile_queues method usage example with argument unpacking

kwargs: DisassociateRoutingProfileQueuesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "RoutingProfileId": ...,
    "QueueReferences": ...,
}

parent.disassociate_routing_profile_queues(**kwargs)
  1. See DisassociateRoutingProfileQueuesRequestRequestTypeDef

disassociate_security_key#

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

Type annotations and code completion for session.create_client("connect").disassociate_security_key method. boto3 documentation

# disassociate_security_key method definition

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

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

parent.disassociate_security_key(**kwargs)
  1. See DisassociateSecurityKeyRequestRequestTypeDef

disassociate_traffic_distribution_group_user#

Disassociates an agent from a traffic distribution group.

Type annotations and code completion for session.create_client("connect").disassociate_traffic_distribution_group_user method. boto3 documentation

# disassociate_traffic_distribution_group_user method definition

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

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

parent.disassociate_traffic_distribution_group_user(**kwargs)
  1. See DisassociateTrafficDistributionGroupUserRequestRequestTypeDef

dismiss_user_contact#

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact.

Type annotations and code completion for session.create_client("connect").dismiss_user_contact method. boto3 documentation

# dismiss_user_contact method definition

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

kwargs: DismissUserContactRequestRequestTypeDef = {  # (1)
    "UserId": ...,
    "InstanceId": ...,
    "ContactId": ...,
}

parent.dismiss_user_contact(**kwargs)
  1. See DismissUserContactRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.create_client("connect").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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.create_client("connect").get_contact_attributes method. boto3 documentation

# get_contact_attributes method definition

await def get_contact_attributes(
    self,
    *,
    InstanceId: str,
    InitialContactId: str,
) -> GetContactAttributesResponseTypeDef:  # (1)
    ...
  1. See GetContactAttributesResponseTypeDef
# get_contact_attributes method usage example with argument unpacking

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

parent.get_contact_attributes(**kwargs)
  1. See GetContactAttributesRequestRequestTypeDef

get_current_metric_data#

Gets the real-time metric data from the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").get_current_metric_data method. boto3 documentation

# get_current_metric_data method definition

await def get_current_metric_data(
    self,
    *,
    InstanceId: str,
    Filters: FiltersTypeDef,  # (1)
    CurrentMetrics: Sequence[CurrentMetricTypeDef],  # (2)
    Groupings: Sequence[GroupingType] = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    SortCriteria: Sequence[CurrentMetricSortCriteriaTypeDef] = ...,  # (4)
) -> GetCurrentMetricDataResponseTypeDef:  # (5)
    ...
  1. See FiltersTypeDef
  2. See CurrentMetricTypeDef
  3. See GroupingType
  4. See CurrentMetricSortCriteriaTypeDef
  5. See GetCurrentMetricDataResponseTypeDef
# get_current_metric_data method usage example with argument unpacking

kwargs: GetCurrentMetricDataRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Filters": ...,
    "CurrentMetrics": ...,
}

parent.get_current_metric_data(**kwargs)
  1. See GetCurrentMetricDataRequestRequestTypeDef

get_current_user_data#

Gets the real-time active user data from the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").get_current_user_data method. boto3 documentation

# get_current_user_data method definition

await def get_current_user_data(
    self,
    *,
    InstanceId: str,
    Filters: UserDataFiltersTypeDef,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetCurrentUserDataResponseTypeDef:  # (2)
    ...
  1. See UserDataFiltersTypeDef
  2. See GetCurrentUserDataResponseTypeDef
# get_current_user_data method usage example with argument unpacking

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

parent.get_current_user_data(**kwargs)
  1. See GetCurrentUserDataRequestRequestTypeDef

get_federation_token#

Retrieves a token for federation.

Type annotations and code completion for session.create_client("connect").get_federation_token method. boto3 documentation

# get_federation_token method definition

await def get_federation_token(
    self,
    *,
    InstanceId: str,
) -> GetFederationTokenResponseTypeDef:  # (1)
    ...
  1. See GetFederationTokenResponseTypeDef
# get_federation_token method usage example with argument unpacking

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

parent.get_federation_token(**kwargs)
  1. See GetFederationTokenRequestRequestTypeDef

get_metric_data#

Gets historical metric data from the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").get_metric_data method. boto3 documentation

# get_metric_data method definition

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)
    ...
  1. See FiltersTypeDef
  2. See HistoricalMetricTypeDef
  3. See GroupingType
  4. See GetMetricDataResponseTypeDef
# get_metric_data method usage example with argument unpacking

kwargs: GetMetricDataRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "StartTime": ...,
    "EndTime": ...,
    "Filters": ...,
    "HistoricalMetrics": ...,
}

parent.get_metric_data(**kwargs)
  1. See GetMetricDataRequestRequestTypeDef

get_metric_data_v2#

Gets metric data from the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").get_metric_data_v2 method. boto3 documentation

# get_metric_data_v2 method definition

await def get_metric_data_v2(
    self,
    *,
    ResourceArn: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Filters: Sequence[FilterV2TypeDef],  # (1)
    Metrics: Sequence[MetricV2TypeDef],  # (2)
    Groupings: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetMetricDataV2ResponseTypeDef:  # (3)
    ...
  1. See FilterV2TypeDef
  2. See MetricV2TypeDef
  3. See GetMetricDataV2ResponseTypeDef
# get_metric_data_v2 method usage example with argument unpacking

kwargs: GetMetricDataV2RequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "StartTime": ...,
    "EndTime": ...,
    "Filters": ...,
    "Metrics": ...,
}

parent.get_metric_data_v2(**kwargs)
  1. See GetMetricDataV2RequestRequestTypeDef

get_prompt_file#

Gets the prompt file.

Type annotations and code completion for session.create_client("connect").get_prompt_file method. boto3 documentation

# get_prompt_file method definition

await def get_prompt_file(
    self,
    *,
    InstanceId: str,
    PromptId: str,
) -> GetPromptFileResponseTypeDef:  # (1)
    ...
  1. See GetPromptFileResponseTypeDef
# get_prompt_file method usage example with argument unpacking

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

parent.get_prompt_file(**kwargs)
  1. See GetPromptFileRequestRequestTypeDef

get_task_template#

Gets details about a specific task template in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").get_task_template method. boto3 documentation

# get_task_template method definition

await def get_task_template(
    self,
    *,
    InstanceId: str,
    TaskTemplateId: str,
    SnapshotVersion: str = ...,
) -> GetTaskTemplateResponseTypeDef:  # (1)
    ...
  1. See GetTaskTemplateResponseTypeDef
# get_task_template method usage example with argument unpacking

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

parent.get_task_template(**kwargs)
  1. See GetTaskTemplateRequestRequestTypeDef

get_traffic_distribution#

Retrieves the current traffic distribution for a given traffic distribution group.

Type annotations and code completion for session.create_client("connect").get_traffic_distribution method. boto3 documentation

# get_traffic_distribution method definition

await def get_traffic_distribution(
    self,
    *,
    Id: str,
) -> GetTrafficDistributionResponseTypeDef:  # (1)
    ...
  1. See GetTrafficDistributionResponseTypeDef
# get_traffic_distribution method usage example with argument unpacking

kwargs: GetTrafficDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_traffic_distribution(**kwargs)
  1. See GetTrafficDistributionRequestRequestTypeDef

list_agent_statuses#

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

Type annotations and code completion for session.create_client("connect").list_agent_statuses method. boto3 documentation

# list_agent_statuses method definition

await def list_agent_statuses(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    AgentStatusTypes: Sequence[AgentStatusTypeType] = ...,  # (1)
) -> ListAgentStatusResponseTypeDef:  # (2)
    ...
  1. See AgentStatusTypeType
  2. See ListAgentStatusResponseTypeDef
# list_agent_statuses method usage example with argument unpacking

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

parent.list_agent_statuses(**kwargs)
  1. See ListAgentStatusRequestRequestTypeDef

list_approved_origins#

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

Type annotations and code completion for session.create_client("connect").list_approved_origins method. boto3 documentation

# list_approved_origins method definition

await def list_approved_origins(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListApprovedOriginsResponseTypeDef:  # (1)
    ...
  1. See ListApprovedOriginsResponseTypeDef
# list_approved_origins method usage example with argument unpacking

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

parent.list_approved_origins(**kwargs)
  1. See ListApprovedOriginsRequestRequestTypeDef

list_bots#

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

Type annotations and code completion for session.create_client("connect").list_bots method. boto3 documentation

# list_bots method definition

await def list_bots(
    self,
    *,
    InstanceId: str,
    LexVersion: LexVersionType,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBotsResponseTypeDef:  # (2)
    ...
  1. See LexVersionType
  2. See ListBotsResponseTypeDef
# list_bots method usage example with argument unpacking

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

parent.list_bots(**kwargs)
  1. See ListBotsRequestRequestTypeDef

list_contact_evaluations#

Lists contact evaluations in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_contact_evaluations method. boto3 documentation

# list_contact_evaluations method definition

await def list_contact_evaluations(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    NextToken: str = ...,
) -> ListContactEvaluationsResponseTypeDef:  # (1)
    ...
  1. See ListContactEvaluationsResponseTypeDef
# list_contact_evaluations method usage example with argument unpacking

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

parent.list_contact_evaluations(**kwargs)
  1. See ListContactEvaluationsRequestRequestTypeDef

list_contact_flow_modules#

Provides information about the flow modules for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_contact_flow_modules method. boto3 documentation

# list_contact_flow_modules method definition

await def list_contact_flow_modules(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    ContactFlowModuleState: ContactFlowModuleStateType = ...,  # (1)
) -> ListContactFlowModulesResponseTypeDef:  # (2)
    ...
  1. See ContactFlowModuleStateType
  2. See ListContactFlowModulesResponseTypeDef
# list_contact_flow_modules method usage example with argument unpacking

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

parent.list_contact_flow_modules(**kwargs)
  1. See ListContactFlowModulesRequestRequestTypeDef

list_contact_flows#

Provides information about the flows for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_contact_flows method. boto3 documentation

# list_contact_flows method definition

await def list_contact_flows(
    self,
    *,
    InstanceId: str,
    ContactFlowTypes: Sequence[ContactFlowTypeType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListContactFlowsResponseTypeDef:  # (2)
    ...
  1. See ContactFlowTypeType
  2. See ListContactFlowsResponseTypeDef
# list_contact_flows method usage example with argument unpacking

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

parent.list_contact_flows(**kwargs)
  1. See ListContactFlowsRequestRequestTypeDef

list_contact_references#

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

Type annotations and code completion for session.create_client("connect").list_contact_references method. boto3 documentation

# list_contact_references method definition

await def list_contact_references(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ReferenceTypes: Sequence[ReferenceTypeType],  # (1)
    NextToken: str = ...,
) -> ListContactReferencesResponseTypeDef:  # (2)
    ...
  1. See ReferenceTypeType
  2. See ListContactReferencesResponseTypeDef
# list_contact_references method usage example with argument unpacking

kwargs: ListContactReferencesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ReferenceTypes": ...,
}

parent.list_contact_references(**kwargs)
  1. See ListContactReferencesRequestRequestTypeDef

list_default_vocabularies#

Lists the default vocabularies for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_default_vocabularies method. boto3 documentation

# list_default_vocabularies method definition

await def list_default_vocabularies(
    self,
    *,
    InstanceId: str,
    LanguageCode: VocabularyLanguageCodeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDefaultVocabulariesResponseTypeDef:  # (2)
    ...
  1. See VocabularyLanguageCodeType
  2. See ListDefaultVocabulariesResponseTypeDef
# list_default_vocabularies method usage example with argument unpacking

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

parent.list_default_vocabularies(**kwargs)
  1. See ListDefaultVocabulariesRequestRequestTypeDef

list_evaluation_form_versions#

Lists versions of an evaluation form in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_evaluation_form_versions method. boto3 documentation

# list_evaluation_form_versions method definition

await def list_evaluation_form_versions(
    self,
    *,
    InstanceId: str,
    EvaluationFormId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEvaluationFormVersionsResponseTypeDef:  # (1)
    ...
  1. See ListEvaluationFormVersionsResponseTypeDef
# list_evaluation_form_versions method usage example with argument unpacking

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

parent.list_evaluation_form_versions(**kwargs)
  1. See ListEvaluationFormVersionsRequestRequestTypeDef

list_evaluation_forms#

Lists evaluation forms in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_evaluation_forms method. boto3 documentation

# list_evaluation_forms method definition

await def list_evaluation_forms(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEvaluationFormsResponseTypeDef:  # (1)
    ...
  1. See ListEvaluationFormsResponseTypeDef
# list_evaluation_forms method usage example with argument unpacking

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

parent.list_evaluation_forms(**kwargs)
  1. See ListEvaluationFormsRequestRequestTypeDef

list_hours_of_operations#

Provides information about the hours of operation for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_hours_of_operations method. boto3 documentation

# list_hours_of_operations method definition

await def list_hours_of_operations(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListHoursOfOperationsResponseTypeDef:  # (1)
    ...
  1. See ListHoursOfOperationsResponseTypeDef
# list_hours_of_operations method usage example with argument unpacking

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

parent.list_hours_of_operations(**kwargs)
  1. See ListHoursOfOperationsRequestRequestTypeDef

list_instance_attributes#

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

Type annotations and code completion for session.create_client("connect").list_instance_attributes method. boto3 documentation

# list_instance_attributes method definition

await def list_instance_attributes(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInstanceAttributesResponseTypeDef:  # (1)
    ...
  1. See ListInstanceAttributesResponseTypeDef
# list_instance_attributes method usage example with argument unpacking

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

parent.list_instance_attributes(**kwargs)
  1. See ListInstanceAttributesRequestRequestTypeDef

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.create_client("connect").list_instance_storage_configs method. boto3 documentation

# list_instance_storage_configs method definition

await def list_instance_storage_configs(
    self,
    *,
    InstanceId: str,
    ResourceType: InstanceStorageResourceTypeType,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInstanceStorageConfigsResponseTypeDef:  # (2)
    ...
  1. See InstanceStorageResourceTypeType
  2. See ListInstanceStorageConfigsResponseTypeDef
# list_instance_storage_configs method usage example with argument unpacking

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

parent.list_instance_storage_configs(**kwargs)
  1. See ListInstanceStorageConfigsRequestRequestTypeDef

list_instances#

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

Type annotations and code completion for session.create_client("connect").list_instances method. boto3 documentation

# list_instances method definition

await def list_instances(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInstancesResponseTypeDef:  # (1)
    ...
  1. See ListInstancesResponseTypeDef
# list_instances method usage example with argument unpacking

kwargs: ListInstancesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_instances(**kwargs)
  1. See ListInstancesRequestRequestTypeDef

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.create_client("connect").list_integration_associations method. boto3 documentation

# list_integration_associations method definition

await def list_integration_associations(
    self,
    *,
    InstanceId: str,
    IntegrationType: IntegrationTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIntegrationAssociationsResponseTypeDef:  # (2)
    ...
  1. See IntegrationTypeType
  2. See ListIntegrationAssociationsResponseTypeDef
# list_integration_associations method usage example with argument unpacking

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

parent.list_integration_associations(**kwargs)
  1. See ListIntegrationAssociationsRequestRequestTypeDef

list_lambda_functions#

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

Type annotations and code completion for session.create_client("connect").list_lambda_functions method. boto3 documentation

# list_lambda_functions method definition

await def list_lambda_functions(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLambdaFunctionsResponseTypeDef:  # (1)
    ...
  1. See ListLambdaFunctionsResponseTypeDef
# list_lambda_functions method usage example with argument unpacking

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

parent.list_lambda_functions(**kwargs)
  1. See ListLambdaFunctionsRequestRequestTypeDef

list_lex_bots#

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

Type annotations and code completion for session.create_client("connect").list_lex_bots method. boto3 documentation

# list_lex_bots method definition

await def list_lex_bots(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLexBotsResponseTypeDef:  # (1)
    ...
  1. See ListLexBotsResponseTypeDef
# list_lex_bots method usage example with argument unpacking

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

parent.list_lex_bots(**kwargs)
  1. See ListLexBotsRequestRequestTypeDef

list_phone_numbers#

Provides information about the phone numbers for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_phone_numbers method. boto3 documentation

# list_phone_numbers method definition

await def list_phone_numbers(
    self,
    *,
    InstanceId: str,
    PhoneNumberTypes: Sequence[PhoneNumberTypeType] = ...,  # (1)
    PhoneNumberCountryCodes: Sequence[PhoneNumberCountryCodeType] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPhoneNumbersResponseTypeDef:  # (3)
    ...
  1. See PhoneNumberTypeType
  2. See PhoneNumberCountryCodeType
  3. See ListPhoneNumbersResponseTypeDef
# list_phone_numbers method usage example with argument unpacking

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

parent.list_phone_numbers(**kwargs)
  1. See ListPhoneNumbersRequestRequestTypeDef

list_phone_numbers_v2#

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.

Type annotations and code completion for session.create_client("connect").list_phone_numbers_v2 method. boto3 documentation

# list_phone_numbers_v2 method definition

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)
    ...
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType
  3. See ListPhoneNumbersV2ResponseTypeDef
# list_phone_numbers_v2 method usage example with argument unpacking

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

parent.list_phone_numbers_v2(**kwargs)
  1. See ListPhoneNumbersV2RequestRequestTypeDef

list_prompts#

Provides information about the prompts for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_prompts method. boto3 documentation

# list_prompts method definition

await def list_prompts(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListPromptsResponseTypeDef:  # (1)
    ...
  1. See ListPromptsResponseTypeDef
# list_prompts method usage example with argument unpacking

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

parent.list_prompts(**kwargs)
  1. See ListPromptsRequestRequestTypeDef

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.create_client("connect").list_queue_quick_connects method. boto3 documentation

# list_queue_quick_connects method definition

await def list_queue_quick_connects(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQueueQuickConnectsResponseTypeDef:  # (1)
    ...
  1. See ListQueueQuickConnectsResponseTypeDef
# list_queue_quick_connects method usage example with argument unpacking

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

parent.list_queue_quick_connects(**kwargs)
  1. See ListQueueQuickConnectsRequestRequestTypeDef

list_queues#

Provides information about the queues for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_queues method. boto3 documentation

# list_queues method definition

await def list_queues(
    self,
    *,
    InstanceId: str,
    QueueTypes: Sequence[QueueTypeType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQueuesResponseTypeDef:  # (2)
    ...
  1. See QueueTypeType
  2. See ListQueuesResponseTypeDef
# list_queues method usage example with argument unpacking

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

parent.list_queues(**kwargs)
  1. See ListQueuesRequestRequestTypeDef

list_quick_connects#

Provides information about the quick connects for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_quick_connects method. boto3 documentation

# list_quick_connects method definition

await def list_quick_connects(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    QuickConnectTypes: Sequence[QuickConnectTypeType] = ...,  # (1)
) -> ListQuickConnectsResponseTypeDef:  # (2)
    ...
  1. See QuickConnectTypeType
  2. See ListQuickConnectsResponseTypeDef
# list_quick_connects method usage example with argument unpacking

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

parent.list_quick_connects(**kwargs)
  1. See ListQuickConnectsRequestRequestTypeDef

list_routing_profile_queues#

Lists the queues associated with a routing profile.

Type annotations and code completion for session.create_client("connect").list_routing_profile_queues method. boto3 documentation

# list_routing_profile_queues method definition

await def list_routing_profile_queues(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRoutingProfileQueuesResponseTypeDef:  # (1)
    ...
  1. See ListRoutingProfileQueuesResponseTypeDef
# list_routing_profile_queues method usage example with argument unpacking

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

parent.list_routing_profile_queues(**kwargs)
  1. See ListRoutingProfileQueuesRequestRequestTypeDef

list_routing_profiles#

Provides summary information about the routing profiles for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_routing_profiles method. boto3 documentation

# list_routing_profiles method definition

await def list_routing_profiles(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRoutingProfilesResponseTypeDef:  # (1)
    ...
  1. See ListRoutingProfilesResponseTypeDef
# list_routing_profiles method usage example with argument unpacking

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

parent.list_routing_profiles(**kwargs)
  1. See ListRoutingProfilesRequestRequestTypeDef

list_rules#

List all rules for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_rules method. boto3 documentation

# list_rules method definition

await def list_rules(
    self,
    *,
    InstanceId: str,
    PublishStatus: RulePublishStatusType = ...,  # (1)
    EventSourceName: EventSourceNameType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRulesResponseTypeDef:  # (3)
    ...
  1. See RulePublishStatusType
  2. See EventSourceNameType
  3. See ListRulesResponseTypeDef
# list_rules method usage example with argument unpacking

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

parent.list_rules(**kwargs)
  1. See ListRulesRequestRequestTypeDef

list_security_keys#

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

Type annotations and code completion for session.create_client("connect").list_security_keys method. boto3 documentation

# list_security_keys method definition

await def list_security_keys(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSecurityKeysResponseTypeDef:  # (1)
    ...
  1. See ListSecurityKeysResponseTypeDef
# list_security_keys method usage example with argument unpacking

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

parent.list_security_keys(**kwargs)
  1. See ListSecurityKeysRequestRequestTypeDef

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.create_client("connect").list_security_profile_permissions method. boto3 documentation

# list_security_profile_permissions method definition

await def list_security_profile_permissions(
    self,
    *,
    SecurityProfileId: str,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSecurityProfilePermissionsResponseTypeDef:  # (1)
    ...
  1. See ListSecurityProfilePermissionsResponseTypeDef
# list_security_profile_permissions method usage example with argument unpacking

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

parent.list_security_profile_permissions(**kwargs)
  1. See ListSecurityProfilePermissionsRequestRequestTypeDef

list_security_profiles#

Provides summary information about the security profiles for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_security_profiles method. boto3 documentation

# list_security_profiles method definition

await def list_security_profiles(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSecurityProfilesResponseTypeDef:  # (1)
    ...
  1. See ListSecurityProfilesResponseTypeDef
# list_security_profiles method usage example with argument unpacking

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

parent.list_security_profiles(**kwargs)
  1. See ListSecurityProfilesRequestRequestTypeDef

list_tags_for_resource#

Lists the tags for the specified resource.

Type annotations and code completion for session.create_client("connect").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_task_templates#

Lists task templates for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_task_templates method. boto3 documentation

# list_task_templates method definition

await def list_task_templates(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: TaskTemplateStatusType = ...,  # (1)
    Name: str = ...,
) -> ListTaskTemplatesResponseTypeDef:  # (2)
    ...
  1. See TaskTemplateStatusType
  2. See ListTaskTemplatesResponseTypeDef
# list_task_templates method usage example with argument unpacking

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

parent.list_task_templates(**kwargs)
  1. See ListTaskTemplatesRequestRequestTypeDef

list_traffic_distribution_group_users#

Lists traffic distribution group users.

Type annotations and code completion for session.create_client("connect").list_traffic_distribution_group_users method. boto3 documentation

# list_traffic_distribution_group_users method definition

await def list_traffic_distribution_group_users(
    self,
    *,
    TrafficDistributionGroupId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTrafficDistributionGroupUsersResponseTypeDef:  # (1)
    ...
  1. See ListTrafficDistributionGroupUsersResponseTypeDef
# list_traffic_distribution_group_users method usage example with argument unpacking

kwargs: ListTrafficDistributionGroupUsersRequestRequestTypeDef = {  # (1)
    "TrafficDistributionGroupId": ...,
}

parent.list_traffic_distribution_group_users(**kwargs)
  1. See ListTrafficDistributionGroupUsersRequestRequestTypeDef

list_traffic_distribution_groups#

Lists traffic distribution groups.

Type annotations and code completion for session.create_client("connect").list_traffic_distribution_groups method. boto3 documentation

# list_traffic_distribution_groups method definition

await def list_traffic_distribution_groups(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    InstanceId: str = ...,
) -> ListTrafficDistributionGroupsResponseTypeDef:  # (1)
    ...
  1. See ListTrafficDistributionGroupsResponseTypeDef
# list_traffic_distribution_groups method usage example with argument unpacking

kwargs: ListTrafficDistributionGroupsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_traffic_distribution_groups(**kwargs)
  1. See ListTrafficDistributionGroupsRequestRequestTypeDef

list_use_cases#

Lists the use cases for the integration association.

Type annotations and code completion for session.create_client("connect").list_use_cases method. boto3 documentation

# list_use_cases method definition

await def list_use_cases(
    self,
    *,
    InstanceId: str,
    IntegrationAssociationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUseCasesResponseTypeDef:  # (1)
    ...
  1. See ListUseCasesResponseTypeDef
# list_use_cases method usage example with argument unpacking

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

parent.list_use_cases(**kwargs)
  1. See ListUseCasesRequestRequestTypeDef

list_user_hierarchy_groups#

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_user_hierarchy_groups method. boto3 documentation

# list_user_hierarchy_groups method definition

await def list_user_hierarchy_groups(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUserHierarchyGroupsResponseTypeDef:  # (1)
    ...
  1. See ListUserHierarchyGroupsResponseTypeDef
# list_user_hierarchy_groups method usage example with argument unpacking

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

parent.list_user_hierarchy_groups(**kwargs)
  1. See ListUserHierarchyGroupsRequestRequestTypeDef

list_users#

Provides summary information about the users for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").list_users method. boto3 documentation

# list_users method definition

await def list_users(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...
  1. See ListUsersResponseTypeDef
# list_users method usage example with argument unpacking

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

parent.list_users(**kwargs)
  1. See ListUsersRequestRequestTypeDef

monitor_contact#

Initiates silent monitoring of a contact.

Type annotations and code completion for session.create_client("connect").monitor_contact method. boto3 documentation

# monitor_contact method definition

await def monitor_contact(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    UserId: str,
    AllowedMonitorCapabilities: Sequence[MonitorCapabilityType] = ...,  # (1)
    ClientToken: str = ...,
) -> MonitorContactResponseTypeDef:  # (2)
    ...
  1. See MonitorCapabilityType
  2. See MonitorContactResponseTypeDef
# monitor_contact method usage example with argument unpacking

kwargs: MonitorContactRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "UserId": ...,
}

parent.monitor_contact(**kwargs)
  1. See MonitorContactRequestRequestTypeDef

put_user_status#

Changes the current status of a user or agent in Amazon Connect.

Type annotations and code completion for session.create_client("connect").put_user_status method. boto3 documentation

# put_user_status method definition

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

kwargs: PutUserStatusRequestRequestTypeDef = {  # (1)
    "UserId": ...,
    "InstanceId": ...,
    "AgentStatusId": ...,
}

parent.put_user_status(**kwargs)
  1. See PutUserStatusRequestRequestTypeDef

release_phone_number#

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.

Type annotations and code completion for session.create_client("connect").release_phone_number method. boto3 documentation

# release_phone_number method definition

await def release_phone_number(
    self,
    *,
    PhoneNumberId: str,
    ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# release_phone_number method usage example with argument unpacking

kwargs: ReleasePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
}

parent.release_phone_number(**kwargs)
  1. See ReleasePhoneNumberRequestRequestTypeDef

replicate_instance#

Replicates an Amazon Connect instance in the specified Amazon Web Services Region.

Type annotations and code completion for session.create_client("connect").replicate_instance method. boto3 documentation

# replicate_instance method definition

await def replicate_instance(
    self,
    *,
    InstanceId: str,
    ReplicaRegion: str,
    ReplicaAlias: str,
    ClientToken: str = ...,
) -> ReplicateInstanceResponseTypeDef:  # (1)
    ...
  1. See ReplicateInstanceResponseTypeDef
# replicate_instance method usage example with argument unpacking

kwargs: ReplicateInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ReplicaRegion": ...,
    "ReplicaAlias": ...,
}

parent.replicate_instance(**kwargs)
  1. See ReplicateInstanceRequestRequestTypeDef

resume_contact_recording#

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call or screen.

Type annotations and code completion for session.create_client("connect").resume_contact_recording method. boto3 documentation

# resume_contact_recording method definition

await def resume_contact_recording(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,
) -> Dict[str, Any]:
    ...
# resume_contact_recording method usage example with argument unpacking

kwargs: ResumeContactRecordingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "InitialContactId": ...,
}

parent.resume_contact_recording(**kwargs)
  1. See ResumeContactRecordingRequestRequestTypeDef

search_available_phone_numbers#

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

Type annotations and code completion for session.create_client("connect").search_available_phone_numbers method. boto3 documentation

# search_available_phone_numbers method definition

await def search_available_phone_numbers(
    self,
    *,
    TargetArn: str,
    PhoneNumberCountryCode: PhoneNumberCountryCodeType,  # (1)
    PhoneNumberType: PhoneNumberTypeType,  # (2)
    PhoneNumberPrefix: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SearchAvailablePhoneNumbersResponseTypeDef:  # (3)
    ...
  1. See PhoneNumberCountryCodeType
  2. See PhoneNumberTypeType
  3. See SearchAvailablePhoneNumbersResponseTypeDef
# search_available_phone_numbers method usage example with argument unpacking

kwargs: SearchAvailablePhoneNumbersRequestRequestTypeDef = {  # (1)
    "TargetArn": ...,
    "PhoneNumberCountryCode": ...,
    "PhoneNumberType": ...,
}

parent.search_available_phone_numbers(**kwargs)
  1. See SearchAvailablePhoneNumbersRequestRequestTypeDef

search_hours_of_operations#

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_hours_of_operations method. boto3 documentation

# search_hours_of_operations method definition

await def search_hours_of_operations(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: HoursOfOperationSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: HoursOfOperationSearchCriteriaTypeDef = ...,  # (2)
) -> SearchHoursOfOperationsResponseTypeDef:  # (3)
    ...
  1. See HoursOfOperationSearchFilterTypeDef
  2. See HoursOfOperationSearchCriteriaTypeDef
  3. See SearchHoursOfOperationsResponseTypeDef
# search_hours_of_operations method usage example with argument unpacking

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

parent.search_hours_of_operations(**kwargs)
  1. See SearchHoursOfOperationsRequestRequestTypeDef

search_prompts#

Searches prompts in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_prompts method. boto3 documentation

# search_prompts method definition

await def search_prompts(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: PromptSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: PromptSearchCriteriaTypeDef = ...,  # (2)
) -> SearchPromptsResponseTypeDef:  # (3)
    ...
  1. See PromptSearchFilterTypeDef
  2. See PromptSearchCriteriaTypeDef
  3. See SearchPromptsResponseTypeDef
# search_prompts method usage example with argument unpacking

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

parent.search_prompts(**kwargs)
  1. See SearchPromptsRequestRequestTypeDef

search_queues#

Searches queues in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_queues method. boto3 documentation

# search_queues method definition

await def search_queues(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: QueueSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: QueueSearchCriteriaTypeDef = ...,  # (2)
) -> SearchQueuesResponseTypeDef:  # (3)
    ...
  1. See QueueSearchFilterTypeDef
  2. See QueueSearchCriteriaTypeDef
  3. See SearchQueuesResponseTypeDef
# search_queues method usage example with argument unpacking

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

parent.search_queues(**kwargs)
  1. See SearchQueuesRequestRequestTypeDef

search_quick_connects#

Searches quick connects in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_quick_connects method. boto3 documentation

# search_quick_connects method definition

await def search_quick_connects(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: QuickConnectSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: QuickConnectSearchCriteriaTypeDef = ...,  # (2)
) -> SearchQuickConnectsResponseTypeDef:  # (3)
    ...
  1. See QuickConnectSearchFilterTypeDef
  2. See QuickConnectSearchCriteriaTypeDef
  3. See SearchQuickConnectsResponseTypeDef
# search_quick_connects method usage example with argument unpacking

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

parent.search_quick_connects(**kwargs)
  1. See SearchQuickConnectsRequestRequestTypeDef

search_resource_tags#

Searches tags used in an Amazon Connect instance using optional search criteria.

Type annotations and code completion for session.create_client("connect").search_resource_tags method. boto3 documentation

# search_resource_tags method definition

await def search_resource_tags(
    self,
    *,
    InstanceId: str,
    ResourceTypes: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchCriteria: ResourceTagsSearchCriteriaTypeDef = ...,  # (1)
) -> SearchResourceTagsResponseTypeDef:  # (2)
    ...
  1. See ResourceTagsSearchCriteriaTypeDef
  2. See SearchResourceTagsResponseTypeDef
# search_resource_tags method usage example with argument unpacking

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

parent.search_resource_tags(**kwargs)
  1. See SearchResourceTagsRequestRequestTypeDef

search_routing_profiles#

Searches routing profiles in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_routing_profiles method. boto3 documentation

# search_routing_profiles method definition

await def search_routing_profiles(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: RoutingProfileSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: RoutingProfileSearchCriteriaTypeDef = ...,  # (2)
) -> SearchRoutingProfilesResponseTypeDef:  # (3)
    ...
  1. See RoutingProfileSearchFilterTypeDef
  2. See RoutingProfileSearchCriteriaTypeDef
  3. See SearchRoutingProfilesResponseTypeDef
# search_routing_profiles method usage example with argument unpacking

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

parent.search_routing_profiles(**kwargs)
  1. See SearchRoutingProfilesRequestRequestTypeDef

search_security_profiles#

Searches security profiles in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_security_profiles method. boto3 documentation

# search_security_profiles method definition

await def search_security_profiles(
    self,
    *,
    InstanceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchCriteria: SecurityProfileSearchCriteriaTypeDef = ...,  # (1)
    SearchFilter: SecurityProfilesSearchFilterTypeDef = ...,  # (2)
) -> SearchSecurityProfilesResponseTypeDef:  # (3)
    ...
  1. See SecurityProfileSearchCriteriaTypeDef
  2. See SecurityProfilesSearchFilterTypeDef
  3. See SearchSecurityProfilesResponseTypeDef
# search_security_profiles method usage example with argument unpacking

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

parent.search_security_profiles(**kwargs)
  1. See SearchSecurityProfilesRequestRequestTypeDef

search_users#

Searches users in an Amazon Connect instance, with optional filtering.

Type annotations and code completion for session.create_client("connect").search_users method. boto3 documentation

# search_users method definition

await def search_users(
    self,
    *,
    InstanceId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    SearchFilter: UserSearchFilterTypeDef = ...,  # (1)
    SearchCriteria: UserSearchCriteriaTypeDef = ...,  # (2)
) -> SearchUsersResponseTypeDef:  # (3)
    ...
  1. See UserSearchFilterTypeDef
  2. See UserSearchCriteriaTypeDef
  3. See SearchUsersResponseTypeDef
# search_users method usage example with argument unpacking

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

parent.search_users(**kwargs)
  1. See SearchUsersRequestRequestTypeDef

search_vocabularies#

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

Type annotations and code completion for session.create_client("connect").search_vocabularies method. boto3 documentation

# search_vocabularies method definition

await def search_vocabularies(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    State: VocabularyStateType = ...,  # (1)
    NameStartsWith: str = ...,
    LanguageCode: VocabularyLanguageCodeType = ...,  # (2)
) -> SearchVocabulariesResponseTypeDef:  # (3)
    ...
  1. See VocabularyStateType
  2. See VocabularyLanguageCodeType
  3. See SearchVocabulariesResponseTypeDef
# search_vocabularies method usage example with argument unpacking

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

parent.search_vocabularies(**kwargs)
  1. See SearchVocabulariesRequestRequestTypeDef

start_chat_contact#

Initiates a flow to start a new chat for the customer.

Type annotations and code completion for session.create_client("connect").start_chat_contact method. boto3 documentation

# start_chat_contact method definition

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] = ...,
    PersistentChat: PersistentChatTypeDef = ...,  # (3)
    RelatedContactId: str = ...,
) -> StartChatContactResponseTypeDef:  # (4)
    ...
  1. See ParticipantDetailsTypeDef
  2. See ChatMessageTypeDef
  3. See PersistentChatTypeDef
  4. See StartChatContactResponseTypeDef
# start_chat_contact method usage example with argument unpacking

kwargs: StartChatContactRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowId": ...,
    "ParticipantDetails": ...,
}

parent.start_chat_contact(**kwargs)
  1. See StartChatContactRequestRequestTypeDef

start_contact_evaluation#

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.

Type annotations and code completion for session.create_client("connect").start_contact_evaluation method. boto3 documentation

# start_contact_evaluation method definition

await def start_contact_evaluation(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    EvaluationFormId: str,
    ClientToken: str = ...,
) -> StartContactEvaluationResponseTypeDef:  # (1)
    ...
  1. See StartContactEvaluationResponseTypeDef
# start_contact_evaluation method usage example with argument unpacking

kwargs: StartContactEvaluationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "EvaluationFormId": ...,
}

parent.start_contact_evaluation(**kwargs)
  1. See StartContactEvaluationRequestRequestTypeDef

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.create_client("connect").start_contact_recording method. boto3 documentation

# start_contact_recording method definition

await def start_contact_recording(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,
    VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See VoiceRecordingConfigurationTypeDef
# start_contact_recording method usage example with argument unpacking

kwargs: StartContactRecordingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "InitialContactId": ...,
    "VoiceRecordingConfiguration": ...,
}

parent.start_contact_recording(**kwargs)
  1. See StartContactRecordingRequestRequestTypeDef

start_contact_streaming#

Initiates real-time message streaming for a new chat contact.

Type annotations and code completion for session.create_client("connect").start_contact_streaming method. boto3 documentation

# start_contact_streaming method definition

await def start_contact_streaming(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef,  # (1)
    ClientToken: str,
) -> StartContactStreamingResponseTypeDef:  # (2)
    ...
  1. See ChatStreamingConfigurationTypeDef
  2. See StartContactStreamingResponseTypeDef
# start_contact_streaming method usage example with argument unpacking

kwargs: StartContactStreamingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ChatStreamingConfiguration": ...,
    "ClientToken": ...,
}

parent.start_contact_streaming(**kwargs)
  1. See StartContactStreamingRequestRequestTypeDef

start_outbound_voice_contact#

Places an outbound call to a contact, and then initiates the flow.

Type annotations and code completion for session.create_client("connect").start_outbound_voice_contact method. boto3 documentation

# start_outbound_voice_contact method definition

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)
    ...
  1. See AnswerMachineDetectionConfigTypeDef
  2. See TrafficTypeType
  3. See StartOutboundVoiceContactResponseTypeDef
# start_outbound_voice_contact method usage example with argument unpacking

kwargs: StartOutboundVoiceContactRequestRequestTypeDef = {  # (1)
    "DestinationPhoneNumber": ...,
    "ContactFlowId": ...,
    "InstanceId": ...,
}

parent.start_outbound_voice_contact(**kwargs)
  1. See StartOutboundVoiceContactRequestRequestTypeDef

start_task_contact#

Initiates a flow to start a new task.

Type annotations and code completion for session.create_client("connect").start_task_contact method. boto3 documentation

# start_task_contact method definition

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 = ...,
    RelatedContactId: str = ...,
) -> StartTaskContactResponseTypeDef:  # (2)
    ...
  1. See ReferenceTypeDef
  2. See StartTaskContactResponseTypeDef
# start_task_contact method usage example with argument unpacking

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

parent.start_task_contact(**kwargs)
  1. See StartTaskContactRequestRequestTypeDef

stop_contact#

Ends the specified contact.

Type annotations and code completion for session.create_client("connect").stop_contact method. boto3 documentation

# stop_contact method definition

await def stop_contact(
    self,
    *,
    ContactId: str,
    InstanceId: str,
) -> Dict[str, Any]:
    ...
# stop_contact method usage example with argument unpacking

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

parent.stop_contact(**kwargs)
  1. See StopContactRequestRequestTypeDef

stop_contact_recording#

Stops recording a call when a contact is being recorded.

Type annotations and code completion for session.create_client("connect").stop_contact_recording method. boto3 documentation

# stop_contact_recording method definition

await def stop_contact_recording(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,
) -> Dict[str, Any]:
    ...
# stop_contact_recording method usage example with argument unpacking

kwargs: StopContactRecordingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "InitialContactId": ...,
}

parent.stop_contact_recording(**kwargs)
  1. See StopContactRecordingRequestRequestTypeDef

stop_contact_streaming#

Ends message streaming on a specified contact.

Type annotations and code completion for session.create_client("connect").stop_contact_streaming method. boto3 documentation

# stop_contact_streaming method definition

await def stop_contact_streaming(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    StreamingId: str,
) -> Dict[str, Any]:
    ...
# stop_contact_streaming method usage example with argument unpacking

kwargs: StopContactStreamingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "StreamingId": ...,
}

parent.stop_contact_streaming(**kwargs)
  1. See StopContactStreamingRequestRequestTypeDef

submit_contact_evaluation#

Submits a contact evaluation in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").submit_contact_evaluation method. boto3 documentation

# submit_contact_evaluation method definition

await def submit_contact_evaluation(
    self,
    *,
    InstanceId: str,
    EvaluationId: str,
    Answers: Mapping[str, EvaluationAnswerInputTypeDef] = ...,  # (1)
    Notes: Mapping[str, EvaluationNoteTypeDef] = ...,  # (2)
) -> SubmitContactEvaluationResponseTypeDef:  # (3)
    ...
  1. See EvaluationAnswerInputTypeDef
  2. See EvaluationNoteTypeDef
  3. See SubmitContactEvaluationResponseTypeDef
# submit_contact_evaluation method usage example with argument unpacking

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

parent.submit_contact_evaluation(**kwargs)
  1. See SubmitContactEvaluationRequestRequestTypeDef

suspend_contact_recording#

When a contact is being recorded, this API suspends recording the call or screen.

Type annotations and code completion for session.create_client("connect").suspend_contact_recording method. boto3 documentation

# suspend_contact_recording method definition

await def suspend_contact_recording(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    InitialContactId: str,
) -> Dict[str, Any]:
    ...
# suspend_contact_recording method usage example with argument unpacking

kwargs: SuspendContactRecordingRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "InitialContactId": ...,
}

parent.suspend_contact_recording(**kwargs)
  1. See SuspendContactRecordingRequestRequestTypeDef

tag_resource#

Adds the specified tags to the specified resource.

Type annotations and code completion for session.create_client("connect").tag_resource method. boto3 documentation

# tag_resource method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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.create_client("connect").transfer_contact method. boto3 documentation

# transfer_contact method definition

await def transfer_contact(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ContactFlowId: str,
    QueueId: str = ...,
    UserId: str = ...,
    ClientToken: str = ...,
) -> TransferContactResponseTypeDef:  # (1)
    ...
  1. See TransferContactResponseTypeDef
# transfer_contact method usage example with argument unpacking

kwargs: TransferContactRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ContactFlowId": ...,
}

parent.transfer_contact(**kwargs)
  1. See TransferContactRequestRequestTypeDef

untag_resource#

Removes the specified tags from the specified resource.

Type annotations and code completion for session.create_client("connect").untag_resource method. boto3 documentation

# untag_resource method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_agent_status#

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

Type annotations and code completion for session.create_client("connect").update_agent_status method. boto3 documentation

# update_agent_status method definition

await def update_agent_status(
    self,
    *,
    InstanceId: str,
    AgentStatusId: str,
    Name: str = ...,
    Description: str = ...,
    State: AgentStatusStateType = ...,  # (1)
    DisplayOrder: int = ...,
    ResetOrderNumber: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AgentStatusStateType
  2. See EmptyResponseMetadataTypeDef
# update_agent_status method usage example with argument unpacking

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

parent.update_agent_status(**kwargs)
  1. See UpdateAgentStatusRequestRequestTypeDef

update_contact#

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

Type annotations and code completion for session.create_client("connect").update_contact method. boto3 documentation

# update_contact method definition

await def update_contact(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    Name: str = ...,
    Description: str = ...,
    References: Mapping[str, ReferenceTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ReferenceTypeDef
# update_contact method usage example with argument unpacking

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

parent.update_contact(**kwargs)
  1. See UpdateContactRequestRequestTypeDef

update_contact_attributes#

Creates or updates user-defined contact attributes associated with the specified contact.

Type annotations and code completion for session.create_client("connect").update_contact_attributes method. boto3 documentation

# update_contact_attributes method definition

await def update_contact_attributes(
    self,
    *,
    InitialContactId: str,
    InstanceId: str,
    Attributes: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# update_contact_attributes method usage example with argument unpacking

kwargs: UpdateContactAttributesRequestRequestTypeDef = {  # (1)
    "InitialContactId": ...,
    "InstanceId": ...,
    "Attributes": ...,
}

parent.update_contact_attributes(**kwargs)
  1. See UpdateContactAttributesRequestRequestTypeDef

update_contact_evaluation#

Updates details about a contact evaluation in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").update_contact_evaluation method. boto3 documentation

# update_contact_evaluation method definition

await def update_contact_evaluation(
    self,
    *,
    InstanceId: str,
    EvaluationId: str,
    Answers: Mapping[str, EvaluationAnswerInputTypeDef] = ...,  # (1)
    Notes: Mapping[str, EvaluationNoteTypeDef] = ...,  # (2)
) -> UpdateContactEvaluationResponseTypeDef:  # (3)
    ...
  1. See EvaluationAnswerInputTypeDef
  2. See EvaluationNoteTypeDef
  3. See UpdateContactEvaluationResponseTypeDef
# update_contact_evaluation method usage example with argument unpacking

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

parent.update_contact_evaluation(**kwargs)
  1. See UpdateContactEvaluationRequestRequestTypeDef

update_contact_flow_content#

Updates the specified flow.

Type annotations and code completion for session.create_client("connect").update_contact_flow_content method. boto3 documentation

# update_contact_flow_content method definition

await def update_contact_flow_content(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
    Content: str,
) -> Dict[str, Any]:
    ...
# update_contact_flow_content method usage example with argument unpacking

kwargs: UpdateContactFlowContentRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowId": ...,
    "Content": ...,
}

parent.update_contact_flow_content(**kwargs)
  1. See UpdateContactFlowContentRequestRequestTypeDef

update_contact_flow_metadata#

Updates metadata about specified flow.

Type annotations and code completion for session.create_client("connect").update_contact_flow_metadata method. boto3 documentation

# update_contact_flow_metadata method definition

await def update_contact_flow_metadata(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
    Name: str = ...,
    Description: str = ...,
    ContactFlowState: ContactFlowStateType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ContactFlowStateType
# update_contact_flow_metadata method usage example with argument unpacking

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

parent.update_contact_flow_metadata(**kwargs)
  1. See UpdateContactFlowMetadataRequestRequestTypeDef

update_contact_flow_module_content#

Updates specified flow module for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").update_contact_flow_module_content method. boto3 documentation

# update_contact_flow_module_content method definition

await def update_contact_flow_module_content(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
    Content: str,
) -> Dict[str, Any]:
    ...
# update_contact_flow_module_content method usage example with argument unpacking

kwargs: UpdateContactFlowModuleContentRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactFlowModuleId": ...,
    "Content": ...,
}

parent.update_contact_flow_module_content(**kwargs)
  1. See UpdateContactFlowModuleContentRequestRequestTypeDef

update_contact_flow_module_metadata#

Updates metadata about specified flow module.

Type annotations and code completion for session.create_client("connect").update_contact_flow_module_metadata method. boto3 documentation

# update_contact_flow_module_metadata method definition

await def update_contact_flow_module_metadata(
    self,
    *,
    InstanceId: str,
    ContactFlowModuleId: str,
    Name: str = ...,
    Description: str = ...,
    State: ContactFlowModuleStateType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ContactFlowModuleStateType
# update_contact_flow_module_metadata method usage example with argument unpacking

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

parent.update_contact_flow_module_metadata(**kwargs)
  1. See UpdateContactFlowModuleMetadataRequestRequestTypeDef

update_contact_flow_name#

The name of the flow.

Type annotations and code completion for session.create_client("connect").update_contact_flow_name method. boto3 documentation

# update_contact_flow_name method definition

await def update_contact_flow_name(
    self,
    *,
    InstanceId: str,
    ContactFlowId: str,
    Name: str = ...,
    Description: str = ...,
) -> Dict[str, Any]:
    ...
# update_contact_flow_name method usage example with argument unpacking

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

parent.update_contact_flow_name(**kwargs)
  1. See UpdateContactFlowNameRequestRequestTypeDef

update_contact_schedule#

Updates the scheduled time of a task contact that is already scheduled.

Type annotations and code completion for session.create_client("connect").update_contact_schedule method. boto3 documentation

# update_contact_schedule method definition

await def update_contact_schedule(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ScheduledTime: Union[datetime, str],
) -> Dict[str, Any]:
    ...
# update_contact_schedule method usage example with argument unpacking

kwargs: UpdateContactScheduleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ScheduledTime": ...,
}

parent.update_contact_schedule(**kwargs)
  1. See UpdateContactScheduleRequestRequestTypeDef

update_evaluation_form#

Updates details about a specific evaluation form version in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").update_evaluation_form method. boto3 documentation

# update_evaluation_form method definition

await def update_evaluation_form(
    self,
    *,
    InstanceId: str,
    EvaluationFormId: str,
    EvaluationFormVersion: int,
    Title: str,
    Items: Sequence[EvaluationFormItemTypeDef],  # (1)
    CreateNewVersion: bool = ...,
    Description: str = ...,
    ScoringStrategy: EvaluationFormScoringStrategyTypeDef = ...,  # (2)
    ClientToken: str = ...,
) -> UpdateEvaluationFormResponseTypeDef:  # (3)
    ...
  1. See EvaluationFormItemTypeDef
  2. See EvaluationFormScoringStrategyTypeDef
  3. See UpdateEvaluationFormResponseTypeDef
# update_evaluation_form method usage example with argument unpacking

kwargs: UpdateEvaluationFormRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "EvaluationFormId": ...,
    "EvaluationFormVersion": ...,
    "Title": ...,
    "Items": ...,
}

parent.update_evaluation_form(**kwargs)
  1. See UpdateEvaluationFormRequestRequestTypeDef

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.create_client("connect").update_hours_of_operation method. boto3 documentation

# update_hours_of_operation method definition

await def update_hours_of_operation(
    self,
    *,
    InstanceId: str,
    HoursOfOperationId: str,
    Name: str = ...,
    Description: str = ...,
    TimeZone: str = ...,
    Config: Sequence[HoursOfOperationConfigTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See HoursOfOperationConfigTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_hours_of_operation method usage example with argument unpacking

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

parent.update_hours_of_operation(**kwargs)
  1. See UpdateHoursOfOperationRequestRequestTypeDef

update_instance_attribute#

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

Type annotations and code completion for session.create_client("connect").update_instance_attribute method. boto3 documentation

# update_instance_attribute method definition

await def update_instance_attribute(
    self,
    *,
    InstanceId: str,
    AttributeType: InstanceAttributeTypeType,  # (1)
    Value: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See InstanceAttributeTypeType
  2. See EmptyResponseMetadataTypeDef
# update_instance_attribute method usage example with argument unpacking

kwargs: UpdateInstanceAttributeRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "AttributeType": ...,
    "Value": ...,
}

parent.update_instance_attribute(**kwargs)
  1. See UpdateInstanceAttributeRequestRequestTypeDef

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.create_client("connect").update_instance_storage_config method. boto3 documentation

# update_instance_storage_config method definition

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

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

parent.update_instance_storage_config(**kwargs)
  1. See UpdateInstanceStorageConfigRequestRequestTypeDef

update_participant_role_config#

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.

Type annotations and code completion for session.create_client("connect").update_participant_role_config method. boto3 documentation

# update_participant_role_config method definition

await def update_participant_role_config(
    self,
    *,
    InstanceId: str,
    ContactId: str,
    ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See UpdateParticipantRoleConfigChannelInfoTypeDef
# update_participant_role_config method usage example with argument unpacking

kwargs: UpdateParticipantRoleConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "ContactId": ...,
    "ChannelConfiguration": ...,
}

parent.update_participant_role_config(**kwargs)
  1. See UpdateParticipantRoleConfigRequestRequestTypeDef

update_phone_number#

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

Type annotations and code completion for session.create_client("connect").update_phone_number method. boto3 documentation

# update_phone_number method definition

await def update_phone_number(
    self,
    *,
    PhoneNumberId: str,
    TargetArn: str,
    ClientToken: str = ...,
) -> UpdatePhoneNumberResponseTypeDef:  # (1)
    ...
  1. See UpdatePhoneNumberResponseTypeDef
# update_phone_number method usage example with argument unpacking

kwargs: UpdatePhoneNumberRequestRequestTypeDef = {  # (1)
    "PhoneNumberId": ...,
    "TargetArn": ...,
}

parent.update_phone_number(**kwargs)
  1. See UpdatePhoneNumberRequestRequestTypeDef

update_prompt#

Updates a prompt.

Type annotations and code completion for session.create_client("connect").update_prompt method. boto3 documentation

# update_prompt method definition

await def update_prompt(
    self,
    *,
    InstanceId: str,
    PromptId: str,
    Name: str = ...,
    Description: str = ...,
    S3Uri: str = ...,
) -> UpdatePromptResponseTypeDef:  # (1)
    ...
  1. See UpdatePromptResponseTypeDef
# update_prompt method usage example with argument unpacking

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

parent.update_prompt(**kwargs)
  1. See UpdatePromptRequestRequestTypeDef

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.create_client("connect").update_queue_hours_of_operation method. boto3 documentation

# update_queue_hours_of_operation method definition

await def update_queue_hours_of_operation(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_queue_hours_of_operation method usage example with argument unpacking

kwargs: UpdateQueueHoursOfOperationRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QueueId": ...,
    "HoursOfOperationId": ...,
}

parent.update_queue_hours_of_operation(**kwargs)
  1. See UpdateQueueHoursOfOperationRequestRequestTypeDef

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.create_client("connect").update_queue_max_contacts method. boto3 documentation

# update_queue_max_contacts method definition

await def update_queue_max_contacts(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    MaxContacts: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_queue_max_contacts method usage example with argument unpacking

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

parent.update_queue_max_contacts(**kwargs)
  1. See UpdateQueueMaxContactsRequestRequestTypeDef

update_queue_name#

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

Type annotations and code completion for session.create_client("connect").update_queue_name method. boto3 documentation

# update_queue_name method definition

await def update_queue_name(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    Name: str = ...,
    Description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_queue_name method usage example with argument unpacking

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

parent.update_queue_name(**kwargs)
  1. See UpdateQueueNameRequestRequestTypeDef

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.create_client("connect").update_queue_outbound_caller_config method. boto3 documentation

# update_queue_outbound_caller_config method definition

await def update_queue_outbound_caller_config(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    OutboundCallerConfig: OutboundCallerConfigTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See OutboundCallerConfigTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_queue_outbound_caller_config method usage example with argument unpacking

kwargs: UpdateQueueOutboundCallerConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QueueId": ...,
    "OutboundCallerConfig": ...,
}

parent.update_queue_outbound_caller_config(**kwargs)
  1. See UpdateQueueOutboundCallerConfigRequestRequestTypeDef

update_queue_status#

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

Type annotations and code completion for session.create_client("connect").update_queue_status method. boto3 documentation

# update_queue_status method definition

await def update_queue_status(
    self,
    *,
    InstanceId: str,
    QueueId: str,
    Status: QueueStatusType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See QueueStatusType
  2. See EmptyResponseMetadataTypeDef
# update_queue_status method usage example with argument unpacking

kwargs: UpdateQueueStatusRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QueueId": ...,
    "Status": ...,
}

parent.update_queue_status(**kwargs)
  1. See UpdateQueueStatusRequestRequestTypeDef

update_quick_connect_config#

Updates the configuration settings for the specified quick connect.

Type annotations and code completion for session.create_client("connect").update_quick_connect_config method. boto3 documentation

# update_quick_connect_config method definition

await def update_quick_connect_config(
    self,
    *,
    InstanceId: str,
    QuickConnectId: str,
    QuickConnectConfig: QuickConnectConfigTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See QuickConnectConfigTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_quick_connect_config method usage example with argument unpacking

kwargs: UpdateQuickConnectConfigRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "QuickConnectId": ...,
    "QuickConnectConfig": ...,
}

parent.update_quick_connect_config(**kwargs)
  1. See UpdateQuickConnectConfigRequestRequestTypeDef

update_quick_connect_name#

Updates the name and description of a quick connect.

Type annotations and code completion for session.create_client("connect").update_quick_connect_name method. boto3 documentation

# update_quick_connect_name method definition

await def update_quick_connect_name(
    self,
    *,
    InstanceId: str,
    QuickConnectId: str,
    Name: str = ...,
    Description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_quick_connect_name method usage example with argument unpacking

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

parent.update_quick_connect_name(**kwargs)
  1. See UpdateQuickConnectNameRequestRequestTypeDef

update_routing_profile_agent_availability_timer#

Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

Type annotations and code completion for session.create_client("connect").update_routing_profile_agent_availability_timer method. boto3 documentation

# update_routing_profile_agent_availability_timer method definition

await def update_routing_profile_agent_availability_timer(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    AgentAvailabilityTimer: AgentAvailabilityTimerType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AgentAvailabilityTimerType
  2. See EmptyResponseMetadataTypeDef
# update_routing_profile_agent_availability_timer method usage example with argument unpacking

kwargs: UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "RoutingProfileId": ...,
    "AgentAvailabilityTimer": ...,
}

parent.update_routing_profile_agent_availability_timer(**kwargs)
  1. See UpdateRoutingProfileAgentAvailabilityTimerRequestRequestTypeDef

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.create_client("connect").update_routing_profile_concurrency method. boto3 documentation

# update_routing_profile_concurrency method definition

await def update_routing_profile_concurrency(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    MediaConcurrencies: Sequence[MediaConcurrencyTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See MediaConcurrencyTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_routing_profile_concurrency method usage example with argument unpacking

kwargs: UpdateRoutingProfileConcurrencyRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "RoutingProfileId": ...,
    "MediaConcurrencies": ...,
}

parent.update_routing_profile_concurrency(**kwargs)
  1. See UpdateRoutingProfileConcurrencyRequestRequestTypeDef

update_routing_profile_default_outbound_queue#

Updates the default outbound queue of a routing profile.

Type annotations and code completion for session.create_client("connect").update_routing_profile_default_outbound_queue method. boto3 documentation

# update_routing_profile_default_outbound_queue method definition

await def update_routing_profile_default_outbound_queue(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    DefaultOutboundQueueId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_routing_profile_default_outbound_queue method usage example with argument unpacking

kwargs: UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "RoutingProfileId": ...,
    "DefaultOutboundQueueId": ...,
}

parent.update_routing_profile_default_outbound_queue(**kwargs)
  1. See UpdateRoutingProfileDefaultOutboundQueueRequestRequestTypeDef

update_routing_profile_name#

Updates the name and description of a routing profile.

Type annotations and code completion for session.create_client("connect").update_routing_profile_name method. boto3 documentation

# update_routing_profile_name method definition

await def update_routing_profile_name(
    self,
    *,
    InstanceId: str,
    RoutingProfileId: str,
    Name: str = ...,
    Description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_routing_profile_name method usage example with argument unpacking

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

parent.update_routing_profile_name(**kwargs)
  1. See UpdateRoutingProfileNameRequestRequestTypeDef

update_routing_profile_queues#

Updates the properties associated with a set of queues for a routing profile.

Type annotations and code completion for session.create_client("connect").update_routing_profile_queues method. boto3 documentation

# update_routing_profile_queues method definition

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

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

parent.update_routing_profile_queues(**kwargs)
  1. See UpdateRoutingProfileQueuesRequestRequestTypeDef

update_rule#

Updates a rule for the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").update_rule method. boto3 documentation

# update_rule method definition

await def update_rule(
    self,
    *,
    RuleId: str,
    InstanceId: str,
    Name: str,
    Function: str,
    Actions: Sequence[RuleActionTypeDef],  # (1)
    PublishStatus: RulePublishStatusType,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See RuleActionTypeDef
  2. See RulePublishStatusType
  3. See EmptyResponseMetadataTypeDef
# update_rule method usage example with argument unpacking

kwargs: UpdateRuleRequestRequestTypeDef = {  # (1)
    "RuleId": ...,
    "InstanceId": ...,
    "Name": ...,
    "Function": ...,
    "Actions": ...,
    "PublishStatus": ...,
}

parent.update_rule(**kwargs)
  1. See UpdateRuleRequestRequestTypeDef

update_security_profile#

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

Type annotations and code completion for session.create_client("connect").update_security_profile method. boto3 documentation

# update_security_profile method definition

await def update_security_profile(
    self,
    *,
    SecurityProfileId: str,
    InstanceId: str,
    Description: str = ...,
    Permissions: Sequence[str] = ...,
    AllowedAccessControlTags: Mapping[str, str] = ...,
    TagRestrictedResources: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_security_profile method usage example with argument unpacking

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

parent.update_security_profile(**kwargs)
  1. See UpdateSecurityProfileRequestRequestTypeDef

update_task_template#

Updates details about a specific task template in the specified Amazon Connect instance.

Type annotations and code completion for session.create_client("connect").update_task_template method. boto3 documentation

# update_task_template method definition

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)
    ...
  1. See TaskTemplateConstraintsTypeDef
  2. See TaskTemplateDefaultsTypeDef
  3. See TaskTemplateStatusType
  4. See TaskTemplateFieldTypeDef
  5. See UpdateTaskTemplateResponseTypeDef
# update_task_template method usage example with argument unpacking

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

parent.update_task_template(**kwargs)
  1. See UpdateTaskTemplateRequestRequestTypeDef

update_traffic_distribution#

Updates the traffic distribution for a given traffic distribution group.

Type annotations and code completion for session.create_client("connect").update_traffic_distribution method. boto3 documentation

# update_traffic_distribution method definition

await def update_traffic_distribution(
    self,
    *,
    Id: str,
    TelephonyConfig: TelephonyConfigTypeDef = ...,  # (1)
    SignInConfig: SignInConfigTypeDef = ...,  # (2)
    AgentConfig: AgentConfigTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See TelephonyConfigTypeDef
  2. See SignInConfigTypeDef
  3. See AgentConfigTypeDef
# update_traffic_distribution method usage example with argument unpacking

kwargs: UpdateTrafficDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_traffic_distribution(**kwargs)
  1. See UpdateTrafficDistributionRequestRequestTypeDef

update_user_hierarchy#

Assigns the specified hierarchy group to the specified user.

Type annotations and code completion for session.create_client("connect").update_user_hierarchy method. boto3 documentation

# update_user_hierarchy method definition

await def update_user_hierarchy(
    self,
    *,
    UserId: str,
    InstanceId: str,
    HierarchyGroupId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_user_hierarchy method usage example with argument unpacking

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

parent.update_user_hierarchy(**kwargs)
  1. See UpdateUserHierarchyRequestRequestTypeDef

update_user_hierarchy_group_name#

Updates the name of the user hierarchy group.

Type annotations and code completion for session.create_client("connect").update_user_hierarchy_group_name method. boto3 documentation

# update_user_hierarchy_group_name method definition

await def update_user_hierarchy_group_name(
    self,
    *,
    Name: str,
    HierarchyGroupId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_user_hierarchy_group_name method usage example with argument unpacking

kwargs: UpdateUserHierarchyGroupNameRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "HierarchyGroupId": ...,
    "InstanceId": ...,
}

parent.update_user_hierarchy_group_name(**kwargs)
  1. See UpdateUserHierarchyGroupNameRequestRequestTypeDef

update_user_hierarchy_structure#

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Type annotations and code completion for session.create_client("connect").update_user_hierarchy_structure method. boto3 documentation

# update_user_hierarchy_structure method definition

await def update_user_hierarchy_structure(
    self,
    *,
    HierarchyStructure: HierarchyStructureUpdateTypeDef,  # (1)
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See HierarchyStructureUpdateTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_user_hierarchy_structure method usage example with argument unpacking

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

parent.update_user_hierarchy_structure(**kwargs)
  1. See UpdateUserHierarchyStructureRequestRequestTypeDef

update_user_identity_info#

Updates the identity information for the specified user.

Type annotations and code completion for session.create_client("connect").update_user_identity_info method. boto3 documentation

# update_user_identity_info method definition

await def update_user_identity_info(
    self,
    *,
    IdentityInfo: UserIdentityInfoTypeDef,  # (1)
    UserId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See UserIdentityInfoTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_user_identity_info method usage example with argument unpacking

kwargs: UpdateUserIdentityInfoRequestRequestTypeDef = {  # (1)
    "IdentityInfo": ...,
    "UserId": ...,
    "InstanceId": ...,
}

parent.update_user_identity_info(**kwargs)
  1. See UpdateUserIdentityInfoRequestRequestTypeDef

update_user_phone_config#

Updates the phone configuration settings for the specified user.

Type annotations and code completion for session.create_client("connect").update_user_phone_config method. boto3 documentation

# update_user_phone_config method definition

await def update_user_phone_config(
    self,
    *,
    PhoneConfig: UserPhoneConfigTypeDef,  # (1)
    UserId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See UserPhoneConfigTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_user_phone_config method usage example with argument unpacking

kwargs: UpdateUserPhoneConfigRequestRequestTypeDef = {  # (1)
    "PhoneConfig": ...,
    "UserId": ...,
    "InstanceId": ...,
}

parent.update_user_phone_config(**kwargs)
  1. See UpdateUserPhoneConfigRequestRequestTypeDef

update_user_routing_profile#

Assigns the specified routing profile to the specified user.

Type annotations and code completion for session.create_client("connect").update_user_routing_profile method. boto3 documentation

# update_user_routing_profile method definition

await def update_user_routing_profile(
    self,
    *,
    RoutingProfileId: str,
    UserId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_user_routing_profile method usage example with argument unpacking

kwargs: UpdateUserRoutingProfileRequestRequestTypeDef = {  # (1)
    "RoutingProfileId": ...,
    "UserId": ...,
    "InstanceId": ...,
}

parent.update_user_routing_profile(**kwargs)
  1. See UpdateUserRoutingProfileRequestRequestTypeDef

update_user_security_profiles#

Assigns the specified security profiles to the specified user.

Type annotations and code completion for session.create_client("connect").update_user_security_profiles method. boto3 documentation

# update_user_security_profiles method definition

await def update_user_security_profiles(
    self,
    *,
    SecurityProfileIds: Sequence[str],
    UserId: str,
    InstanceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_user_security_profiles method usage example with argument unpacking

kwargs: UpdateUserSecurityProfilesRequestRequestTypeDef = {  # (1)
    "SecurityProfileIds": ...,
    "UserId": ...,
    "InstanceId": ...,
}

parent.update_user_security_profiles(**kwargs)
  1. See UpdateUserSecurityProfilesRequestRequestTypeDef

__aenter__#

Type annotations and code completion for session.create_client("connect").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> ConnectClient:
    ...

__aexit__#

Type annotations and code completion for session.create_client("connect").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator#

Type annotations and code completion for session.create_client("connect").get_paginator method with overloads.