create-agent-status¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-agent-status
--instance-id <value>
--name <value>
[--description <value>]
--state <value>
[--display-order <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--instance-id (string)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
--name (string)
The name of the status.
--description (string)
The description of the status.
--state (string)
The state of the status.
Possible values:
ENABLED
DISABLED
--display-order (integer)
The display order of the status.
--tags (map)
One or more tags.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
AgentStatusARN -> (string)
The Amazon Resource Name (ARN) of the agent status.
AgentStatusId -> (string)
The identifier of the agent status.