connect_describe_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.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Usage

1

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
list(
  Instance = list(
    Id = "string",
    Arn = "string",
    IdentityManagementType = "SAML"|"CONNECT_MANAGED"|"EXISTING_DIRECTORY",
    InstanceAlias = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    ServiceRole = "string",
    InstanceStatus = "CREATION_IN_PROGRESS"|"ACTIVE"|"CREATION_FAILED",
    StatusReason = list(
      Message = "string"
    ),
    InboundCallsEnabled = TRUE|FALSE,
    OutboundCallsEnabled = TRUE|FALSE
  )
)

Request syntax

1
2
3
svc$describe_instance(
  InstanceId = "string"
)

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