Skip to content

Create Agent Status

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

Creates an agent status for the specified Amazon Connect instance.

Usage

connect_create_agent_status(InstanceId, Name, Description, State,
  DisplayOrder, Tags)

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.

Name

[required] The name of the status.

Description

The description of the status.

State

[required] The state of the status.

DisplayOrder

The display order of the status.

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(
  AgentStatusARN = "string",
  AgentStatusId = "string"
)

Request syntax

svc$create_agent_status(
  InstanceId = "string",
  Name = "string",
  Description = "string",
  State = "ENABLED"|"DISABLED",
  DisplayOrder = 123,
  Tags = list(
    "string"
  )
)