List Instances

connect_list_instances

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.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Usage¶

connect_list_instances(NextToken, MaxResults)

Arguments¶

NextToken: The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
MaxResults: The maximum number of results to return per page.

Value¶

A list with the following syntax:

list(
  InstanceSummaryList = list(
    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",
      InboundCallsEnabled = TRUE|FALSE,
      OutboundCallsEnabled = TRUE|FALSE,
      InstanceAccessUrl = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_instances(
  NextToken = "string",
  MaxResults = 123
)