ConnectClient#
Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.
ConnectClient#
Type annotations and code completion for boto3.client("connect").
boto3 documentation
# ConnectClient usage example
from boto3.session import Session
from mypy_boto3_connect.client import ConnectClient
def get_connect_client() -> ConnectClient:
return Session().client("connect")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("connect").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("connect")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ContactFlowNotPublishedException,
client.exceptions.ContactNotFoundException,
client.exceptions.DestinationNotAllowedException,
client.exceptions.DuplicateResourceException,
client.exceptions.IdempotencyException,
client.exceptions.InternalServiceException,
client.exceptions.InvalidContactFlowException,
client.exceptions.InvalidContactFlowModuleException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.MaximumResultReturnedException,
client.exceptions.OutboundContactNotPermittedException,
client.exceptions.OutputTypeNotFoundException,
client.exceptions.PropertyValidationException,
client.exceptions.ResourceConflictException,
client.exceptions.ResourceInUseException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceNotReadyException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyRequestsException,
client.exceptions.UserNotFoundException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_connect.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
activate_evaluation_form#
Activates an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").activate_evaluation_form method.
boto3 documentation
# activate_evaluation_form method definition
def activate_evaluation_form(
self,
*,
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,
) -> ActivateEvaluationFormResponseTypeDef: # (1)
...# activate_evaluation_form method usage example with argument unpacking
kwargs: ActivateEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
"EvaluationFormVersion": ...,
}
parent.activate_evaluation_form(**kwargs)associate_analytics_data_set#
Associates the specified dataset for a Amazon Connect instance with the target account.
Type annotations and code completion for boto3.client("connect").associate_analytics_data_set method.
boto3 documentation
# associate_analytics_data_set method definition
def associate_analytics_data_set(
self,
*,
InstanceId: str,
DataSetId: str,
TargetAccountId: str = ...,
) -> AssociateAnalyticsDataSetResponseTypeDef: # (1)
...# associate_analytics_data_set method usage example with argument unpacking
kwargs: AssociateAnalyticsDataSetRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"DataSetId": ...,
}
parent.associate_analytics_data_set(**kwargs)associate_approved_origin#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_approved_origin method.
boto3 documentation
# associate_approved_origin method definition
def associate_approved_origin(
self,
*,
InstanceId: str,
Origin: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_approved_origin method usage example with argument unpacking
kwargs: AssociateApprovedOriginRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Origin": ...,
}
parent.associate_approved_origin(**kwargs)associate_bot#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_bot method.
boto3 documentation
# associate_bot method definition
def associate_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef = ..., # (1)
LexV2Bot: LexV2BotTypeDef = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...- See LexBotTypeDef
- See LexV2BotTypeDef
- See EmptyResponseMetadataTypeDef
# associate_bot method usage example with argument unpacking
kwargs: AssociateBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.associate_bot(**kwargs)associate_default_vocabulary#
Associates an existing vocabulary as the default.
Type annotations and code completion for boto3.client("connect").associate_default_vocabulary method.
boto3 documentation
# associate_default_vocabulary method definition
def associate_default_vocabulary(
self,
*,
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
VocabularyId: str = ...,
) -> Dict[str, Any]:
...# associate_default_vocabulary method usage example with argument unpacking
kwargs: AssociateDefaultVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LanguageCode": ...,
}
parent.associate_default_vocabulary(**kwargs)associate_flow#
Associates a connect resource to a flow.
Type annotations and code completion for boto3.client("connect").associate_flow method.
boto3 documentation
# associate_flow method definition
def associate_flow(
self,
*,
InstanceId: str,
ResourceId: str,
FlowId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)
) -> Dict[str, Any]:
...# associate_flow method usage example with argument unpacking
kwargs: AssociateFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceId": ...,
"FlowId": ...,
"ResourceType": ...,
}
parent.associate_flow(**kwargs)associate_instance_storage_config#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_instance_storage_config method.
boto3 documentation
# associate_instance_storage_config method definition
def associate_instance_storage_config(
self,
*,
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
) -> AssociateInstanceStorageConfigResponseTypeDef: # (3)
...- See InstanceStorageResourceTypeType
- See InstanceStorageConfigTypeDef
- See AssociateInstanceStorageConfigResponseTypeDef
# associate_instance_storage_config method usage example with argument unpacking
kwargs: AssociateInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceType": ...,
"StorageConfig": ...,
}
parent.associate_instance_storage_config(**kwargs)associate_lambda_function#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_lambda_function method.
boto3 documentation
# associate_lambda_function method definition
def associate_lambda_function(
self,
*,
InstanceId: str,
FunctionArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_lambda_function method usage example with argument unpacking
kwargs: AssociateLambdaFunctionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FunctionArn": ...,
}
parent.associate_lambda_function(**kwargs)associate_lex_bot#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_lex_bot method.
boto3 documentation
# associate_lex_bot method definition
def associate_lex_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# associate_lex_bot method usage example with argument unpacking
kwargs: AssociateLexBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LexBot": ...,
}
parent.associate_lex_bot(**kwargs)associate_phone_number_contact_flow#
Associates a flow with a phone number claimed to your Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").associate_phone_number_contact_flow method.
boto3 documentation
# associate_phone_number_contact_flow method definition
def associate_phone_number_contact_flow(
self,
*,
PhoneNumberId: str,
InstanceId: str,
ContactFlowId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_phone_number_contact_flow method usage example with argument unpacking
kwargs: AssociatePhoneNumberContactFlowRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.associate_phone_number_contact_flow(**kwargs)associate_queue_quick_connects#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_queue_quick_connects method.
boto3 documentation
# associate_queue_quick_connects method definition
def associate_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_queue_quick_connects method usage example with argument unpacking
kwargs: AssociateQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
parent.associate_queue_quick_connects(**kwargs)associate_routing_profile_queues#
Associates a set of queues with a routing profile.
Type annotations and code completion for boto3.client("connect").associate_routing_profile_queues method.
boto3 documentation
# associate_routing_profile_queues method definition
def associate_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# associate_routing_profile_queues method usage example with argument unpacking
kwargs: AssociateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
parent.associate_routing_profile_queues(**kwargs)associate_security_key#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").associate_security_key method.
boto3 documentation
# associate_security_key method definition
def associate_security_key(
self,
*,
InstanceId: str,
Key: str,
) -> AssociateSecurityKeyResponseTypeDef: # (1)
...# associate_security_key method usage example with argument unpacking
kwargs: AssociateSecurityKeyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Key": ...,
}
parent.associate_security_key(**kwargs)associate_traffic_distribution_group_user#
Associates an agent with a traffic distribution group.
Type annotations and code completion for boto3.client("connect").associate_traffic_distribution_group_user method.
boto3 documentation
# associate_traffic_distribution_group_user method definition
def associate_traffic_distribution_group_user(
self,
*,
TrafficDistributionGroupId: str,
UserId: str,
InstanceId: str,
) -> Dict[str, Any]:
...# associate_traffic_distribution_group_user method usage example with argument unpacking
kwargs: AssociateTrafficDistributionGroupUserRequestRequestTypeDef = { # (1)
"TrafficDistributionGroupId": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.associate_traffic_distribution_group_user(**kwargs)associate_user_proficiencies#
Associates a set of proficiencies with a user.
Type annotations and code completion for boto3.client("connect").associate_user_proficiencies method.
boto3 documentation
# associate_user_proficiencies method definition
def associate_user_proficiencies(
self,
*,
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# associate_user_proficiencies method usage example with argument unpacking
kwargs: AssociateUserProficienciesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
"UserProficiencies": ...,
}
parent.associate_user_proficiencies(**kwargs)batch_associate_analytics_data_set#
Associates a list of analytics datasets for a given Amazon Connect instance to a target account.
Type annotations and code completion for boto3.client("connect").batch_associate_analytics_data_set method.
boto3 documentation
# batch_associate_analytics_data_set method definition
def batch_associate_analytics_data_set(
self,
*,
InstanceId: str,
DataSetIds: Sequence[str],
TargetAccountId: str = ...,
) -> BatchAssociateAnalyticsDataSetResponseTypeDef: # (1)
...# batch_associate_analytics_data_set method usage example with argument unpacking
kwargs: BatchAssociateAnalyticsDataSetRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"DataSetIds": ...,
}
parent.batch_associate_analytics_data_set(**kwargs)batch_disassociate_analytics_data_set#
Removes a list of analytics datasets associated with a given Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").batch_disassociate_analytics_data_set method.
boto3 documentation
# batch_disassociate_analytics_data_set method definition
def batch_disassociate_analytics_data_set(
self,
*,
InstanceId: str,
DataSetIds: Sequence[str],
TargetAccountId: str = ...,
) -> BatchDisassociateAnalyticsDataSetResponseTypeDef: # (1)
...# batch_disassociate_analytics_data_set method usage example with argument unpacking
kwargs: BatchDisassociateAnalyticsDataSetRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"DataSetIds": ...,
}
parent.batch_disassociate_analytics_data_set(**kwargs)batch_get_attached_file_metadata#
Allows you to retrieve metadata about multiple attached files on an associated resource.
Type annotations and code completion for boto3.client("connect").batch_get_attached_file_metadata method.
boto3 documentation
# batch_get_attached_file_metadata method definition
def batch_get_attached_file_metadata(
self,
*,
FileIds: Sequence[str],
InstanceId: str,
AssociatedResourceArn: str,
) -> BatchGetAttachedFileMetadataResponseTypeDef: # (1)
...# batch_get_attached_file_metadata method usage example with argument unpacking
kwargs: BatchGetAttachedFileMetadataRequestRequestTypeDef = { # (1)
"FileIds": ...,
"InstanceId": ...,
"AssociatedResourceArn": ...,
}
parent.batch_get_attached_file_metadata(**kwargs)batch_get_flow_association#
Retrieve the flow associations for the given resources.
Type annotations and code completion for boto3.client("connect").batch_get_flow_association method.
boto3 documentation
# batch_get_flow_association method definition
def batch_get_flow_association(
self,
*,
InstanceId: str,
ResourceIds: Sequence[str],
ResourceType: ListFlowAssociationResourceTypeType = ..., # (1)
) -> BatchGetFlowAssociationResponseTypeDef: # (2)
...# batch_get_flow_association method usage example with argument unpacking
kwargs: BatchGetFlowAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceIds": ...,
}
parent.batch_get_flow_association(**kwargs)batch_put_contact#
.
Type annotations and code completion for boto3.client("connect").batch_put_contact method.
boto3 documentation
# batch_put_contact method definition
def batch_put_contact(
self,
*,
InstanceId: str,
ContactDataRequestList: Sequence[ContactDataRequestTypeDef], # (1)
ClientToken: str = ...,
) -> BatchPutContactResponseTypeDef: # (2)
...# batch_put_contact method usage example with argument unpacking
kwargs: BatchPutContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactDataRequestList": ...,
}
parent.batch_put_contact(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("connect").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...claim_phone_number#
Claims an available phone number to your Amazon Connect instance or traffic distribution group.
Type annotations and code completion for boto3.client("connect").claim_phone_number method.
boto3 documentation
# claim_phone_number method definition
def claim_phone_number(
self,
*,
PhoneNumber: str,
TargetArn: str = ...,
InstanceId: str = ...,
PhoneNumberDescription: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> ClaimPhoneNumberResponseTypeDef: # (1)
...# claim_phone_number method usage example with argument unpacking
kwargs: ClaimPhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumber": ...,
}
parent.claim_phone_number(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("connect").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...complete_attached_file_upload#
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
Type annotations and code completion for boto3.client("connect").complete_attached_file_upload method.
boto3 documentation
# complete_attached_file_upload method definition
def complete_attached_file_upload(
self,
*,
InstanceId: str,
FileId: str,
AssociatedResourceArn: str,
) -> Dict[str, Any]:
...# complete_attached_file_upload method usage example with argument unpacking
kwargs: CompleteAttachedFileUploadRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FileId": ...,
"AssociatedResourceArn": ...,
}
parent.complete_attached_file_upload(**kwargs)create_agent_status#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").create_agent_status method.
boto3 documentation
# create_agent_status method definition
def create_agent_status(
self,
*,
InstanceId: str,
Name: str,
State: AgentStatusStateType, # (1)
Description: str = ...,
DisplayOrder: int = ...,
Tags: Mapping[str, str] = ...,
) -> CreateAgentStatusResponseTypeDef: # (2)
...# create_agent_status method usage example with argument unpacking
kwargs: CreateAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"State": ...,
}
parent.create_agent_status(**kwargs)create_contact_flow#
Creates a flow for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_contact_flow method.
boto3 documentation
# create_contact_flow method definition
def create_contact_flow(
self,
*,
InstanceId: str,
Name: str,
Type: ContactFlowTypeType, # (1)
Content: str,
Description: str = ...,
Status: ContactFlowStatusType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateContactFlowResponseTypeDef: # (3)
...# create_contact_flow method usage example with argument unpacking
kwargs: CreateContactFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Type": ...,
"Content": ...,
}
parent.create_contact_flow(**kwargs)create_contact_flow_module#
Creates a flow module for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_contact_flow_module method.
boto3 documentation
# create_contact_flow_module method definition
def create_contact_flow_module(
self,
*,
InstanceId: str,
Name: str,
Content: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> CreateContactFlowModuleResponseTypeDef: # (1)
...# create_contact_flow_module method usage example with argument unpacking
kwargs: CreateContactFlowModuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Content": ...,
}
parent.create_contact_flow_module(**kwargs)create_contact_flow_version#
Publishes a new version of the flow provided.
Type annotations and code completion for boto3.client("connect").create_contact_flow_version method.
boto3 documentation
# create_contact_flow_version method definition
def create_contact_flow_version(
self,
*,
InstanceId: str,
ContactFlowId: str,
Description: str = ...,
FlowContentSha256: str = ...,
LastModifiedTime: TimestampTypeDef = ...,
LastModifiedRegion: str = ...,
) -> CreateContactFlowVersionResponseTypeDef: # (1)
...# create_contact_flow_version method usage example with argument unpacking
kwargs: CreateContactFlowVersionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.create_contact_flow_version(**kwargs)create_evaluation_form#
Creates an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_evaluation_form method.
boto3 documentation
# create_evaluation_form method definition
def create_evaluation_form(
self,
*,
InstanceId: str,
Title: str,
Items: Sequence[EvaluationFormItemUnionTypeDef], # (1)
Description: str = ...,
ScoringStrategy: EvaluationFormScoringStrategyTypeDef = ..., # (2)
ClientToken: str = ...,
) -> CreateEvaluationFormResponseTypeDef: # (3)
...- See EvaluationFormItemTypeDef EvaluationFormItemOutputTypeDef
- See EvaluationFormScoringStrategyTypeDef
- See CreateEvaluationFormResponseTypeDef
# create_evaluation_form method usage example with argument unpacking
kwargs: CreateEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Title": ...,
"Items": ...,
}
parent.create_evaluation_form(**kwargs)create_hours_of_operation#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").create_hours_of_operation method.
boto3 documentation
# create_hours_of_operation method definition
def create_hours_of_operation(
self,
*,
InstanceId: str,
Name: str,
TimeZone: str,
Config: Sequence[HoursOfOperationConfigTypeDef], # (1)
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateHoursOfOperationResponseTypeDef: # (2)
...# create_hours_of_operation method usage example with argument unpacking
kwargs: CreateHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"TimeZone": ...,
"Config": ...,
}
parent.create_hours_of_operation(**kwargs)create_instance#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").create_instance method.
boto3 documentation
# create_instance method definition
def create_instance(
self,
*,
IdentityManagementType: DirectoryTypeType, # (1)
InboundCallsEnabled: bool,
OutboundCallsEnabled: bool,
ClientToken: str = ...,
InstanceAlias: str = ...,
DirectoryId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateInstanceResponseTypeDef: # (2)
...# create_instance method usage example with argument unpacking
kwargs: CreateInstanceRequestRequestTypeDef = { # (1)
"IdentityManagementType": ...,
"InboundCallsEnabled": ...,
"OutboundCallsEnabled": ...,
}
parent.create_instance(**kwargs)create_integration_association#
Creates an Amazon Web Services resource association with an Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_integration_association method.
boto3 documentation
# create_integration_association method definition
def create_integration_association(
self,
*,
InstanceId: str,
IntegrationType: IntegrationTypeType, # (1)
IntegrationArn: str,
SourceApplicationUrl: str = ...,
SourceApplicationName: str = ...,
SourceType: SourceTypeType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateIntegrationAssociationResponseTypeDef: # (3)
...# create_integration_association method usage example with argument unpacking
kwargs: CreateIntegrationAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationType": ...,
"IntegrationArn": ...,
}
parent.create_integration_association(**kwargs)create_participant#
Adds a new participant into an on-going chat contact.
Type annotations and code completion for boto3.client("connect").create_participant method.
boto3 documentation
# create_participant method definition
def create_participant(
self,
*,
InstanceId: str,
ContactId: str,
ParticipantDetails: ParticipantDetailsToAddTypeDef, # (1)
ClientToken: str = ...,
) -> CreateParticipantResponseTypeDef: # (2)
...# create_participant method usage example with argument unpacking
kwargs: CreateParticipantRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ParticipantDetails": ...,
}
parent.create_participant(**kwargs)create_persistent_contact_association#
Enables rehydration of chats for the lifespan of a contact.
Type annotations and code completion for boto3.client("connect").create_persistent_contact_association method.
boto3 documentation
# create_persistent_contact_association method definition
def create_persistent_contact_association(
self,
*,
InstanceId: str,
InitialContactId: str,
RehydrationType: RehydrationTypeType, # (1)
SourceContactId: str,
ClientToken: str = ...,
) -> CreatePersistentContactAssociationResponseTypeDef: # (2)
...# create_persistent_contact_association method usage example with argument unpacking
kwargs: CreatePersistentContactAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"InitialContactId": ...,
"RehydrationType": ...,
"SourceContactId": ...,
}
parent.create_persistent_contact_association(**kwargs)create_predefined_attribute#
Creates a new predefined attribute for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_predefined_attribute method.
boto3 documentation
# create_predefined_attribute method definition
def create_predefined_attribute(
self,
*,
InstanceId: str,
Name: str,
Values: PredefinedAttributeValuesTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# create_predefined_attribute method usage example with argument unpacking
kwargs: CreatePredefinedAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Values": ...,
}
parent.create_predefined_attribute(**kwargs)create_prompt#
Creates a prompt.
Type annotations and code completion for boto3.client("connect").create_prompt method.
boto3 documentation
# create_prompt method definition
def create_prompt(
self,
*,
InstanceId: str,
Name: str,
S3Uri: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreatePromptResponseTypeDef: # (1)
...# create_prompt method usage example with argument unpacking
kwargs: CreatePromptRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"S3Uri": ...,
}
parent.create_prompt(**kwargs)create_queue#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").create_queue method.
boto3 documentation
# create_queue method definition
def create_queue(
self,
*,
InstanceId: str,
Name: str,
HoursOfOperationId: str,
Description: str = ...,
OutboundCallerConfig: OutboundCallerConfigTypeDef = ..., # (1)
MaxContacts: int = ...,
QuickConnectIds: Sequence[str] = ...,
Tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef: # (2)
...# create_queue method usage example with argument unpacking
kwargs: CreateQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"HoursOfOperationId": ...,
}
parent.create_queue(**kwargs)create_quick_connect#
Creates a quick connect for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_quick_connect method.
boto3 documentation
# create_quick_connect method definition
def create_quick_connect(
self,
*,
InstanceId: str,
Name: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateQuickConnectResponseTypeDef: # (2)
...# create_quick_connect method usage example with argument unpacking
kwargs: CreateQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"QuickConnectConfig": ...,
}
parent.create_quick_connect(**kwargs)create_routing_profile#
Creates a new routing profile.
Type annotations and code completion for boto3.client("connect").create_routing_profile method.
boto3 documentation
# create_routing_profile method definition
def create_routing_profile(
self,
*,
InstanceId: str,
Name: str,
Description: str,
DefaultOutboundQueueId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef] = ..., # (2)
Tags: Mapping[str, str] = ...,
AgentAvailabilityTimer: AgentAvailabilityTimerType = ..., # (3)
) -> CreateRoutingProfileResponseTypeDef: # (4)
...- See MediaConcurrencyTypeDef
- See RoutingProfileQueueConfigTypeDef
- See AgentAvailabilityTimerType
- See CreateRoutingProfileResponseTypeDef
# create_routing_profile method usage example with argument unpacking
kwargs: CreateRoutingProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Description": ...,
"DefaultOutboundQueueId": ...,
"MediaConcurrencies": ...,
}
parent.create_routing_profile(**kwargs)create_rule#
Creates a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_rule method.
boto3 documentation
# create_rule method definition
def create_rule(
self,
*,
InstanceId: str,
Name: str,
TriggerEventSource: RuleTriggerEventSourceTypeDef, # (1)
Function: str,
Actions: Sequence[RuleActionUnionTypeDef], # (2)
PublishStatus: RulePublishStatusType, # (3)
ClientToken: str = ...,
) -> CreateRuleResponseTypeDef: # (4)
...- See RuleTriggerEventSourceTypeDef
- See RuleActionTypeDef RuleActionOutputTypeDef
- See RulePublishStatusType
- See CreateRuleResponseTypeDef
# create_rule method usage example with argument unpacking
kwargs: CreateRuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"TriggerEventSource": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
}
parent.create_rule(**kwargs)create_security_profile#
Creates a security profile.
Type annotations and code completion for boto3.client("connect").create_security_profile method.
boto3 documentation
# create_security_profile method definition
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] = ...,
Applications: Sequence[ApplicationUnionTypeDef] = ..., # (1)
HierarchyRestrictedResources: Sequence[str] = ...,
AllowedAccessControlHierarchyGroupId: str = ...,
) -> CreateSecurityProfileResponseTypeDef: # (2)
...# create_security_profile method usage example with argument unpacking
kwargs: CreateSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileName": ...,
"InstanceId": ...,
}
parent.create_security_profile(**kwargs)create_task_template#
Creates a new task template in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_task_template method.
boto3 documentation
# create_task_template method definition
def create_task_template(
self,
*,
InstanceId: str,
Name: str,
Fields: Sequence[TaskTemplateFieldUnionTypeDef], # (1)
Description: str = ...,
ContactFlowId: str = ...,
Constraints: TaskTemplateConstraintsTypeDef = ..., # (2)
Defaults: TaskTemplateDefaultsTypeDef = ..., # (3)
Status: TaskTemplateStatusType = ..., # (4)
ClientToken: str = ...,
) -> CreateTaskTemplateResponseTypeDef: # (5)
...- See TaskTemplateFieldTypeDef TaskTemplateFieldOutputTypeDef
- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See CreateTaskTemplateResponseTypeDef
# create_task_template method usage example with argument unpacking
kwargs: CreateTaskTemplateRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
"Fields": ...,
}
parent.create_task_template(**kwargs)create_traffic_distribution_group#
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
Type annotations and code completion for boto3.client("connect").create_traffic_distribution_group method.
boto3 documentation
# create_traffic_distribution_group method definition
def create_traffic_distribution_group(
self,
*,
Name: str,
InstanceId: str,
Description: str = ...,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateTrafficDistributionGroupResponseTypeDef: # (1)
...# create_traffic_distribution_group method usage example with argument unpacking
kwargs: CreateTrafficDistributionGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceId": ...,
}
parent.create_traffic_distribution_group(**kwargs)create_use_case#
Creates a use case for an integration association.
Type annotations and code completion for boto3.client("connect").create_use_case method.
boto3 documentation
# create_use_case method definition
def create_use_case(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
UseCaseType: UseCaseTypeType, # (1)
Tags: Mapping[str, str] = ...,
) -> CreateUseCaseResponseTypeDef: # (2)
...# create_use_case method usage example with argument unpacking
kwargs: CreateUseCaseRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseType": ...,
}
parent.create_use_case(**kwargs)create_user#
Creates a user account for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_user method.
boto3 documentation
# create_user method definition
def create_user(
self,
*,
Username: str,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
SecurityProfileIds: Sequence[str],
RoutingProfileId: str,
InstanceId: str,
Password: str = ...,
IdentityInfo: UserIdentityInfoTypeDef = ..., # (2)
DirectoryUserId: str = ...,
HierarchyGroupId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateUserResponseTypeDef: # (3)
...# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"Username": ...,
"PhoneConfig": ...,
"SecurityProfileIds": ...,
"RoutingProfileId": ...,
"InstanceId": ...,
}
parent.create_user(**kwargs)create_user_hierarchy_group#
Creates a new user hierarchy group.
Type annotations and code completion for boto3.client("connect").create_user_hierarchy_group method.
boto3 documentation
# create_user_hierarchy_group method definition
def create_user_hierarchy_group(
self,
*,
Name: str,
InstanceId: str,
ParentGroupId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateUserHierarchyGroupResponseTypeDef: # (1)
...# create_user_hierarchy_group method usage example with argument unpacking
kwargs: CreateUserHierarchyGroupRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceId": ...,
}
parent.create_user_hierarchy_group(**kwargs)create_view#
Creates a new view with the possible status of SAVED or PUBLISHED.
Type annotations and code completion for boto3.client("connect").create_view method.
boto3 documentation
# create_view method definition
def create_view(
self,
*,
InstanceId: str,
Status: ViewStatusType, # (1)
Content: ViewInputContentTypeDef, # (2)
Name: str,
ClientToken: str = ...,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateViewResponseTypeDef: # (3)
...# create_view method usage example with argument unpacking
kwargs: CreateViewRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Status": ...,
"Content": ...,
"Name": ...,
}
parent.create_view(**kwargs)create_view_version#
Publishes a new version of the view identifier.
Type annotations and code completion for boto3.client("connect").create_view_version method.
boto3 documentation
# create_view_version method definition
def create_view_version(
self,
*,
InstanceId: str,
ViewId: str,
VersionDescription: str = ...,
ViewContentSha256: str = ...,
) -> CreateViewVersionResponseTypeDef: # (1)
...# create_view_version method usage example with argument unpacking
kwargs: CreateViewVersionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
}
parent.create_view_version(**kwargs)create_vocabulary#
Creates a custom vocabulary associated with your Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").create_vocabulary method.
boto3 documentation
# create_vocabulary method definition
def create_vocabulary(
self,
*,
InstanceId: str,
VocabularyName: str,
LanguageCode: VocabularyLanguageCodeType, # (1)
Content: str,
ClientToken: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateVocabularyResponseTypeDef: # (2)
...# create_vocabulary method usage example with argument unpacking
kwargs: CreateVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyName": ...,
"LanguageCode": ...,
"Content": ...,
}
parent.create_vocabulary(**kwargs)deactivate_evaluation_form#
Deactivates an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").deactivate_evaluation_form method.
boto3 documentation
# deactivate_evaluation_form method definition
def deactivate_evaluation_form(
self,
*,
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int,
) -> DeactivateEvaluationFormResponseTypeDef: # (1)
...# deactivate_evaluation_form method usage example with argument unpacking
kwargs: DeactivateEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
"EvaluationFormVersion": ...,
}
parent.deactivate_evaluation_form(**kwargs)delete_attached_file#
Deletes an attached file along with the underlying S3 Object.
Type annotations and code completion for boto3.client("connect").delete_attached_file method.
boto3 documentation
# delete_attached_file method definition
def delete_attached_file(
self,
*,
InstanceId: str,
FileId: str,
AssociatedResourceArn: str,
) -> Dict[str, Any]:
...# delete_attached_file method usage example with argument unpacking
kwargs: DeleteAttachedFileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FileId": ...,
"AssociatedResourceArn": ...,
}
parent.delete_attached_file(**kwargs)delete_contact_evaluation#
Deletes a contact evaluation in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_contact_evaluation method.
boto3 documentation
# delete_contact_evaluation method definition
def delete_contact_evaluation(
self,
*,
InstanceId: str,
EvaluationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_contact_evaluation method usage example with argument unpacking
kwargs: DeleteContactEvaluationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationId": ...,
}
parent.delete_contact_evaluation(**kwargs)delete_contact_flow#
Deletes a flow for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_contact_flow method.
boto3 documentation
# delete_contact_flow method definition
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)delete_contact_flow_module#
Deletes the specified flow module.
Type annotations and code completion for boto3.client("connect").delete_contact_flow_module method.
boto3 documentation
# delete_contact_flow_module method definition
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)delete_evaluation_form#
Deletes an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_evaluation_form method.
boto3 documentation
# delete_evaluation_form method definition
def delete_evaluation_form(
self,
*,
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_evaluation_form method usage example with argument unpacking
kwargs: DeleteEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
}
parent.delete_evaluation_form(**kwargs)delete_hours_of_operation#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").delete_hours_of_operation method.
boto3 documentation
# delete_hours_of_operation method definition
def delete_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_hours_of_operation method usage example with argument unpacking
kwargs: DeleteHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.delete_hours_of_operation(**kwargs)delete_instance#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").delete_instance method.
boto3 documentation
# delete_instance method definition
def delete_instance(
self,
*,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_instance method usage example with argument unpacking
kwargs: DeleteInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.delete_instance(**kwargs)delete_integration_association#
Deletes an Amazon Web Services resource association from an Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_integration_association method.
boto3 documentation
# delete_integration_association method definition
def delete_integration_association(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_integration_association method usage example with argument unpacking
kwargs: DeleteIntegrationAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
parent.delete_integration_association(**kwargs)delete_predefined_attribute#
Deletes a predefined attribute from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_predefined_attribute method.
boto3 documentation
# delete_predefined_attribute method definition
def delete_predefined_attribute(
self,
*,
InstanceId: str,
Name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_predefined_attribute method usage example with argument unpacking
kwargs: DeletePredefinedAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
}
parent.delete_predefined_attribute(**kwargs)delete_prompt#
Deletes a prompt.
Type annotations and code completion for boto3.client("connect").delete_prompt method.
boto3 documentation
# delete_prompt method definition
def delete_prompt(
self,
*,
InstanceId: str,
PromptId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_prompt method usage example with argument unpacking
kwargs: DeletePromptRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"PromptId": ...,
}
parent.delete_prompt(**kwargs)delete_queue#
Deletes a queue.
Type annotations and code completion for boto3.client("connect").delete_queue method.
boto3 documentation
# delete_queue method definition
def delete_queue(
self,
*,
InstanceId: str,
QueueId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_queue method usage example with argument unpacking
kwargs: DeleteQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.delete_queue(**kwargs)delete_quick_connect#
Deletes a quick connect.
Type annotations and code completion for boto3.client("connect").delete_quick_connect method.
boto3 documentation
# delete_quick_connect method definition
def delete_quick_connect(
self,
*,
InstanceId: str,
QuickConnectId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_quick_connect method usage example with argument unpacking
kwargs: DeleteQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.delete_quick_connect(**kwargs)delete_routing_profile#
Deletes a routing profile.
Type annotations and code completion for boto3.client("connect").delete_routing_profile method.
boto3 documentation
# delete_routing_profile method definition
def delete_routing_profile(
self,
*,
InstanceId: str,
RoutingProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_routing_profile method usage example with argument unpacking
kwargs: DeleteRoutingProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.delete_routing_profile(**kwargs)delete_rule#
Deletes a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_rule method.
boto3 documentation
# delete_rule method definition
def delete_rule(
self,
*,
InstanceId: str,
RuleId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_rule method usage example with argument unpacking
kwargs: DeleteRuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RuleId": ...,
}
parent.delete_rule(**kwargs)delete_security_profile#
Deletes a security profile.
Type annotations and code completion for boto3.client("connect").delete_security_profile method.
boto3 documentation
# delete_security_profile method definition
def delete_security_profile(
self,
*,
InstanceId: str,
SecurityProfileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_security_profile method usage example with argument unpacking
kwargs: DeleteSecurityProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"SecurityProfileId": ...,
}
parent.delete_security_profile(**kwargs)delete_task_template#
Deletes the task template.
Type annotations and code completion for boto3.client("connect").delete_task_template method.
boto3 documentation
# delete_task_template method definition
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)delete_traffic_distribution_group#
Deletes a traffic distribution group.
Type annotations and code completion for boto3.client("connect").delete_traffic_distribution_group method.
boto3 documentation
# delete_traffic_distribution_group method definition
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)delete_use_case#
Deletes a use case from an integration association.
Type annotations and code completion for boto3.client("connect").delete_use_case method.
boto3 documentation
# delete_use_case method definition
def delete_use_case(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
UseCaseId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_use_case method usage example with argument unpacking
kwargs: DeleteUseCaseRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
"UseCaseId": ...,
}
parent.delete_use_case(**kwargs)delete_user#
Deletes a user account from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").delete_user method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
InstanceId: str,
UserId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
}
parent.delete_user(**kwargs)delete_user_hierarchy_group#
Deletes an existing user hierarchy group.
Type annotations and code completion for boto3.client("connect").delete_user_hierarchy_group method.
boto3 documentation
# delete_user_hierarchy_group method definition
def delete_user_hierarchy_group(
self,
*,
HierarchyGroupId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_user_hierarchy_group method usage example with argument unpacking
kwargs: DeleteUserHierarchyGroupRequestRequestTypeDef = { # (1)
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.delete_user_hierarchy_group(**kwargs)delete_view#
Deletes the view entirely.
Type annotations and code completion for boto3.client("connect").delete_view method.
boto3 documentation
# delete_view method definition
def delete_view(
self,
*,
InstanceId: str,
ViewId: str,
) -> Dict[str, Any]:
...# delete_view method usage example with argument unpacking
kwargs: DeleteViewRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
}
parent.delete_view(**kwargs)delete_view_version#
Deletes the particular version specified in ViewVersion identifier.
Type annotations and code completion for boto3.client("connect").delete_view_version method.
boto3 documentation
# delete_view_version method definition
def delete_view_version(
self,
*,
InstanceId: str,
ViewId: str,
ViewVersion: int,
) -> Dict[str, Any]:
...# delete_view_version method usage example with argument unpacking
kwargs: DeleteViewVersionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
"ViewVersion": ...,
}
parent.delete_view_version(**kwargs)delete_vocabulary#
Deletes the vocabulary that has the given identifier.
Type annotations and code completion for boto3.client("connect").delete_vocabulary method.
boto3 documentation
# delete_vocabulary method definition
def delete_vocabulary(
self,
*,
InstanceId: str,
VocabularyId: str,
) -> DeleteVocabularyResponseTypeDef: # (1)
...# delete_vocabulary method usage example with argument unpacking
kwargs: DeleteVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyId": ...,
}
parent.delete_vocabulary(**kwargs)describe_agent_status#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_agent_status method.
boto3 documentation
# describe_agent_status method definition
def describe_agent_status(
self,
*,
InstanceId: str,
AgentStatusId: str,
) -> DescribeAgentStatusResponseTypeDef: # (1)
...# describe_agent_status method usage example with argument unpacking
kwargs: DescribeAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AgentStatusId": ...,
}
parent.describe_agent_status(**kwargs)describe_authentication_profile#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_authentication_profile method.
boto3 documentation
# describe_authentication_profile method definition
def describe_authentication_profile(
self,
*,
AuthenticationProfileId: str,
InstanceId: str,
) -> DescribeAuthenticationProfileResponseTypeDef: # (1)
...# describe_authentication_profile method usage example with argument unpacking
kwargs: DescribeAuthenticationProfileRequestRequestTypeDef = { # (1)
"AuthenticationProfileId": ...,
"InstanceId": ...,
}
parent.describe_authentication_profile(**kwargs)describe_contact#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_contact method.
boto3 documentation
# describe_contact method definition
def describe_contact(
self,
*,
InstanceId: str,
ContactId: str,
) -> DescribeContactResponseTypeDef: # (1)
...# describe_contact method usage example with argument unpacking
kwargs: DescribeContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.describe_contact(**kwargs)describe_contact_evaluation#
Describes a contact evaluation in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").describe_contact_evaluation method.
boto3 documentation
# describe_contact_evaluation method definition
def describe_contact_evaluation(
self,
*,
InstanceId: str,
EvaluationId: str,
) -> DescribeContactEvaluationResponseTypeDef: # (1)
...# describe_contact_evaluation method usage example with argument unpacking
kwargs: DescribeContactEvaluationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationId": ...,
}
parent.describe_contact_evaluation(**kwargs)describe_contact_flow#
Describes the specified flow.
Type annotations and code completion for boto3.client("connect").describe_contact_flow method.
boto3 documentation
# describe_contact_flow method definition
def describe_contact_flow(
self,
*,
InstanceId: str,
ContactFlowId: str,
) -> DescribeContactFlowResponseTypeDef: # (1)
...# describe_contact_flow method usage example with argument unpacking
kwargs: DescribeContactFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.describe_contact_flow(**kwargs)describe_contact_flow_module#
Describes the specified flow module.
Type annotations and code completion for boto3.client("connect").describe_contact_flow_module method.
boto3 documentation
# describe_contact_flow_module method definition
def describe_contact_flow_module(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
) -> DescribeContactFlowModuleResponseTypeDef: # (1)
...# describe_contact_flow_module method usage example with argument unpacking
kwargs: DescribeContactFlowModuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
parent.describe_contact_flow_module(**kwargs)describe_evaluation_form#
Describes an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").describe_evaluation_form method.
boto3 documentation
# describe_evaluation_form method definition
def describe_evaluation_form(
self,
*,
InstanceId: str,
EvaluationFormId: str,
EvaluationFormVersion: int = ...,
) -> DescribeEvaluationFormResponseTypeDef: # (1)
...# describe_evaluation_form method usage example with argument unpacking
kwargs: DescribeEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
}
parent.describe_evaluation_form(**kwargs)describe_hours_of_operation#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_hours_of_operation method.
boto3 documentation
# describe_hours_of_operation method definition
def describe_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
) -> DescribeHoursOfOperationResponseTypeDef: # (1)
...# describe_hours_of_operation method usage example with argument unpacking
kwargs: DescribeHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.describe_hours_of_operation(**kwargs)describe_instance#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_instance method.
boto3 documentation
# describe_instance method definition
def describe_instance(
self,
*,
InstanceId: str,
) -> DescribeInstanceResponseTypeDef: # (1)
...# describe_instance method usage example with argument unpacking
kwargs: DescribeInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_instance(**kwargs)describe_instance_attribute#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_instance_attribute method.
boto3 documentation
# describe_instance_attribute method definition
def describe_instance_attribute(
self,
*,
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
) -> DescribeInstanceAttributeResponseTypeDef: # (2)
...# describe_instance_attribute method usage example with argument unpacking
kwargs: DescribeInstanceAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AttributeType": ...,
}
parent.describe_instance_attribute(**kwargs)describe_instance_storage_config#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_instance_storage_config method.
boto3 documentation
# describe_instance_storage_config method definition
def describe_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
) -> DescribeInstanceStorageConfigResponseTypeDef: # (2)
...# describe_instance_storage_config method usage example with argument unpacking
kwargs: DescribeInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
parent.describe_instance_storage_config(**kwargs)describe_phone_number#
Gets details and status of a phone number that's claimed to your Amazon Connect instance or traffic distribution group.
Type annotations and code completion for boto3.client("connect").describe_phone_number method.
boto3 documentation
# describe_phone_number method definition
def describe_phone_number(
self,
*,
PhoneNumberId: str,
) -> DescribePhoneNumberResponseTypeDef: # (1)
...# describe_phone_number method usage example with argument unpacking
kwargs: DescribePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.describe_phone_number(**kwargs)describe_predefined_attribute#
Describes a predefined attribute for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").describe_predefined_attribute method.
boto3 documentation
# describe_predefined_attribute method definition
def describe_predefined_attribute(
self,
*,
InstanceId: str,
Name: str,
) -> DescribePredefinedAttributeResponseTypeDef: # (1)
...# describe_predefined_attribute method usage example with argument unpacking
kwargs: DescribePredefinedAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
}
parent.describe_predefined_attribute(**kwargs)describe_prompt#
Describes the prompt.
Type annotations and code completion for boto3.client("connect").describe_prompt method.
boto3 documentation
# describe_prompt method definition
def describe_prompt(
self,
*,
InstanceId: str,
PromptId: str,
) -> DescribePromptResponseTypeDef: # (1)
...# describe_prompt method usage example with argument unpacking
kwargs: DescribePromptRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"PromptId": ...,
}
parent.describe_prompt(**kwargs)describe_queue#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").describe_queue method.
boto3 documentation
# describe_queue method definition
def describe_queue(
self,
*,
InstanceId: str,
QueueId: str,
) -> DescribeQueueResponseTypeDef: # (1)
...# describe_queue method usage example with argument unpacking
kwargs: DescribeQueueRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.describe_queue(**kwargs)describe_quick_connect#
Describes the quick connect.
Type annotations and code completion for boto3.client("connect").describe_quick_connect method.
boto3 documentation
# describe_quick_connect method definition
def describe_quick_connect(
self,
*,
InstanceId: str,
QuickConnectId: str,
) -> DescribeQuickConnectResponseTypeDef: # (1)
...# describe_quick_connect method usage example with argument unpacking
kwargs: DescribeQuickConnectRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.describe_quick_connect(**kwargs)describe_routing_profile#
Describes the specified routing profile.
Type annotations and code completion for boto3.client("connect").describe_routing_profile method.
boto3 documentation
# describe_routing_profile method definition
def describe_routing_profile(
self,
*,
InstanceId: str,
RoutingProfileId: str,
) -> DescribeRoutingProfileResponseTypeDef: # (1)
...# describe_routing_profile method usage example with argument unpacking
kwargs: DescribeRoutingProfileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.describe_routing_profile(**kwargs)describe_rule#
Describes a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").describe_rule method.
boto3 documentation
# describe_rule method definition
def describe_rule(
self,
*,
InstanceId: str,
RuleId: str,
) -> DescribeRuleResponseTypeDef: # (1)
...# describe_rule method usage example with argument unpacking
kwargs: DescribeRuleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RuleId": ...,
}
parent.describe_rule(**kwargs)describe_security_profile#
Gets basic information about the security profile.
Type annotations and code completion for boto3.client("connect").describe_security_profile method.
boto3 documentation
# describe_security_profile method definition
def describe_security_profile(
self,
*,
SecurityProfileId: str,
InstanceId: str,
) -> DescribeSecurityProfileResponseTypeDef: # (1)
...# describe_security_profile method usage example with argument unpacking
kwargs: DescribeSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.describe_security_profile(**kwargs)describe_traffic_distribution_group#
Gets details and status of a traffic distribution group.
Type annotations and code completion for boto3.client("connect").describe_traffic_distribution_group method.
boto3 documentation
# describe_traffic_distribution_group method definition
def describe_traffic_distribution_group(
self,
*,
TrafficDistributionGroupId: str,
) -> DescribeTrafficDistributionGroupResponseTypeDef: # (1)
...# describe_traffic_distribution_group method usage example with argument unpacking
kwargs: DescribeTrafficDistributionGroupRequestRequestTypeDef = { # (1)
"TrafficDistributionGroupId": ...,
}
parent.describe_traffic_distribution_group(**kwargs)describe_user#
Describes the specified user.
Type annotations and code completion for boto3.client("connect").describe_user method.
boto3 documentation
# describe_user method definition
def describe_user(
self,
*,
UserId: str,
InstanceId: str,
) -> DescribeUserResponseTypeDef: # (1)
...# describe_user method usage example with argument unpacking
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"UserId": ...,
"InstanceId": ...,
}
parent.describe_user(**kwargs)describe_user_hierarchy_group#
Describes the specified hierarchy group.
Type annotations and code completion for boto3.client("connect").describe_user_hierarchy_group method.
boto3 documentation
# describe_user_hierarchy_group method definition
def describe_user_hierarchy_group(
self,
*,
HierarchyGroupId: str,
InstanceId: str,
) -> DescribeUserHierarchyGroupResponseTypeDef: # (1)
...# describe_user_hierarchy_group method usage example with argument unpacking
kwargs: DescribeUserHierarchyGroupRequestRequestTypeDef = { # (1)
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.describe_user_hierarchy_group(**kwargs)describe_user_hierarchy_structure#
Describes the hierarchy structure of the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").describe_user_hierarchy_structure method.
boto3 documentation
# describe_user_hierarchy_structure method definition
def describe_user_hierarchy_structure(
self,
*,
InstanceId: str,
) -> DescribeUserHierarchyStructureResponseTypeDef: # (1)
...# describe_user_hierarchy_structure method usage example with argument unpacking
kwargs: DescribeUserHierarchyStructureRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_user_hierarchy_structure(**kwargs)describe_view#
Retrieves the view for the specified Amazon Connect instance and view identifier.
Type annotations and code completion for boto3.client("connect").describe_view method.
boto3 documentation
# describe_view method definition
def describe_view(
self,
*,
InstanceId: str,
ViewId: str,
) -> DescribeViewResponseTypeDef: # (1)
...# describe_view method usage example with argument unpacking
kwargs: DescribeViewRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
}
parent.describe_view(**kwargs)describe_vocabulary#
Describes the specified vocabulary.
Type annotations and code completion for boto3.client("connect").describe_vocabulary method.
boto3 documentation
# describe_vocabulary method definition
def describe_vocabulary(
self,
*,
InstanceId: str,
VocabularyId: str,
) -> DescribeVocabularyResponseTypeDef: # (1)
...# describe_vocabulary method usage example with argument unpacking
kwargs: DescribeVocabularyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"VocabularyId": ...,
}
parent.describe_vocabulary(**kwargs)disassociate_analytics_data_set#
Removes the dataset ID associated with a given Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").disassociate_analytics_data_set method.
boto3 documentation
# disassociate_analytics_data_set method definition
def disassociate_analytics_data_set(
self,
*,
InstanceId: str,
DataSetId: str,
TargetAccountId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_analytics_data_set method usage example with argument unpacking
kwargs: DisassociateAnalyticsDataSetRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"DataSetId": ...,
}
parent.disassociate_analytics_data_set(**kwargs)disassociate_approved_origin#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_approved_origin method.
boto3 documentation
# disassociate_approved_origin method definition
def disassociate_approved_origin(
self,
*,
InstanceId: str,
Origin: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_approved_origin method usage example with argument unpacking
kwargs: DisassociateApprovedOriginRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Origin": ...,
}
parent.disassociate_approved_origin(**kwargs)disassociate_bot#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_bot method.
boto3 documentation
# disassociate_bot method definition
def disassociate_bot(
self,
*,
InstanceId: str,
LexBot: LexBotTypeDef = ..., # (1)
LexV2Bot: LexV2BotTypeDef = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...- See LexBotTypeDef
- See LexV2BotTypeDef
- See EmptyResponseMetadataTypeDef
# disassociate_bot method usage example with argument unpacking
kwargs: DisassociateBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.disassociate_bot(**kwargs)disassociate_flow#
Disassociates a connect resource from a flow.
Type annotations and code completion for boto3.client("connect").disassociate_flow method.
boto3 documentation
# disassociate_flow method definition
def disassociate_flow(
self,
*,
InstanceId: str,
ResourceId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)
) -> Dict[str, Any]:
...# disassociate_flow method usage example with argument unpacking
kwargs: DisassociateFlowRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceId": ...,
"ResourceType": ...,
}
parent.disassociate_flow(**kwargs)disassociate_instance_storage_config#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_instance_storage_config method.
boto3 documentation
# disassociate_instance_storage_config method definition
def disassociate_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# disassociate_instance_storage_config method usage example with argument unpacking
kwargs: DisassociateInstanceStorageConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
"ResourceType": ...,
}
parent.disassociate_instance_storage_config(**kwargs)disassociate_lambda_function#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_lambda_function method.
boto3 documentation
# disassociate_lambda_function method definition
def disassociate_lambda_function(
self,
*,
InstanceId: str,
FunctionArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_lambda_function method usage example with argument unpacking
kwargs: DisassociateLambdaFunctionRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FunctionArn": ...,
}
parent.disassociate_lambda_function(**kwargs)disassociate_lex_bot#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_lex_bot method.
boto3 documentation
# disassociate_lex_bot method definition
def disassociate_lex_bot(
self,
*,
InstanceId: str,
BotName: str,
LexRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_lex_bot method usage example with argument unpacking
kwargs: DisassociateLexBotRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"BotName": ...,
"LexRegion": ...,
}
parent.disassociate_lex_bot(**kwargs)disassociate_phone_number_contact_flow#
Removes the flow association from a phone number claimed to your Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").disassociate_phone_number_contact_flow method.
boto3 documentation
# disassociate_phone_number_contact_flow method definition
def disassociate_phone_number_contact_flow(
self,
*,
PhoneNumberId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_phone_number_contact_flow method usage example with argument unpacking
kwargs: DisassociatePhoneNumberContactFlowRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
"InstanceId": ...,
}
parent.disassociate_phone_number_contact_flow(**kwargs)disassociate_queue_quick_connects#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_queue_quick_connects method.
boto3 documentation
# disassociate_queue_quick_connects method definition
def disassociate_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
QuickConnectIds: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_queue_quick_connects method usage example with argument unpacking
kwargs: DisassociateQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"QuickConnectIds": ...,
}
parent.disassociate_queue_quick_connects(**kwargs)disassociate_routing_profile_queues#
Disassociates a set of queues from a routing profile.
Type annotations and code completion for boto3.client("connect").disassociate_routing_profile_queues method.
boto3 documentation
# disassociate_routing_profile_queues method definition
def disassociate_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueReferences: Sequence[RoutingProfileQueueReferenceTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# disassociate_routing_profile_queues method usage example with argument unpacking
kwargs: DisassociateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueReferences": ...,
}
parent.disassociate_routing_profile_queues(**kwargs)disassociate_security_key#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").disassociate_security_key method.
boto3 documentation
# disassociate_security_key method definition
def disassociate_security_key(
self,
*,
InstanceId: str,
AssociationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_security_key method usage example with argument unpacking
kwargs: DisassociateSecurityKeyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AssociationId": ...,
}
parent.disassociate_security_key(**kwargs)disassociate_traffic_distribution_group_user#
Disassociates an agent from a traffic distribution group.
Type annotations and code completion for boto3.client("connect").disassociate_traffic_distribution_group_user method.
boto3 documentation
# disassociate_traffic_distribution_group_user method definition
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)disassociate_user_proficiencies#
Disassociates a set of proficiencies from a user.
Type annotations and code completion for boto3.client("connect").disassociate_user_proficiencies method.
boto3 documentation
# disassociate_user_proficiencies method definition
def disassociate_user_proficiencies(
self,
*,
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyDisassociateTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# disassociate_user_proficiencies method usage example with argument unpacking
kwargs: DisassociateUserProficienciesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
"UserProficiencies": ...,
}
parent.disassociate_user_proficiencies(**kwargs)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 boto3.client("connect").dismiss_user_contact method.
boto3 documentation
# dismiss_user_contact method definition
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)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("connect").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_attached_file#
Provides a pre-signed URL for download of an approved attached file.
Type annotations and code completion for boto3.client("connect").get_attached_file method.
boto3 documentation
# get_attached_file method definition
def get_attached_file(
self,
*,
InstanceId: str,
FileId: str,
AssociatedResourceArn: str,
UrlExpiryInSeconds: int = ...,
) -> GetAttachedFileResponseTypeDef: # (1)
...# get_attached_file method usage example with argument unpacking
kwargs: GetAttachedFileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FileId": ...,
"AssociatedResourceArn": ...,
}
parent.get_attached_file(**kwargs)get_contact_attributes#
Retrieves the contact attributes for the specified contact.
Type annotations and code completion for boto3.client("connect").get_contact_attributes method.
boto3 documentation
# get_contact_attributes method definition
def get_contact_attributes(
self,
*,
InstanceId: str,
InitialContactId: str,
) -> GetContactAttributesResponseTypeDef: # (1)
...# get_contact_attributes method usage example with argument unpacking
kwargs: GetContactAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"InitialContactId": ...,
}
parent.get_contact_attributes(**kwargs)get_current_metric_data#
Gets the real-time metric data from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").get_current_metric_data method.
boto3 documentation
# get_current_metric_data method definition
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)
...- See FiltersTypeDef
- See CurrentMetricTypeDef
- See GroupingType
- See CurrentMetricSortCriteriaTypeDef
- See GetCurrentMetricDataResponseTypeDef
# get_current_metric_data method usage example with argument unpacking
kwargs: GetCurrentMetricDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Filters": ...,
"CurrentMetrics": ...,
}
parent.get_current_metric_data(**kwargs)get_current_user_data#
Gets the real-time active user data from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").get_current_user_data method.
boto3 documentation
# get_current_user_data method definition
def get_current_user_data(
self,
*,
InstanceId: str,
Filters: UserDataFiltersTypeDef, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetCurrentUserDataResponseTypeDef: # (2)
...# get_current_user_data method usage example with argument unpacking
kwargs: GetCurrentUserDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Filters": ...,
}
parent.get_current_user_data(**kwargs)get_federation_token#
Supports SAML sign-in for Amazon Connect.
Type annotations and code completion for boto3.client("connect").get_federation_token method.
boto3 documentation
# get_federation_token method definition
def get_federation_token(
self,
*,
InstanceId: str,
) -> GetFederationTokenResponseTypeDef: # (1)
...# get_federation_token method usage example with argument unpacking
kwargs: GetFederationTokenRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.get_federation_token(**kwargs)get_flow_association#
Retrieves the flow associated for a given resource.
Type annotations and code completion for boto3.client("connect").get_flow_association method.
boto3 documentation
# get_flow_association method definition
def get_flow_association(
self,
*,
InstanceId: str,
ResourceId: str,
ResourceType: FlowAssociationResourceTypeType, # (1)
) -> GetFlowAssociationResponseTypeDef: # (2)
...# get_flow_association method usage example with argument unpacking
kwargs: GetFlowAssociationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceId": ...,
"ResourceType": ...,
}
parent.get_flow_association(**kwargs)get_metric_data#
Gets historical metric data from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").get_metric_data method.
boto3 documentation
# get_metric_data method definition
def get_metric_data(
self,
*,
InstanceId: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Filters: FiltersTypeDef, # (1)
HistoricalMetrics: Sequence[HistoricalMetricTypeDef], # (2)
Groupings: Sequence[GroupingType] = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetMetricDataResponseTypeDef: # (4)
...# get_metric_data method usage example with argument unpacking
kwargs: GetMetricDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"StartTime": ...,
"EndTime": ...,
"Filters": ...,
"HistoricalMetrics": ...,
}
parent.get_metric_data(**kwargs)get_metric_data_v2#
Gets metric data from the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").get_metric_data_v2 method.
boto3 documentation
# get_metric_data_v2 method definition
def get_metric_data_v2(
self,
*,
ResourceArn: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Filters: Sequence[FilterV2TypeDef], # (1)
Metrics: Sequence[MetricV2UnionTypeDef], # (2)
Interval: IntervalDetailsTypeDef = ..., # (3)
Groupings: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetMetricDataV2ResponseTypeDef: # (4)
...- See FilterV2TypeDef
- See MetricV2TypeDef MetricV2OutputTypeDef
- See IntervalDetailsTypeDef
- 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)get_prompt_file#
Gets the prompt file.
Type annotations and code completion for boto3.client("connect").get_prompt_file method.
boto3 documentation
# get_prompt_file method definition
def get_prompt_file(
self,
*,
InstanceId: str,
PromptId: str,
) -> GetPromptFileResponseTypeDef: # (1)
...# get_prompt_file method usage example with argument unpacking
kwargs: GetPromptFileRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"PromptId": ...,
}
parent.get_prompt_file(**kwargs)get_task_template#
Gets details about a specific task template in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").get_task_template method.
boto3 documentation
# get_task_template method definition
def get_task_template(
self,
*,
InstanceId: str,
TaskTemplateId: str,
SnapshotVersion: str = ...,
) -> GetTaskTemplateResponseTypeDef: # (1)
...# get_task_template method usage example with argument unpacking
kwargs: GetTaskTemplateRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"TaskTemplateId": ...,
}
parent.get_task_template(**kwargs)get_traffic_distribution#
Retrieves the current traffic distribution for a given traffic distribution group.
Type annotations and code completion for boto3.client("connect").get_traffic_distribution method.
boto3 documentation
# get_traffic_distribution method definition
def get_traffic_distribution(
self,
*,
Id: str,
) -> GetTrafficDistributionResponseTypeDef: # (1)
...# get_traffic_distribution method usage example with argument unpacking
kwargs: GetTrafficDistributionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_traffic_distribution(**kwargs)import_phone_number#
Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").import_phone_number method.
boto3 documentation
# import_phone_number method definition
def import_phone_number(
self,
*,
InstanceId: str,
SourcePhoneNumberArn: str,
PhoneNumberDescription: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> ImportPhoneNumberResponseTypeDef: # (1)
...# import_phone_number method usage example with argument unpacking
kwargs: ImportPhoneNumberRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"SourcePhoneNumberArn": ...,
}
parent.import_phone_number(**kwargs)list_agent_statuses#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_agent_statuses method.
boto3 documentation
# list_agent_statuses method definition
def list_agent_statuses(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
AgentStatusTypes: Sequence[AgentStatusTypeType] = ..., # (1)
) -> ListAgentStatusResponseTypeDef: # (2)
...# list_agent_statuses method usage example with argument unpacking
kwargs: ListAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_agent_statuses(**kwargs)list_analytics_data_associations#
Lists the association status of requested dataset ID for a given Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_analytics_data_associations method.
boto3 documentation
# list_analytics_data_associations method definition
def list_analytics_data_associations(
self,
*,
InstanceId: str,
DataSetId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAnalyticsDataAssociationsResponseTypeDef: # (1)
...# list_analytics_data_associations method usage example with argument unpacking
kwargs: ListAnalyticsDataAssociationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_analytics_data_associations(**kwargs)list_approved_origins#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_approved_origins method.
boto3 documentation
# list_approved_origins method definition
def list_approved_origins(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListApprovedOriginsResponseTypeDef: # (1)
...# list_approved_origins method usage example with argument unpacking
kwargs: ListApprovedOriginsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_approved_origins(**kwargs)list_authentication_profiles#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_authentication_profiles method.
boto3 documentation
# list_authentication_profiles method definition
def list_authentication_profiles(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAuthenticationProfilesResponseTypeDef: # (1)
...# list_authentication_profiles method usage example with argument unpacking
kwargs: ListAuthenticationProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_authentication_profiles(**kwargs)list_bots#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_bots method.
boto3 documentation
# list_bots method definition
def list_bots(
self,
*,
InstanceId: str,
LexVersion: LexVersionType, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBotsResponseTypeDef: # (2)
...# list_bots method usage example with argument unpacking
kwargs: ListBotsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"LexVersion": ...,
}
parent.list_bots(**kwargs)list_contact_evaluations#
Lists contact evaluations in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_contact_evaluations method.
boto3 documentation
# list_contact_evaluations method definition
def list_contact_evaluations(
self,
*,
InstanceId: str,
ContactId: str,
NextToken: str = ...,
) -> ListContactEvaluationsResponseTypeDef: # (1)
...# list_contact_evaluations method usage example with argument unpacking
kwargs: ListContactEvaluationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.list_contact_evaluations(**kwargs)list_contact_flow_modules#
Provides information about the flow modules for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_contact_flow_modules method.
boto3 documentation
# list_contact_flow_modules method definition
def list_contact_flow_modules(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
ContactFlowModuleState: ContactFlowModuleStateType = ..., # (1)
) -> ListContactFlowModulesResponseTypeDef: # (2)
...# list_contact_flow_modules method usage example with argument unpacking
kwargs: ListContactFlowModulesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_contact_flow_modules(**kwargs)list_contact_flow_versions#
Returns all the available versions for the specified Amazon Connect instance and flow identifier.
Type annotations and code completion for boto3.client("connect").list_contact_flow_versions method.
boto3 documentation
# list_contact_flow_versions method definition
def list_contact_flow_versions(
self,
*,
InstanceId: str,
ContactFlowId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContactFlowVersionsResponseTypeDef: # (1)
...# list_contact_flow_versions method usage example with argument unpacking
kwargs: ListContactFlowVersionsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.list_contact_flow_versions(**kwargs)list_contact_flows#
Provides information about the flows for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_contact_flows method.
boto3 documentation
# list_contact_flows method definition
def list_contact_flows(
self,
*,
InstanceId: str,
ContactFlowTypes: Sequence[ContactFlowTypeType] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContactFlowsResponseTypeDef: # (2)
...# list_contact_flows method usage example with argument unpacking
kwargs: ListContactFlowsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_contact_flows(**kwargs)list_contact_references#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_contact_references method.
boto3 documentation
# list_contact_references method definition
def list_contact_references(
self,
*,
InstanceId: str,
ContactId: str,
ReferenceTypes: Sequence[ReferenceTypeType], # (1)
NextToken: str = ...,
) -> ListContactReferencesResponseTypeDef: # (2)
...# list_contact_references method usage example with argument unpacking
kwargs: ListContactReferencesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ReferenceTypes": ...,
}
parent.list_contact_references(**kwargs)list_default_vocabularies#
Lists the default vocabularies for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_default_vocabularies method.
boto3 documentation
# list_default_vocabularies method definition
def list_default_vocabularies(
self,
*,
InstanceId: str,
LanguageCode: VocabularyLanguageCodeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDefaultVocabulariesResponseTypeDef: # (2)
...# list_default_vocabularies method usage example with argument unpacking
kwargs: ListDefaultVocabulariesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_default_vocabularies(**kwargs)list_evaluation_form_versions#
Lists versions of an evaluation form in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_evaluation_form_versions method.
boto3 documentation
# list_evaluation_form_versions method definition
def list_evaluation_form_versions(
self,
*,
InstanceId: str,
EvaluationFormId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListEvaluationFormVersionsResponseTypeDef: # (1)
...# list_evaluation_form_versions method usage example with argument unpacking
kwargs: ListEvaluationFormVersionsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
}
parent.list_evaluation_form_versions(**kwargs)list_evaluation_forms#
Lists evaluation forms in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_evaluation_forms method.
boto3 documentation
# list_evaluation_forms method definition
def list_evaluation_forms(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListEvaluationFormsResponseTypeDef: # (1)
...# list_evaluation_forms method usage example with argument unpacking
kwargs: ListEvaluationFormsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_evaluation_forms(**kwargs)list_flow_associations#
List the flow association based on the filters.
Type annotations and code completion for boto3.client("connect").list_flow_associations method.
boto3 documentation
# list_flow_associations method definition
def list_flow_associations(
self,
*,
InstanceId: str,
ResourceType: ListFlowAssociationResourceTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFlowAssociationsResponseTypeDef: # (2)
...# list_flow_associations method usage example with argument unpacking
kwargs: ListFlowAssociationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_flow_associations(**kwargs)list_hours_of_operations#
Provides information about the hours of operation for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_hours_of_operations method.
boto3 documentation
# list_hours_of_operations method definition
def list_hours_of_operations(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListHoursOfOperationsResponseTypeDef: # (1)
...# list_hours_of_operations method usage example with argument unpacking
kwargs: ListHoursOfOperationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_hours_of_operations(**kwargs)list_instance_attributes#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_instance_attributes method.
boto3 documentation
# list_instance_attributes method definition
def list_instance_attributes(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstanceAttributesResponseTypeDef: # (1)
...# list_instance_attributes method usage example with argument unpacking
kwargs: ListInstanceAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_instance_attributes(**kwargs)list_instance_storage_configs#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_instance_storage_configs method.
boto3 documentation
# list_instance_storage_configs method definition
def list_instance_storage_configs(
self,
*,
InstanceId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstanceStorageConfigsResponseTypeDef: # (2)
...# list_instance_storage_configs method usage example with argument unpacking
kwargs: ListInstanceStorageConfigsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ResourceType": ...,
}
parent.list_instance_storage_configs(**kwargs)list_instances#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_instances method.
boto3 documentation
# list_instances method definition
def list_instances(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInstancesResponseTypeDef: # (1)
...# list_instances method usage example with argument unpacking
kwargs: ListInstancesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_instances(**kwargs)list_integration_associations#
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_integration_associations method.
boto3 documentation
# list_integration_associations method definition
def list_integration_associations(
self,
*,
InstanceId: str,
IntegrationType: IntegrationTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
IntegrationArn: str = ...,
) -> ListIntegrationAssociationsResponseTypeDef: # (2)
...# list_integration_associations method usage example with argument unpacking
kwargs: ListIntegrationAssociationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_integration_associations(**kwargs)list_lambda_functions#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_lambda_functions method.
boto3 documentation
# list_lambda_functions method definition
def list_lambda_functions(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLambdaFunctionsResponseTypeDef: # (1)
...# list_lambda_functions method usage example with argument unpacking
kwargs: ListLambdaFunctionsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_lambda_functions(**kwargs)list_lex_bots#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_lex_bots method.
boto3 documentation
# list_lex_bots method definition
def list_lex_bots(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLexBotsResponseTypeDef: # (1)
...# list_lex_bots method usage example with argument unpacking
kwargs: ListLexBotsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_lex_bots(**kwargs)list_phone_numbers#
Provides information about the phone numbers for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_phone_numbers method.
boto3 documentation
# list_phone_numbers method definition
def list_phone_numbers(
self,
*,
InstanceId: str,
PhoneNumberTypes: Sequence[PhoneNumberTypeType] = ..., # (1)
PhoneNumberCountryCodes: Sequence[PhoneNumberCountryCodeType] = ..., # (2)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPhoneNumbersResponseTypeDef: # (3)
...# list_phone_numbers method usage example with argument unpacking
kwargs: ListPhoneNumbersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_phone_numbers(**kwargs)list_phone_numbers_v2#
Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
Type annotations and code completion for boto3.client("connect").list_phone_numbers_v2 method.
boto3 documentation
# list_phone_numbers_v2 method definition
def list_phone_numbers_v2(
self,
*,
TargetArn: str = ...,
InstanceId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
PhoneNumberCountryCodes: Sequence[PhoneNumberCountryCodeType] = ..., # (1)
PhoneNumberTypes: Sequence[PhoneNumberTypeType] = ..., # (2)
PhoneNumberPrefix: str = ...,
) -> ListPhoneNumbersV2ResponseTypeDef: # (3)
...# list_phone_numbers_v2 method usage example with argument unpacking
kwargs: ListPhoneNumbersV2RequestRequestTypeDef = { # (1)
"TargetArn": ...,
}
parent.list_phone_numbers_v2(**kwargs)list_predefined_attributes#
Lists predefined attributes for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_predefined_attributes method.
boto3 documentation
# list_predefined_attributes method definition
def list_predefined_attributes(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPredefinedAttributesResponseTypeDef: # (1)
...# list_predefined_attributes method usage example with argument unpacking
kwargs: ListPredefinedAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_predefined_attributes(**kwargs)list_prompts#
Provides information about the prompts for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_prompts method.
boto3 documentation
# list_prompts method definition
def list_prompts(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListPromptsResponseTypeDef: # (1)
...# list_prompts method usage example with argument unpacking
kwargs: ListPromptsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_prompts(**kwargs)list_queue_quick_connects#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_queue_quick_connects method.
boto3 documentation
# list_queue_quick_connects method definition
def list_queue_quick_connects(
self,
*,
InstanceId: str,
QueueId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQueueQuickConnectsResponseTypeDef: # (1)
...# list_queue_quick_connects method usage example with argument unpacking
kwargs: ListQueueQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.list_queue_quick_connects(**kwargs)list_queues#
Provides information about the queues for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_queues method.
boto3 documentation
# list_queues method definition
def list_queues(
self,
*,
InstanceId: str,
QueueTypes: Sequence[QueueTypeType] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQueuesResponseTypeDef: # (2)
...# list_queues method usage example with argument unpacking
kwargs: ListQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_queues(**kwargs)list_quick_connects#
Provides information about the quick connects for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_quick_connects method.
boto3 documentation
# list_quick_connects method definition
def list_quick_connects(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
QuickConnectTypes: Sequence[QuickConnectTypeType] = ..., # (1)
) -> ListQuickConnectsResponseTypeDef: # (2)
...# list_quick_connects method usage example with argument unpacking
kwargs: ListQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_quick_connects(**kwargs)list_realtime_contact_analysis_segments_v2#
Provides a list of analysis segments for a real-time analysis session.
Type annotations and code completion for boto3.client("connect").list_realtime_contact_analysis_segments_v2 method.
boto3 documentation
# list_realtime_contact_analysis_segments_v2 method definition
def list_realtime_contact_analysis_segments_v2(
self,
*,
InstanceId: str,
ContactId: str,
OutputType: RealTimeContactAnalysisOutputTypeType, # (1)
SegmentTypes: Sequence[RealTimeContactAnalysisSegmentTypeType], # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef: # (3)
...- See RealTimeContactAnalysisOutputTypeType
- See RealTimeContactAnalysisSegmentTypeType
- See ListRealtimeContactAnalysisSegmentsV2ResponseTypeDef
# list_realtime_contact_analysis_segments_v2 method usage example with argument unpacking
kwargs: ListRealtimeContactAnalysisSegmentsV2RequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"OutputType": ...,
"SegmentTypes": ...,
}
parent.list_realtime_contact_analysis_segments_v2(**kwargs)list_routing_profile_queues#
Lists the queues associated with a routing profile.
Type annotations and code completion for boto3.client("connect").list_routing_profile_queues method.
boto3 documentation
# list_routing_profile_queues method definition
def list_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRoutingProfileQueuesResponseTypeDef: # (1)
...# list_routing_profile_queues method usage example with argument unpacking
kwargs: ListRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.list_routing_profile_queues(**kwargs)list_routing_profiles#
Provides summary information about the routing profiles for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_routing_profiles method.
boto3 documentation
# list_routing_profiles method definition
def list_routing_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRoutingProfilesResponseTypeDef: # (1)
...# list_routing_profiles method usage example with argument unpacking
kwargs: ListRoutingProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_routing_profiles(**kwargs)list_rules#
List all rules for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_rules method.
boto3 documentation
# list_rules method definition
def list_rules(
self,
*,
InstanceId: str,
PublishStatus: RulePublishStatusType = ..., # (1)
EventSourceName: EventSourceNameType = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListRulesResponseTypeDef: # (3)
...# list_rules method usage example with argument unpacking
kwargs: ListRulesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_rules(**kwargs)list_security_keys#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").list_security_keys method.
boto3 documentation
# list_security_keys method definition
def list_security_keys(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityKeysResponseTypeDef: # (1)
...# list_security_keys method usage example with argument unpacking
kwargs: ListSecurityKeysRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_security_keys(**kwargs)list_security_profile_applications#
Returns a list of third-party applications in a specific security profile.
Type annotations and code completion for boto3.client("connect").list_security_profile_applications method.
boto3 documentation
# list_security_profile_applications method definition
def list_security_profile_applications(
self,
*,
SecurityProfileId: str,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityProfileApplicationsResponseTypeDef: # (1)
...# list_security_profile_applications method usage example with argument unpacking
kwargs: ListSecurityProfileApplicationsRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.list_security_profile_applications(**kwargs)list_security_profile_permissions#
Lists the permissions granted to a security profile.
Type annotations and code completion for boto3.client("connect").list_security_profile_permissions method.
boto3 documentation
# list_security_profile_permissions method definition
def list_security_profile_permissions(
self,
*,
SecurityProfileId: str,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityProfilePermissionsResponseTypeDef: # (1)
...# list_security_profile_permissions method usage example with argument unpacking
kwargs: ListSecurityProfilePermissionsRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.list_security_profile_permissions(**kwargs)list_security_profiles#
Provides summary information about the security profiles for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_security_profiles method.
boto3 documentation
# list_security_profiles method definition
def list_security_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSecurityProfilesResponseTypeDef: # (1)
...# list_security_profiles method usage example with argument unpacking
kwargs: ListSecurityProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_security_profiles(**kwargs)list_tags_for_resource#
Lists the tags for the specified resource.
Type annotations and code completion for boto3.client("connect").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_task_templates#
Lists task templates for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_task_templates method.
boto3 documentation
# list_task_templates method definition
def list_task_templates(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
Status: TaskTemplateStatusType = ..., # (1)
Name: str = ...,
) -> ListTaskTemplatesResponseTypeDef: # (2)
...# list_task_templates method usage example with argument unpacking
kwargs: ListTaskTemplatesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_task_templates(**kwargs)list_traffic_distribution_group_users#
Lists traffic distribution group users.
Type annotations and code completion for boto3.client("connect").list_traffic_distribution_group_users method.
boto3 documentation
# list_traffic_distribution_group_users method definition
def list_traffic_distribution_group_users(
self,
*,
TrafficDistributionGroupId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTrafficDistributionGroupUsersResponseTypeDef: # (1)
...# list_traffic_distribution_group_users method usage example with argument unpacking
kwargs: ListTrafficDistributionGroupUsersRequestRequestTypeDef = { # (1)
"TrafficDistributionGroupId": ...,
}
parent.list_traffic_distribution_group_users(**kwargs)list_traffic_distribution_groups#
Lists traffic distribution groups.
Type annotations and code completion for boto3.client("connect").list_traffic_distribution_groups method.
boto3 documentation
# list_traffic_distribution_groups method definition
def list_traffic_distribution_groups(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
InstanceId: str = ...,
) -> ListTrafficDistributionGroupsResponseTypeDef: # (1)
...# list_traffic_distribution_groups method usage example with argument unpacking
kwargs: ListTrafficDistributionGroupsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_traffic_distribution_groups(**kwargs)list_use_cases#
Lists the use cases for the integration association.
Type annotations and code completion for boto3.client("connect").list_use_cases method.
boto3 documentation
# list_use_cases method definition
def list_use_cases(
self,
*,
InstanceId: str,
IntegrationAssociationId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUseCasesResponseTypeDef: # (1)
...# list_use_cases method usage example with argument unpacking
kwargs: ListUseCasesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IntegrationAssociationId": ...,
}
parent.list_use_cases(**kwargs)list_user_hierarchy_groups#
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_user_hierarchy_groups method.
boto3 documentation
# list_user_hierarchy_groups method definition
def list_user_hierarchy_groups(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUserHierarchyGroupsResponseTypeDef: # (1)
...# list_user_hierarchy_groups method usage example with argument unpacking
kwargs: ListUserHierarchyGroupsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_user_hierarchy_groups(**kwargs)list_user_proficiencies#
Lists proficiencies associated with a user.
Type annotations and code completion for boto3.client("connect").list_user_proficiencies method.
boto3 documentation
# list_user_proficiencies method definition
def list_user_proficiencies(
self,
*,
InstanceId: str,
UserId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUserProficienciesResponseTypeDef: # (1)
...# list_user_proficiencies method usage example with argument unpacking
kwargs: ListUserProficienciesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
}
parent.list_user_proficiencies(**kwargs)list_users#
Provides summary information about the users for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").list_users method.
boto3 documentation
# list_users method definition
def list_users(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...# list_users method usage example with argument unpacking
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_users(**kwargs)list_view_versions#
Returns all the available versions for the specified Amazon Connect instance and view identifier.
Type annotations and code completion for boto3.client("connect").list_view_versions method.
boto3 documentation
# list_view_versions method definition
def list_view_versions(
self,
*,
InstanceId: str,
ViewId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListViewVersionsResponseTypeDef: # (1)
...# list_view_versions method usage example with argument unpacking
kwargs: ListViewVersionsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
}
parent.list_view_versions(**kwargs)list_views#
Returns views in the given instance.
Type annotations and code completion for boto3.client("connect").list_views method.
boto3 documentation
# list_views method definition
def list_views(
self,
*,
InstanceId: str,
Type: ViewTypeType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListViewsResponseTypeDef: # (2)
...- See ViewTypeType
- See ListViewsResponseTypeDef
# list_views method usage example with argument unpacking
kwargs: ListViewsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.list_views(**kwargs)monitor_contact#
Initiates silent monitoring of a contact.
Type annotations and code completion for boto3.client("connect").monitor_contact method.
boto3 documentation
# monitor_contact method definition
def monitor_contact(
self,
*,
InstanceId: str,
ContactId: str,
UserId: str,
AllowedMonitorCapabilities: Sequence[MonitorCapabilityType] = ..., # (1)
ClientToken: str = ...,
) -> MonitorContactResponseTypeDef: # (2)
...# monitor_contact method usage example with argument unpacking
kwargs: MonitorContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"UserId": ...,
}
parent.monitor_contact(**kwargs)pause_contact#
Allows pausing an ongoing task contact.
Type annotations and code completion for boto3.client("connect").pause_contact method.
boto3 documentation
# pause_contact method definition
def pause_contact(
self,
*,
ContactId: str,
InstanceId: str,
ContactFlowId: str = ...,
) -> Dict[str, Any]:
...# pause_contact method usage example with argument unpacking
kwargs: PauseContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
}
parent.pause_contact(**kwargs)put_user_status#
Changes the current status of a user or agent in Amazon Connect.
Type annotations and code completion for boto3.client("connect").put_user_status method.
boto3 documentation
# put_user_status method definition
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)release_phone_number#
Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
Type annotations and code completion for boto3.client("connect").release_phone_number method.
boto3 documentation
# release_phone_number method definition
def release_phone_number(
self,
*,
PhoneNumberId: str,
ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# release_phone_number method usage example with argument unpacking
kwargs: ReleasePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.release_phone_number(**kwargs)replicate_instance#
Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
Type annotations and code completion for boto3.client("connect").replicate_instance method.
boto3 documentation
# replicate_instance method definition
def replicate_instance(
self,
*,
InstanceId: str,
ReplicaRegion: str,
ReplicaAlias: str,
ClientToken: str = ...,
) -> ReplicateInstanceResponseTypeDef: # (1)
...# replicate_instance method usage example with argument unpacking
kwargs: ReplicateInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ReplicaRegion": ...,
"ReplicaAlias": ...,
}
parent.replicate_instance(**kwargs)resume_contact#
Allows resuming a task contact in a paused state.
Type annotations and code completion for boto3.client("connect").resume_contact method.
boto3 documentation
# resume_contact method definition
def resume_contact(
self,
*,
ContactId: str,
InstanceId: str,
ContactFlowId: str = ...,
) -> Dict[str, Any]:
...# resume_contact method usage example with argument unpacking
kwargs: ResumeContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
}
parent.resume_contact(**kwargs)resume_contact_recording#
When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both.
Type annotations and code completion for boto3.client("connect").resume_contact_recording method.
boto3 documentation
# resume_contact_recording method definition
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)search_agent_statuses#
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_agent_statuses method.
boto3 documentation
# search_agent_statuses method definition
def search_agent_statuses(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: AgentStatusSearchFilterTypeDef = ..., # (1)
SearchCriteria: AgentStatusSearchCriteriaTypeDef = ..., # (2)
) -> SearchAgentStatusesResponseTypeDef: # (3)
...- See AgentStatusSearchFilterTypeDef
- See AgentStatusSearchCriteriaTypeDef
- See SearchAgentStatusesResponseTypeDef
# search_agent_statuses method usage example with argument unpacking
kwargs: SearchAgentStatusesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_agent_statuses(**kwargs)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 boto3.client("connect").search_available_phone_numbers method.
boto3 documentation
# search_available_phone_numbers method definition
def search_available_phone_numbers(
self,
*,
PhoneNumberCountryCode: PhoneNumberCountryCodeType, # (1)
PhoneNumberType: PhoneNumberTypeType, # (2)
TargetArn: str = ...,
InstanceId: str = ...,
PhoneNumberPrefix: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> SearchAvailablePhoneNumbersResponseTypeDef: # (3)
...- See PhoneNumberCountryCodeType
- See PhoneNumberTypeType
- See SearchAvailablePhoneNumbersResponseTypeDef
# search_available_phone_numbers method usage example with argument unpacking
kwargs: SearchAvailablePhoneNumbersRequestRequestTypeDef = { # (1)
"PhoneNumberCountryCode": ...,
"PhoneNumberType": ...,
}
parent.search_available_phone_numbers(**kwargs)search_contact_flow_modules#
Searches the flow modules in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_contact_flow_modules method.
boto3 documentation
# search_contact_flow_modules method definition
def search_contact_flow_modules(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: ContactFlowModuleSearchFilterTypeDef = ..., # (1)
SearchCriteria: ContactFlowModuleSearchCriteriaTypeDef = ..., # (2)
) -> SearchContactFlowModulesResponseTypeDef: # (3)
...- See ContactFlowModuleSearchFilterTypeDef
- See ContactFlowModuleSearchCriteriaTypeDef
- See SearchContactFlowModulesResponseTypeDef
# search_contact_flow_modules method usage example with argument unpacking
kwargs: SearchContactFlowModulesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_contact_flow_modules(**kwargs)search_contact_flows#
Searches the contact flows in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_contact_flows method.
boto3 documentation
# search_contact_flows method definition
def search_contact_flows(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: ContactFlowSearchFilterTypeDef = ..., # (1)
SearchCriteria: ContactFlowSearchCriteriaTypeDef = ..., # (2)
) -> SearchContactFlowsResponseTypeDef: # (3)
...- See ContactFlowSearchFilterTypeDef
- See ContactFlowSearchCriteriaTypeDef
- See SearchContactFlowsResponseTypeDef
# search_contact_flows method usage example with argument unpacking
kwargs: SearchContactFlowsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_contact_flows(**kwargs)search_contacts#
Searches contacts in an Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").search_contacts method.
boto3 documentation
# search_contacts method definition
def search_contacts(
self,
*,
InstanceId: str,
TimeRange: SearchContactsTimeRangeTypeDef, # (1)
SearchCriteria: SearchCriteriaTypeDef = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
Sort: SortTypeDef = ..., # (3)
) -> SearchContactsResponseTypeDef: # (4)
...- See SearchContactsTimeRangeTypeDef
- See SearchCriteriaTypeDef
- See SortTypeDef
- See SearchContactsResponseTypeDef
# search_contacts method usage example with argument unpacking
kwargs: SearchContactsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"TimeRange": ...,
}
parent.search_contacts(**kwargs)search_hours_of_operations#
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_hours_of_operations method.
boto3 documentation
# search_hours_of_operations method definition
def search_hours_of_operations(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: HoursOfOperationSearchFilterTypeDef = ..., # (1)
SearchCriteria: HoursOfOperationSearchCriteriaTypeDef = ..., # (2)
) -> SearchHoursOfOperationsResponseTypeDef: # (3)
...- See HoursOfOperationSearchFilterTypeDef
- See HoursOfOperationSearchCriteriaTypeDef
- See SearchHoursOfOperationsResponseTypeDef
# search_hours_of_operations method usage example with argument unpacking
kwargs: SearchHoursOfOperationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_hours_of_operations(**kwargs)search_predefined_attributes#
Searches predefined attributes that meet certain criteria.
Type annotations and code completion for boto3.client("connect").search_predefined_attributes method.
boto3 documentation
# search_predefined_attributes method definition
def search_predefined_attributes(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchCriteria: PredefinedAttributeSearchCriteriaTypeDef = ..., # (1)
) -> SearchPredefinedAttributesResponseTypeDef: # (2)
...# search_predefined_attributes method usage example with argument unpacking
kwargs: SearchPredefinedAttributesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_predefined_attributes(**kwargs)search_prompts#
Searches prompts in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_prompts method.
boto3 documentation
# search_prompts method definition
def search_prompts(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: PromptSearchFilterTypeDef = ..., # (1)
SearchCriteria: PromptSearchCriteriaTypeDef = ..., # (2)
) -> SearchPromptsResponseTypeDef: # (3)
...# search_prompts method usage example with argument unpacking
kwargs: SearchPromptsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_prompts(**kwargs)search_queues#
Searches queues in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_queues method.
boto3 documentation
# search_queues method definition
def search_queues(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: QueueSearchFilterTypeDef = ..., # (1)
SearchCriteria: QueueSearchCriteriaTypeDef = ..., # (2)
) -> SearchQueuesResponseTypeDef: # (3)
...# search_queues method usage example with argument unpacking
kwargs: SearchQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_queues(**kwargs)search_quick_connects#
Searches quick connects in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_quick_connects method.
boto3 documentation
# search_quick_connects method definition
def search_quick_connects(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: QuickConnectSearchFilterTypeDef = ..., # (1)
SearchCriteria: QuickConnectSearchCriteriaTypeDef = ..., # (2)
) -> SearchQuickConnectsResponseTypeDef: # (3)
...- See QuickConnectSearchFilterTypeDef
- See QuickConnectSearchCriteriaTypeDef
- See SearchQuickConnectsResponseTypeDef
# search_quick_connects method usage example with argument unpacking
kwargs: SearchQuickConnectsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_quick_connects(**kwargs)search_resource_tags#
Searches tags used in an Amazon Connect instance using optional search criteria.
Type annotations and code completion for boto3.client("connect").search_resource_tags method.
boto3 documentation
# search_resource_tags method definition
def search_resource_tags(
self,
*,
InstanceId: str,
ResourceTypes: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
SearchCriteria: ResourceTagsSearchCriteriaTypeDef = ..., # (1)
) -> SearchResourceTagsResponseTypeDef: # (2)
...# search_resource_tags method usage example with argument unpacking
kwargs: SearchResourceTagsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_resource_tags(**kwargs)search_routing_profiles#
Searches routing profiles in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_routing_profiles method.
boto3 documentation
# search_routing_profiles method definition
def search_routing_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: RoutingProfileSearchFilterTypeDef = ..., # (1)
SearchCriteria: RoutingProfileSearchCriteriaTypeDef = ..., # (2)
) -> SearchRoutingProfilesResponseTypeDef: # (3)
...- See RoutingProfileSearchFilterTypeDef
- See RoutingProfileSearchCriteriaTypeDef
- See SearchRoutingProfilesResponseTypeDef
# search_routing_profiles method usage example with argument unpacking
kwargs: SearchRoutingProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_routing_profiles(**kwargs)search_security_profiles#
Searches security profiles in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_security_profiles method.
boto3 documentation
# search_security_profiles method definition
def search_security_profiles(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchCriteria: SecurityProfileSearchCriteriaTypeDef = ..., # (1)
SearchFilter: SecurityProfilesSearchFilterTypeDef = ..., # (2)
) -> SearchSecurityProfilesResponseTypeDef: # (3)
...- See SecurityProfileSearchCriteriaTypeDef
- See SecurityProfilesSearchFilterTypeDef
- See SearchSecurityProfilesResponseTypeDef
# search_security_profiles method usage example with argument unpacking
kwargs: SearchSecurityProfilesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_security_profiles(**kwargs)search_user_hierarchy_groups#
Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_user_hierarchy_groups method.
boto3 documentation
# search_user_hierarchy_groups method definition
def search_user_hierarchy_groups(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: UserHierarchyGroupSearchFilterTypeDef = ..., # (1)
SearchCriteria: UserHierarchyGroupSearchCriteriaTypeDef = ..., # (2)
) -> SearchUserHierarchyGroupsResponseTypeDef: # (3)
...- See UserHierarchyGroupSearchFilterTypeDef
- See UserHierarchyGroupSearchCriteriaTypeDef
- See SearchUserHierarchyGroupsResponseTypeDef
# search_user_hierarchy_groups method usage example with argument unpacking
kwargs: SearchUserHierarchyGroupsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_user_hierarchy_groups(**kwargs)search_users#
Searches users in an Amazon Connect instance, with optional filtering.
Type annotations and code completion for boto3.client("connect").search_users method.
boto3 documentation
# search_users method definition
def search_users(
self,
*,
InstanceId: str,
NextToken: str = ...,
MaxResults: int = ...,
SearchFilter: UserSearchFilterTypeDef = ..., # (1)
SearchCriteria: UserSearchCriteriaTypeDef = ..., # (2)
) -> SearchUsersResponseTypeDef: # (3)
...# search_users method usage example with argument unpacking
kwargs: SearchUsersRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_users(**kwargs)search_vocabularies#
Searches for vocabularies within a specific Amazon Connect instance using
State, NameStartsWith, and LanguageCode.
Type annotations and code completion for boto3.client("connect").search_vocabularies method.
boto3 documentation
# search_vocabularies method definition
def search_vocabularies(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
State: VocabularyStateType = ..., # (1)
NameStartsWith: str = ...,
LanguageCode: VocabularyLanguageCodeType = ..., # (2)
) -> SearchVocabulariesResponseTypeDef: # (3)
...# search_vocabularies method usage example with argument unpacking
kwargs: SearchVocabulariesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.search_vocabularies(**kwargs)send_chat_integration_event#
Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
Type annotations and code completion for boto3.client("connect").send_chat_integration_event method.
boto3 documentation
# send_chat_integration_event method definition
def send_chat_integration_event(
self,
*,
SourceId: str,
DestinationId: str,
Event: ChatEventTypeDef, # (1)
Subtype: str = ...,
NewSessionDetails: NewSessionDetailsTypeDef = ..., # (2)
) -> SendChatIntegrationEventResponseTypeDef: # (3)
...# send_chat_integration_event method usage example with argument unpacking
kwargs: SendChatIntegrationEventRequestRequestTypeDef = { # (1)
"SourceId": ...,
"DestinationId": ...,
"Event": ...,
}
parent.send_chat_integration_event(**kwargs)start_attached_file_upload#
Provides a pre-signed Amazon S3 URL in response for uploading your content.
Type annotations and code completion for boto3.client("connect").start_attached_file_upload method.
boto3 documentation
# start_attached_file_upload method definition
def start_attached_file_upload(
self,
*,
InstanceId: str,
FileName: str,
FileSizeInBytes: int,
FileUseCaseType: FileUseCaseTypeType, # (1)
AssociatedResourceArn: str,
ClientToken: str = ...,
UrlExpiryInSeconds: int = ...,
CreatedBy: CreatedByInfoTypeDef = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> StartAttachedFileUploadResponseTypeDef: # (3)
...# start_attached_file_upload method usage example with argument unpacking
kwargs: StartAttachedFileUploadRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"FileName": ...,
"FileSizeInBytes": ...,
"FileUseCaseType": ...,
"AssociatedResourceArn": ...,
}
parent.start_attached_file_upload(**kwargs)start_chat_contact#
Initiates a flow to start a new chat for the customer.
Type annotations and code completion for boto3.client("connect").start_chat_contact method.
boto3 documentation
# start_chat_contact method definition
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 = ...,
SegmentAttributes: Mapping[str, SegmentAttributeValueTypeDef] = ..., # (4)
) -> StartChatContactResponseTypeDef: # (5)
...- See ParticipantDetailsTypeDef
- See ChatMessageTypeDef
- See PersistentChatTypeDef
- See SegmentAttributeValueTypeDef
- See StartChatContactResponseTypeDef
# start_chat_contact method usage example with argument unpacking
kwargs: StartChatContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
"ParticipantDetails": ...,
}
parent.start_chat_contact(**kwargs)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 boto3.client("connect").start_contact_evaluation method.
boto3 documentation
# start_contact_evaluation method definition
def start_contact_evaluation(
self,
*,
InstanceId: str,
ContactId: str,
EvaluationFormId: str,
ClientToken: str = ...,
) -> StartContactEvaluationResponseTypeDef: # (1)
...# start_contact_evaluation method usage example with argument unpacking
kwargs: StartContactEvaluationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"EvaluationFormId": ...,
}
parent.start_contact_evaluation(**kwargs)start_contact_recording#
Starts recording the contact: * If the API is called before the agent joins the call, recording starts when the agent joins the call.
Type annotations and code completion for boto3.client("connect").start_contact_recording method.
boto3 documentation
# start_contact_recording method definition
def start_contact_recording(
self,
*,
InstanceId: str,
ContactId: str,
InitialContactId: str,
VoiceRecordingConfiguration: VoiceRecordingConfigurationTypeDef, # (1)
) -> Dict[str, Any]:
...# start_contact_recording method usage example with argument unpacking
kwargs: StartContactRecordingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"InitialContactId": ...,
"VoiceRecordingConfiguration": ...,
}
parent.start_contact_recording(**kwargs)start_contact_streaming#
Initiates real-time message streaming for a new chat contact.
Type annotations and code completion for boto3.client("connect").start_contact_streaming method.
boto3 documentation
# start_contact_streaming method definition
def start_contact_streaming(
self,
*,
InstanceId: str,
ContactId: str,
ChatStreamingConfiguration: ChatStreamingConfigurationTypeDef, # (1)
ClientToken: str,
) -> StartContactStreamingResponseTypeDef: # (2)
...# start_contact_streaming method usage example with argument unpacking
kwargs: StartContactStreamingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ChatStreamingConfiguration": ...,
"ClientToken": ...,
}
parent.start_contact_streaming(**kwargs)start_outbound_chat_contact#
Initiates a new outbound SMS contact to a customer.
Type annotations and code completion for boto3.client("connect").start_outbound_chat_contact method.
boto3 documentation
# start_outbound_chat_contact method definition
def start_outbound_chat_contact(
self,
*,
SourceEndpoint: EndpointTypeDef, # (1)
DestinationEndpoint: EndpointTypeDef, # (1)
InstanceId: str,
SegmentAttributes: Mapping[str, SegmentAttributeValueTypeDef], # (3)
ContactFlowId: str,
Attributes: Mapping[str, str] = ...,
ChatDurationInMinutes: int = ...,
ParticipantDetails: ParticipantDetailsTypeDef = ..., # (4)
InitialSystemMessage: ChatMessageTypeDef = ..., # (5)
RelatedContactId: str = ...,
SupportedMessagingContentTypes: Sequence[str] = ...,
ClientToken: str = ...,
) -> StartOutboundChatContactResponseTypeDef: # (6)
...- See EndpointTypeDef
- See EndpointTypeDef
- See SegmentAttributeValueTypeDef
- See ParticipantDetailsTypeDef
- See ChatMessageTypeDef
- See StartOutboundChatContactResponseTypeDef
# start_outbound_chat_contact method usage example with argument unpacking
kwargs: StartOutboundChatContactRequestRequestTypeDef = { # (1)
"SourceEndpoint": ...,
"DestinationEndpoint": ...,
"InstanceId": ...,
"SegmentAttributes": ...,
"ContactFlowId": ...,
}
parent.start_outbound_chat_contact(**kwargs)start_outbound_voice_contact#
Places an outbound call to a contact, and then initiates the flow.
Type annotations and code completion for boto3.client("connect").start_outbound_voice_contact method.
boto3 documentation
# start_outbound_voice_contact method definition
def start_outbound_voice_contact(
self,
*,
DestinationPhoneNumber: str,
ContactFlowId: str,
InstanceId: str,
Name: str = ...,
Description: str = ...,
References: Mapping[str, ReferenceTypeDef] = ..., # (1)
RelatedContactId: str = ...,
ClientToken: str = ...,
SourcePhoneNumber: str = ...,
QueueId: str = ...,
Attributes: Mapping[str, str] = ...,
AnswerMachineDetectionConfig: AnswerMachineDetectionConfigTypeDef = ..., # (2)
CampaignId: str = ...,
TrafficType: TrafficTypeType = ..., # (3)
) -> StartOutboundVoiceContactResponseTypeDef: # (4)
...- See ReferenceTypeDef
- See AnswerMachineDetectionConfigTypeDef
- See TrafficTypeType
- See StartOutboundVoiceContactResponseTypeDef
# start_outbound_voice_contact method usage example with argument unpacking
kwargs: StartOutboundVoiceContactRequestRequestTypeDef = { # (1)
"DestinationPhoneNumber": ...,
"ContactFlowId": ...,
"InstanceId": ...,
}
parent.start_outbound_voice_contact(**kwargs)start_screen_sharing#
Starts screen sharing for a contact.
Type annotations and code completion for boto3.client("connect").start_screen_sharing method.
boto3 documentation
# start_screen_sharing method definition
def start_screen_sharing(
self,
*,
InstanceId: str,
ContactId: str,
ClientToken: str = ...,
) -> Dict[str, Any]:
...# start_screen_sharing method usage example with argument unpacking
kwargs: StartScreenSharingRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.start_screen_sharing(**kwargs)start_task_contact#
Initiates a flow to start a new task contact.
Type annotations and code completion for boto3.client("connect").start_task_contact method.
boto3 documentation
# start_task_contact method definition
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: TimestampTypeDef = ...,
TaskTemplateId: str = ...,
QuickConnectId: str = ...,
RelatedContactId: str = ...,
) -> StartTaskContactResponseTypeDef: # (2)
...# start_task_contact method usage example with argument unpacking
kwargs: StartTaskContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
}
parent.start_task_contact(**kwargs)start_web_rtc_contact#
Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
Type annotations and code completion for boto3.client("connect").start_web_rtc_contact method.
boto3 documentation
# start_web_rtc_contact method definition
def start_web_rtc_contact(
self,
*,
ContactFlowId: str,
InstanceId: str,
ParticipantDetails: ParticipantDetailsTypeDef, # (1)
Attributes: Mapping[str, str] = ...,
ClientToken: str = ...,
AllowedCapabilities: AllowedCapabilitiesTypeDef = ..., # (2)
RelatedContactId: str = ...,
References: Mapping[str, ReferenceTypeDef] = ..., # (3)
Description: str = ...,
) -> StartWebRTCContactResponseTypeDef: # (4)
...- See ParticipantDetailsTypeDef
- See AllowedCapabilitiesTypeDef
- See ReferenceTypeDef
- See StartWebRTCContactResponseTypeDef
# start_web_rtc_contact method usage example with argument unpacking
kwargs: StartWebRTCContactRequestRequestTypeDef = { # (1)
"ContactFlowId": ...,
"InstanceId": ...,
"ParticipantDetails": ...,
}
parent.start_web_rtc_contact(**kwargs)stop_contact#
Ends the specified contact.
Type annotations and code completion for boto3.client("connect").stop_contact method.
boto3 documentation
# stop_contact method definition
def stop_contact(
self,
*,
ContactId: str,
InstanceId: str,
DisconnectReason: DisconnectReasonTypeDef = ..., # (1)
) -> Dict[str, Any]:
...# stop_contact method usage example with argument unpacking
kwargs: StopContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
}
parent.stop_contact(**kwargs)stop_contact_recording#
Stops recording a call when a contact is being recorded.
Type annotations and code completion for boto3.client("connect").stop_contact_recording method.
boto3 documentation
# stop_contact_recording method definition
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)stop_contact_streaming#
Ends message streaming on a specified contact.
Type annotations and code completion for boto3.client("connect").stop_contact_streaming method.
boto3 documentation
# stop_contact_streaming method definition
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)submit_contact_evaluation#
Submits a contact evaluation in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").submit_contact_evaluation method.
boto3 documentation
# submit_contact_evaluation method definition
def submit_contact_evaluation(
self,
*,
InstanceId: str,
EvaluationId: str,
Answers: Mapping[str, EvaluationAnswerInputTypeDef] = ..., # (1)
Notes: Mapping[str, EvaluationNoteTypeDef] = ..., # (2)
) -> SubmitContactEvaluationResponseTypeDef: # (3)
...- See EvaluationAnswerInputTypeDef
- See EvaluationNoteTypeDef
- See SubmitContactEvaluationResponseTypeDef
# submit_contact_evaluation method usage example with argument unpacking
kwargs: SubmitContactEvaluationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationId": ...,
}
parent.submit_contact_evaluation(**kwargs)suspend_contact_recording#
When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
Type annotations and code completion for boto3.client("connect").suspend_contact_recording method.
boto3 documentation
# suspend_contact_recording method definition
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)tag_contact#
Adds the specified tags to the contact resource.
Type annotations and code completion for boto3.client("connect").tag_contact method.
boto3 documentation
# tag_contact method definition
def tag_contact(
self,
*,
ContactId: str,
InstanceId: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...# tag_contact method usage example with argument unpacking
kwargs: TagContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
"Tags": ...,
}
parent.tag_contact(**kwargs)tag_resource#
Adds the specified tags to the specified resource.
Type annotations and code completion for boto3.client("connect").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)transfer_contact#
Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
Type annotations and code completion for boto3.client("connect").transfer_contact method.
boto3 documentation
# transfer_contact method definition
def transfer_contact(
self,
*,
InstanceId: str,
ContactId: str,
ContactFlowId: str,
QueueId: str = ...,
UserId: str = ...,
ClientToken: str = ...,
) -> TransferContactResponseTypeDef: # (1)
...# transfer_contact method usage example with argument unpacking
kwargs: TransferContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ContactFlowId": ...,
}
parent.transfer_contact(**kwargs)untag_contact#
Removes the specified tags from the contact resource.
Type annotations and code completion for boto3.client("connect").untag_contact method.
boto3 documentation
# untag_contact method definition
def untag_contact(
self,
*,
ContactId: str,
InstanceId: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_contact method usage example with argument unpacking
kwargs: UntagContactRequestRequestTypeDef = { # (1)
"ContactId": ...,
"InstanceId": ...,
"TagKeys": ...,
}
parent.untag_contact(**kwargs)untag_resource#
Removes the specified tags from the specified resource.
Type annotations and code completion for boto3.client("connect").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_agent_status#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_agent_status method.
boto3 documentation
# update_agent_status method definition
def update_agent_status(
self,
*,
InstanceId: str,
AgentStatusId: str,
Name: str = ...,
Description: str = ...,
State: AgentStatusStateType = ..., # (1)
DisplayOrder: int = ...,
ResetOrderNumber: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_agent_status method usage example with argument unpacking
kwargs: UpdateAgentStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AgentStatusId": ...,
}
parent.update_agent_status(**kwargs)update_authentication_profile#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_authentication_profile method.
boto3 documentation
# update_authentication_profile method definition
def update_authentication_profile(
self,
*,
AuthenticationProfileId: str,
InstanceId: str,
Name: str = ...,
Description: str = ...,
AllowedIps: Sequence[str] = ...,
BlockedIps: Sequence[str] = ...,
PeriodicSessionDuration: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_authentication_profile method usage example with argument unpacking
kwargs: UpdateAuthenticationProfileRequestRequestTypeDef = { # (1)
"AuthenticationProfileId": ...,
"InstanceId": ...,
}
parent.update_authentication_profile(**kwargs)update_contact#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_contact method.
boto3 documentation
# update_contact method definition
def update_contact(
self,
*,
InstanceId: str,
ContactId: str,
Name: str = ...,
Description: str = ...,
References: Mapping[str, ReferenceTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...- See ReferenceTypeDef
# update_contact method usage example with argument unpacking
kwargs: UpdateContactRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.update_contact(**kwargs)update_contact_attributes#
Creates or updates user-defined contact attributes associated with the specified contact.
Type annotations and code completion for boto3.client("connect").update_contact_attributes method.
boto3 documentation
# update_contact_attributes method definition
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)update_contact_evaluation#
Updates details about a contact evaluation in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_contact_evaluation method.
boto3 documentation
# update_contact_evaluation method definition
def update_contact_evaluation(
self,
*,
InstanceId: str,
EvaluationId: str,
Answers: Mapping[str, EvaluationAnswerInputTypeDef] = ..., # (1)
Notes: Mapping[str, EvaluationNoteTypeDef] = ..., # (2)
) -> UpdateContactEvaluationResponseTypeDef: # (3)
...- See EvaluationAnswerInputTypeDef
- See EvaluationNoteTypeDef
- See UpdateContactEvaluationResponseTypeDef
# update_contact_evaluation method usage example with argument unpacking
kwargs: UpdateContactEvaluationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationId": ...,
}
parent.update_contact_evaluation(**kwargs)update_contact_flow_content#
Updates the specified flow.
Type annotations and code completion for boto3.client("connect").update_contact_flow_content method.
boto3 documentation
# update_contact_flow_content method definition
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)update_contact_flow_metadata#
Updates metadata about specified flow.
Type annotations and code completion for boto3.client("connect").update_contact_flow_metadata method.
boto3 documentation
# update_contact_flow_metadata method definition
def update_contact_flow_metadata(
self,
*,
InstanceId: str,
ContactFlowId: str,
Name: str = ...,
Description: str = ...,
ContactFlowState: ContactFlowStateType = ..., # (1)
) -> Dict[str, Any]:
...# update_contact_flow_metadata method usage example with argument unpacking
kwargs: UpdateContactFlowMetadataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowId": ...,
}
parent.update_contact_flow_metadata(**kwargs)update_contact_flow_module_content#
Updates specified flow module for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_contact_flow_module_content method.
boto3 documentation
# update_contact_flow_module_content method definition
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)update_contact_flow_module_metadata#
Updates metadata about specified flow module.
Type annotations and code completion for boto3.client("connect").update_contact_flow_module_metadata method.
boto3 documentation
# update_contact_flow_module_metadata method definition
def update_contact_flow_module_metadata(
self,
*,
InstanceId: str,
ContactFlowModuleId: str,
Name: str = ...,
Description: str = ...,
State: ContactFlowModuleStateType = ..., # (1)
) -> Dict[str, Any]:
...# update_contact_flow_module_metadata method usage example with argument unpacking
kwargs: UpdateContactFlowModuleMetadataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactFlowModuleId": ...,
}
parent.update_contact_flow_module_metadata(**kwargs)update_contact_flow_name#
The name of the flow.
Type annotations and code completion for boto3.client("connect").update_contact_flow_name method.
boto3 documentation
# update_contact_flow_name method definition
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)update_contact_routing_data#
Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
Type annotations and code completion for boto3.client("connect").update_contact_routing_data method.
boto3 documentation
# update_contact_routing_data method definition
def update_contact_routing_data(
self,
*,
InstanceId: str,
ContactId: str,
QueueTimeAdjustmentSeconds: int = ...,
QueuePriority: int = ...,
RoutingCriteria: RoutingCriteriaInputTypeDef = ..., # (1)
) -> Dict[str, Any]:
...# update_contact_routing_data method usage example with argument unpacking
kwargs: UpdateContactRoutingDataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
}
parent.update_contact_routing_data(**kwargs)update_contact_schedule#
Updates the scheduled time of a task contact that is already scheduled.
Type annotations and code completion for boto3.client("connect").update_contact_schedule method.
boto3 documentation
# update_contact_schedule method definition
def update_contact_schedule(
self,
*,
InstanceId: str,
ContactId: str,
ScheduledTime: TimestampTypeDef,
) -> Dict[str, Any]:
...# update_contact_schedule method usage example with argument unpacking
kwargs: UpdateContactScheduleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ScheduledTime": ...,
}
parent.update_contact_schedule(**kwargs)update_evaluation_form#
Updates details about a specific evaluation form version in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_evaluation_form method.
boto3 documentation
# update_evaluation_form method definition
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)
...- See EvaluationFormItemTypeDef
- See EvaluationFormScoringStrategyTypeDef
- See UpdateEvaluationFormResponseTypeDef
# update_evaluation_form method usage example with argument unpacking
kwargs: UpdateEvaluationFormRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"EvaluationFormId": ...,
"EvaluationFormVersion": ...,
"Title": ...,
"Items": ...,
}
parent.update_evaluation_form(**kwargs)update_hours_of_operation#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_hours_of_operation method.
boto3 documentation
# update_hours_of_operation method definition
def update_hours_of_operation(
self,
*,
InstanceId: str,
HoursOfOperationId: str,
Name: str = ...,
Description: str = ...,
TimeZone: str = ...,
Config: Sequence[HoursOfOperationConfigTypeDef] = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_hours_of_operation method usage example with argument unpacking
kwargs: UpdateHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"HoursOfOperationId": ...,
}
parent.update_hours_of_operation(**kwargs)update_instance_attribute#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_instance_attribute method.
boto3 documentation
# update_instance_attribute method definition
def update_instance_attribute(
self,
*,
InstanceId: str,
AttributeType: InstanceAttributeTypeType, # (1)
Value: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_instance_attribute method usage example with argument unpacking
kwargs: UpdateInstanceAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"AttributeType": ...,
"Value": ...,
}
parent.update_instance_attribute(**kwargs)update_instance_storage_config#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_instance_storage_config method.
boto3 documentation
# update_instance_storage_config method definition
def update_instance_storage_config(
self,
*,
InstanceId: str,
AssociationId: str,
ResourceType: InstanceStorageResourceTypeType, # (1)
StorageConfig: InstanceStorageConfigTypeDef, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...- See InstanceStorageResourceTypeType
- See InstanceStorageConfigTypeDef
- 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)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 boto3.client("connect").update_participant_role_config method.
boto3 documentation
# update_participant_role_config method definition
def update_participant_role_config(
self,
*,
InstanceId: str,
ContactId: str,
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfoTypeDef, # (1)
) -> Dict[str, Any]:
...# update_participant_role_config method usage example with argument unpacking
kwargs: UpdateParticipantRoleConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ContactId": ...,
"ChannelConfiguration": ...,
}
parent.update_participant_role_config(**kwargs)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 boto3.client("connect").update_phone_number method.
boto3 documentation
# update_phone_number method definition
def update_phone_number(
self,
*,
PhoneNumberId: str,
TargetArn: str = ...,
InstanceId: str = ...,
ClientToken: str = ...,
) -> UpdatePhoneNumberResponseTypeDef: # (1)
...# update_phone_number method usage example with argument unpacking
kwargs: UpdatePhoneNumberRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.update_phone_number(**kwargs)update_phone_number_metadata#
Updates a phone number's metadata.
Type annotations and code completion for boto3.client("connect").update_phone_number_metadata method.
boto3 documentation
# update_phone_number_metadata method definition
def update_phone_number_metadata(
self,
*,
PhoneNumberId: str,
PhoneNumberDescription: str = ...,
ClientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_phone_number_metadata method usage example with argument unpacking
kwargs: UpdatePhoneNumberMetadataRequestRequestTypeDef = { # (1)
"PhoneNumberId": ...,
}
parent.update_phone_number_metadata(**kwargs)update_predefined_attribute#
Updates a predefined attribute for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_predefined_attribute method.
boto3 documentation
# update_predefined_attribute method definition
def update_predefined_attribute(
self,
*,
InstanceId: str,
Name: str,
Values: PredefinedAttributeValuesTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_predefined_attribute method usage example with argument unpacking
kwargs: UpdatePredefinedAttributeRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Name": ...,
}
parent.update_predefined_attribute(**kwargs)update_prompt#
Updates a prompt.
Type annotations and code completion for boto3.client("connect").update_prompt method.
boto3 documentation
# update_prompt method definition
def update_prompt(
self,
*,
InstanceId: str,
PromptId: str,
Name: str = ...,
Description: str = ...,
S3Uri: str = ...,
) -> UpdatePromptResponseTypeDef: # (1)
...# update_prompt method usage example with argument unpacking
kwargs: UpdatePromptRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"PromptId": ...,
}
parent.update_prompt(**kwargs)update_queue_hours_of_operation#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_queue_hours_of_operation method.
boto3 documentation
# update_queue_hours_of_operation method definition
def update_queue_hours_of_operation(
self,
*,
InstanceId: str,
QueueId: str,
HoursOfOperationId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_queue_hours_of_operation method usage example with argument unpacking
kwargs: UpdateQueueHoursOfOperationRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"HoursOfOperationId": ...,
}
parent.update_queue_hours_of_operation(**kwargs)update_queue_max_contacts#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_queue_max_contacts method.
boto3 documentation
# update_queue_max_contacts method definition
def update_queue_max_contacts(
self,
*,
InstanceId: str,
QueueId: str,
MaxContacts: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_queue_max_contacts method usage example with argument unpacking
kwargs: UpdateQueueMaxContactsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.update_queue_max_contacts(**kwargs)update_queue_name#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_queue_name method.
boto3 documentation
# update_queue_name method definition
def update_queue_name(
self,
*,
InstanceId: str,
QueueId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_queue_name method usage example with argument unpacking
kwargs: UpdateQueueNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
}
parent.update_queue_name(**kwargs)update_queue_outbound_caller_config#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_queue_outbound_caller_config method.
boto3 documentation
# update_queue_outbound_caller_config method definition
def update_queue_outbound_caller_config(
self,
*,
InstanceId: str,
QueueId: str,
OutboundCallerConfig: OutboundCallerConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_queue_outbound_caller_config method usage example with argument unpacking
kwargs: UpdateQueueOutboundCallerConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"OutboundCallerConfig": ...,
}
parent.update_queue_outbound_caller_config(**kwargs)update_queue_status#
This API is in preview release for Amazon Connect and is subject to change.
Type annotations and code completion for boto3.client("connect").update_queue_status method.
boto3 documentation
# update_queue_status method definition
def update_queue_status(
self,
*,
InstanceId: str,
QueueId: str,
Status: QueueStatusType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_queue_status method usage example with argument unpacking
kwargs: UpdateQueueStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QueueId": ...,
"Status": ...,
}
parent.update_queue_status(**kwargs)update_quick_connect_config#
Updates the configuration settings for the specified quick connect.
Type annotations and code completion for boto3.client("connect").update_quick_connect_config method.
boto3 documentation
# update_quick_connect_config method definition
def update_quick_connect_config(
self,
*,
InstanceId: str,
QuickConnectId: str,
QuickConnectConfig: QuickConnectConfigTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_quick_connect_config method usage example with argument unpacking
kwargs: UpdateQuickConnectConfigRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
"QuickConnectConfig": ...,
}
parent.update_quick_connect_config(**kwargs)update_quick_connect_name#
Updates the name and description of a quick connect.
Type annotations and code completion for boto3.client("connect").update_quick_connect_name method.
boto3 documentation
# update_quick_connect_name method definition
def update_quick_connect_name(
self,
*,
InstanceId: str,
QuickConnectId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_quick_connect_name method usage example with argument unpacking
kwargs: UpdateQuickConnectNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"QuickConnectId": ...,
}
parent.update_quick_connect_name(**kwargs)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 boto3.client("connect").update_routing_profile_agent_availability_timer method.
boto3 documentation
# update_routing_profile_agent_availability_timer method definition
def update_routing_profile_agent_availability_timer(
self,
*,
InstanceId: str,
RoutingProfileId: str,
AgentAvailabilityTimer: AgentAvailabilityTimerType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# 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)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 boto3.client("connect").update_routing_profile_concurrency method.
boto3 documentation
# update_routing_profile_concurrency method definition
def update_routing_profile_concurrency(
self,
*,
InstanceId: str,
RoutingProfileId: str,
MediaConcurrencies: Sequence[MediaConcurrencyTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_routing_profile_concurrency method usage example with argument unpacking
kwargs: UpdateRoutingProfileConcurrencyRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"MediaConcurrencies": ...,
}
parent.update_routing_profile_concurrency(**kwargs)update_routing_profile_default_outbound_queue#
Updates the default outbound queue of a routing profile.
Type annotations and code completion for boto3.client("connect").update_routing_profile_default_outbound_queue method.
boto3 documentation
# update_routing_profile_default_outbound_queue method definition
def update_routing_profile_default_outbound_queue(
self,
*,
InstanceId: str,
RoutingProfileId: str,
DefaultOutboundQueueId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# 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)update_routing_profile_name#
Updates the name and description of a routing profile.
Type annotations and code completion for boto3.client("connect").update_routing_profile_name method.
boto3 documentation
# update_routing_profile_name method definition
def update_routing_profile_name(
self,
*,
InstanceId: str,
RoutingProfileId: str,
Name: str = ...,
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_routing_profile_name method usage example with argument unpacking
kwargs: UpdateRoutingProfileNameRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
}
parent.update_routing_profile_name(**kwargs)update_routing_profile_queues#
Updates the properties associated with a set of queues for a routing profile.
Type annotations and code completion for boto3.client("connect").update_routing_profile_queues method.
boto3 documentation
# update_routing_profile_queues method definition
def update_routing_profile_queues(
self,
*,
InstanceId: str,
RoutingProfileId: str,
QueueConfigs: Sequence[RoutingProfileQueueConfigTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_routing_profile_queues method usage example with argument unpacking
kwargs: UpdateRoutingProfileQueuesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"RoutingProfileId": ...,
"QueueConfigs": ...,
}
parent.update_routing_profile_queues(**kwargs)update_rule#
Updates a rule for the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_rule method.
boto3 documentation
# update_rule method definition
def update_rule(
self,
*,
RuleId: str,
InstanceId: str,
Name: str,
Function: str,
Actions: Sequence[RuleActionTypeDef], # (1)
PublishStatus: RulePublishStatusType, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...# update_rule method usage example with argument unpacking
kwargs: UpdateRuleRequestRequestTypeDef = { # (1)
"RuleId": ...,
"InstanceId": ...,
"Name": ...,
"Function": ...,
"Actions": ...,
"PublishStatus": ...,
}
parent.update_rule(**kwargs)update_security_profile#
Updates a security profile.
Type annotations and code completion for boto3.client("connect").update_security_profile method.
boto3 documentation
# update_security_profile method definition
def update_security_profile(
self,
*,
SecurityProfileId: str,
InstanceId: str,
Description: str = ...,
Permissions: Sequence[str] = ...,
AllowedAccessControlTags: Mapping[str, str] = ...,
TagRestrictedResources: Sequence[str] = ...,
Applications: Sequence[ApplicationTypeDef] = ..., # (1)
HierarchyRestrictedResources: Sequence[str] = ...,
AllowedAccessControlHierarchyGroupId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_security_profile method usage example with argument unpacking
kwargs: UpdateSecurityProfileRequestRequestTypeDef = { # (1)
"SecurityProfileId": ...,
"InstanceId": ...,
}
parent.update_security_profile(**kwargs)update_task_template#
Updates details about a specific task template in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_task_template method.
boto3 documentation
# update_task_template method definition
def update_task_template(
self,
*,
TaskTemplateId: str,
InstanceId: str,
Name: str = ...,
Description: str = ...,
ContactFlowId: str = ...,
Constraints: TaskTemplateConstraintsTypeDef = ..., # (1)
Defaults: TaskTemplateDefaultsTypeDef = ..., # (2)
Status: TaskTemplateStatusType = ..., # (3)
Fields: Sequence[TaskTemplateFieldTypeDef] = ..., # (4)
) -> UpdateTaskTemplateResponseTypeDef: # (5)
...- See TaskTemplateConstraintsTypeDef
- See TaskTemplateDefaultsTypeDef
- See TaskTemplateStatusType
- See TaskTemplateFieldTypeDef
- See UpdateTaskTemplateResponseTypeDef
# update_task_template method usage example with argument unpacking
kwargs: UpdateTaskTemplateRequestRequestTypeDef = { # (1)
"TaskTemplateId": ...,
"InstanceId": ...,
}
parent.update_task_template(**kwargs)update_traffic_distribution#
Updates the traffic distribution for a given traffic distribution group.
Type annotations and code completion for boto3.client("connect").update_traffic_distribution method.
boto3 documentation
# update_traffic_distribution method definition
def update_traffic_distribution(
self,
*,
Id: str,
TelephonyConfig: TelephonyConfigTypeDef = ..., # (1)
SignInConfig: SignInConfigTypeDef = ..., # (2)
AgentConfig: AgentConfigTypeDef = ..., # (3)
) -> Dict[str, Any]:
...# update_traffic_distribution method usage example with argument unpacking
kwargs: UpdateTrafficDistributionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_traffic_distribution(**kwargs)update_user_hierarchy#
Assigns the specified hierarchy group to the specified user.
Type annotations and code completion for boto3.client("connect").update_user_hierarchy method.
boto3 documentation
# update_user_hierarchy method definition
def update_user_hierarchy(
self,
*,
UserId: str,
InstanceId: str,
HierarchyGroupId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_user_hierarchy method usage example with argument unpacking
kwargs: UpdateUserHierarchyRequestRequestTypeDef = { # (1)
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy(**kwargs)update_user_hierarchy_group_name#
Updates the name of the user hierarchy group.
Type annotations and code completion for boto3.client("connect").update_user_hierarchy_group_name method.
boto3 documentation
# update_user_hierarchy_group_name method definition
def update_user_hierarchy_group_name(
self,
*,
Name: str,
HierarchyGroupId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_user_hierarchy_group_name method usage example with argument unpacking
kwargs: UpdateUserHierarchyGroupNameRequestRequestTypeDef = { # (1)
"Name": ...,
"HierarchyGroupId": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy_group_name(**kwargs)update_user_hierarchy_structure#
Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
Type annotations and code completion for boto3.client("connect").update_user_hierarchy_structure method.
boto3 documentation
# update_user_hierarchy_structure method definition
def update_user_hierarchy_structure(
self,
*,
HierarchyStructure: HierarchyStructureUpdateTypeDef, # (1)
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_user_hierarchy_structure method usage example with argument unpacking
kwargs: UpdateUserHierarchyStructureRequestRequestTypeDef = { # (1)
"HierarchyStructure": ...,
"InstanceId": ...,
}
parent.update_user_hierarchy_structure(**kwargs)update_user_identity_info#
Updates the identity information for the specified user.
Type annotations and code completion for boto3.client("connect").update_user_identity_info method.
boto3 documentation
# update_user_identity_info method definition
def update_user_identity_info(
self,
*,
IdentityInfo: UserIdentityInfoTypeDef, # (1)
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_user_identity_info method usage example with argument unpacking
kwargs: UpdateUserIdentityInfoRequestRequestTypeDef = { # (1)
"IdentityInfo": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_identity_info(**kwargs)update_user_phone_config#
Updates the phone configuration settings for the specified user.
Type annotations and code completion for boto3.client("connect").update_user_phone_config method.
boto3 documentation
# update_user_phone_config method definition
def update_user_phone_config(
self,
*,
PhoneConfig: UserPhoneConfigTypeDef, # (1)
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_user_phone_config method usage example with argument unpacking
kwargs: UpdateUserPhoneConfigRequestRequestTypeDef = { # (1)
"PhoneConfig": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_phone_config(**kwargs)update_user_proficiencies#
Updates the properties associated with the proficiencies of a user.
Type annotations and code completion for boto3.client("connect").update_user_proficiencies method.
boto3 documentation
# update_user_proficiencies method definition
def update_user_proficiencies(
self,
*,
InstanceId: str,
UserId: str,
UserProficiencies: Sequence[UserProficiencyTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_user_proficiencies method usage example with argument unpacking
kwargs: UpdateUserProficienciesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"UserId": ...,
"UserProficiencies": ...,
}
parent.update_user_proficiencies(**kwargs)update_user_routing_profile#
Assigns the specified routing profile to the specified user.
Type annotations and code completion for boto3.client("connect").update_user_routing_profile method.
boto3 documentation
# update_user_routing_profile method definition
def update_user_routing_profile(
self,
*,
RoutingProfileId: str,
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_user_routing_profile method usage example with argument unpacking
kwargs: UpdateUserRoutingProfileRequestRequestTypeDef = { # (1)
"RoutingProfileId": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_routing_profile(**kwargs)update_user_security_profiles#
Assigns the specified security profiles to the specified user.
Type annotations and code completion for boto3.client("connect").update_user_security_profiles method.
boto3 documentation
# update_user_security_profiles method definition
def update_user_security_profiles(
self,
*,
SecurityProfileIds: Sequence[str],
UserId: str,
InstanceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_user_security_profiles method usage example with argument unpacking
kwargs: UpdateUserSecurityProfilesRequestRequestTypeDef = { # (1)
"SecurityProfileIds": ...,
"UserId": ...,
"InstanceId": ...,
}
parent.update_user_security_profiles(**kwargs)update_view_content#
Updates the view content of the given view identifier in the specified Amazon Connect instance.
Type annotations and code completion for boto3.client("connect").update_view_content method.
boto3 documentation
# update_view_content method definition
def update_view_content(
self,
*,
InstanceId: str,
ViewId: str,
Status: ViewStatusType, # (1)
Content: ViewInputContentTypeDef, # (2)
) -> UpdateViewContentResponseTypeDef: # (3)
...# update_view_content method usage example with argument unpacking
kwargs: UpdateViewContentRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
"Status": ...,
"Content": ...,
}
parent.update_view_content(**kwargs)update_view_metadata#
Updates the view metadata.
Type annotations and code completion for boto3.client("connect").update_view_metadata method.
boto3 documentation
# update_view_metadata method definition
def update_view_metadata(
self,
*,
InstanceId: str,
ViewId: str,
Name: str = ...,
Description: str = ...,
) -> Dict[str, Any]:
...# update_view_metadata method usage example with argument unpacking
kwargs: UpdateViewMetadataRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"ViewId": ...,
}
parent.update_view_metadata(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("connect").get_paginator method with overloads.
client.get_paginator("get_metric_data")-> GetMetricDataPaginatorclient.get_paginator("list_agent_statuses")-> ListAgentStatusesPaginatorclient.get_paginator("list_approved_origins")-> ListApprovedOriginsPaginatorclient.get_paginator("list_authentication_profiles")-> ListAuthenticationProfilesPaginatorclient.get_paginator("list_bots")-> ListBotsPaginatorclient.get_paginator("list_contact_evaluations")-> ListContactEvaluationsPaginatorclient.get_paginator("list_contact_flow_modules")-> ListContactFlowModulesPaginatorclient.get_paginator("list_contact_flow_versions")-> ListContactFlowVersionsPaginatorclient.get_paginator("list_contact_flows")-> ListContactFlowsPaginatorclient.get_paginator("list_contact_references")-> ListContactReferencesPaginatorclient.get_paginator("list_default_vocabularies")-> ListDefaultVocabulariesPaginatorclient.get_paginator("list_evaluation_form_versions")-> ListEvaluationFormVersionsPaginatorclient.get_paginator("list_evaluation_forms")-> ListEvaluationFormsPaginatorclient.get_paginator("list_flow_associations")-> ListFlowAssociationsPaginatorclient.get_paginator("list_hours_of_operations")-> ListHoursOfOperationsPaginatorclient.get_paginator("list_instance_attributes")-> ListInstanceAttributesPaginatorclient.get_paginator("list_instance_storage_configs")-> ListInstanceStorageConfigsPaginatorclient.get_paginator("list_instances")-> ListInstancesPaginatorclient.get_paginator("list_integration_associations")-> ListIntegrationAssociationsPaginatorclient.get_paginator("list_lambda_functions")-> ListLambdaFunctionsPaginatorclient.get_paginator("list_lex_bots")-> ListLexBotsPaginatorclient.get_paginator("list_phone_numbers")-> ListPhoneNumbersPaginatorclient.get_paginator("list_phone_numbers_v2")-> ListPhoneNumbersV2Paginatorclient.get_paginator("list_predefined_attributes")-> ListPredefinedAttributesPaginatorclient.get_paginator("list_prompts")-> ListPromptsPaginatorclient.get_paginator("list_queue_quick_connects")-> ListQueueQuickConnectsPaginatorclient.get_paginator("list_queues")-> ListQueuesPaginatorclient.get_paginator("list_quick_connects")-> ListQuickConnectsPaginatorclient.get_paginator("list_routing_profile_queues")-> ListRoutingProfileQueuesPaginatorclient.get_paginator("list_routing_profiles")-> ListRoutingProfilesPaginatorclient.get_paginator("list_rules")-> ListRulesPaginatorclient.get_paginator("list_security_keys")-> ListSecurityKeysPaginatorclient.get_paginator("list_security_profile_applications")-> ListSecurityProfileApplicationsPaginatorclient.get_paginator("list_security_profile_permissions")-> ListSecurityProfilePermissionsPaginatorclient.get_paginator("list_security_profiles")-> ListSecurityProfilesPaginatorclient.get_paginator("list_task_templates")-> ListTaskTemplatesPaginatorclient.get_paginator("list_traffic_distribution_group_users")-> ListTrafficDistributionGroupUsersPaginatorclient.get_paginator("list_traffic_distribution_groups")-> ListTrafficDistributionGroupsPaginatorclient.get_paginator("list_use_cases")-> ListUseCasesPaginatorclient.get_paginator("list_user_hierarchy_groups")-> ListUserHierarchyGroupsPaginatorclient.get_paginator("list_user_proficiencies")-> ListUserProficienciesPaginatorclient.get_paginator("list_users")-> ListUsersPaginatorclient.get_paginator("list_view_versions")-> ListViewVersionsPaginatorclient.get_paginator("list_views")-> ListViewsPaginatorclient.get_paginator("search_agent_statuses")-> SearchAgentStatusesPaginatorclient.get_paginator("search_available_phone_numbers")-> SearchAvailablePhoneNumbersPaginatorclient.get_paginator("search_contact_flow_modules")-> SearchContactFlowModulesPaginatorclient.get_paginator("search_contact_flows")-> SearchContactFlowsPaginatorclient.get_paginator("search_contacts")-> SearchContactsPaginatorclient.get_paginator("search_hours_of_operations")-> SearchHoursOfOperationsPaginatorclient.get_paginator("search_predefined_attributes")-> SearchPredefinedAttributesPaginatorclient.get_paginator("search_prompts")-> SearchPromptsPaginatorclient.get_paginator("search_queues")-> SearchQueuesPaginatorclient.get_paginator("search_quick_connects")-> SearchQuickConnectsPaginatorclient.get_paginator("search_resource_tags")-> SearchResourceTagsPaginatorclient.get_paginator("search_routing_profiles")-> SearchRoutingProfilesPaginatorclient.get_paginator("search_security_profiles")-> SearchSecurityProfilesPaginatorclient.get_paginator("search_user_hierarchy_groups")-> SearchUserHierarchyGroupsPaginatorclient.get_paginator("search_users")-> SearchUsersPaginatorclient.get_paginator("search_vocabularies")-> SearchVocabulariesPaginator