connect_create_instance: This API is in preview release for Amazon Connect and is...

Description Usage Arguments Value Request syntax

View source: R/connect_operations.R

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 S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.

Usage

1
2
connect_create_instance(ClientToken, IdentityManagementType,
  InstanceAlias, DirectoryId, InboundCallsEnabled, OutboundCallsEnabled)

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] Whether your contact center handles incoming contacts.

OutboundCallsEnabled

[required] Whether your contact center allows outbound calls.

Value

A list with the following syntax:

1
2
3
4
list(
  Id = "string",
  Arn = "string"
)

Request syntax

1
2
3
4
5
6
7
8
svc$create_instance(
  ClientToken = "string",
  IdentityManagementType = "SAML"|"CONNECT_MANAGED"|"EXISTING_DIRECTORY",
  InstanceAlias = "string",
  DirectoryId = "string",
  InboundCallsEnabled = TRUE|FALSE,
  OutboundCallsEnabled = TRUE|FALSE
)

paws.customer.engagement documentation built on Aug. 23, 2021, 9:22 a.m.