create_instance
¶
create_instance(
identity_management_type: DirectoryType,
inbound_calls_enabled: InboundCallsEnabled,
outbound_calls_enabled: OutboundCallsEnabled,
*,
config_overrides: Optional[ConnectClientConfig] = None,
client_token: Optional[ClientToken] = None,
instance_alias: Optional[DirectoryAlias] = None,
directory_id: Optional[DirectoryId] = None,
tags: Optional[TagMap] = None,
) -> CreateInstanceResponse
This API is in preview release for Connect Customer and is subject to change.
Initiates an Connect Customer instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Connect Customer.
For more information, see Create an Connect Customer instance in the Connect Customer Administrator Guide.
Connect Customer enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
Parameters:
-
client_token(Optional[ClientToken], default:None) –The idempotency token.
-
identity_management_type(DirectoryType) –The type of identity management for your Connect Customer users.
-
instance_alias(Optional[DirectoryAlias], default:None) –The name for your instance.
-
directory_id(Optional[DirectoryId], default:None) –The identifier for the directory.
-
inbound_calls_enabled(InboundCallsEnabled) –Your contact center handles incoming contacts.
-
outbound_calls_enabled(OutboundCallsEnabled) –Your contact center allows outbound calls.
-
tags(Optional[TagMap], default:None) –The tags used to organize, track, or control access for this resource. For example,
{ "tags": {"key1":"value1", "key2":"value2"} }.
Raises:
-
InternalServiceException–Request processing failed because of an error or failure with the service.
-
InvalidRequestException–The request is not valid.
-
ResourceNotFoundException–The specified resource was not found.
-
ServiceQuotaExceededException–The service quota has been exceeded.
-
ThrottlingException–The throttling limit has been exceeded.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_connect/_services/connect.py
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 | |