Create Instance

connect_create_instance

R Documentation

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

Description

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

Initiates an Amazon Connect 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 Amazon Connect.

For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.

Amazon Connect 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.

Usage

connect_create_instance(ClientToken, IdentityManagementType,
  InstanceAlias, DirectoryId, InboundCallsEnabled, OutboundCallsEnabled,
  Tags)

Arguments

ClientToken

The idempotency token.

IdentityManagementType

[required] The type of identity management for your Amazon Connect users.

InstanceAlias

The name for your instance.

DirectoryId

The identifier for the directory.

InboundCallsEnabled

[required] Your contact center handles incoming contacts.

OutboundCallsEnabled

[required] Your contact center allows outbound calls.

Tags

The tags used to organize, track, or control access for this resource. For example, ⁠{ "tags": {"key1":"value1", "key2":"value2"} }⁠.

Value

A list with the following syntax:

list(
  Id = "string",
  Arn = "string"
)

Request syntax

svc$create_instance(
  ClientToken = "string",
  IdentityManagementType = "SAML"|"CONNECT_MANAGED"|"EXISTING_DIRECTORY",
  InstanceAlias = "string",
  DirectoryId = "string",
  InboundCallsEnabled = TRUE|FALSE,
  OutboundCallsEnabled = TRUE|FALSE,
  Tags = list(
    "string"
  )
)