Describe Instance

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

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

connect_describe_instance(InstanceId)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Value

A list with the following syntax:

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,
    InstanceAccessUrl = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax

svc$describe_instance(
  InstanceId = "string"
)