agent_statuses

Creates, updates, deletes or gets an agent_status resource or lists agent_statuses in a region

Overview

Name	agent_statuses
Type	Resource
Description	Resource Type definition for AWS::Connect::AgentStatus
Id	awscc.connect.agent_statuses

Fields

get (all properties)

Name	Datatype	Description
instance_arn	string	The identifier of the Amazon Connect instance.
agent_status_arn	string	The Amazon Resource Name (ARN) of the agent status.
description	string	The description of the status.
name	string	The name of the status.
display_order	integer	The display order of the status.
state	string	The state of the status.
type	string	The type of agent status.
reset_order_number	boolean	A number indicating the reset order of the agent status.
▶tags	array	An array of key-value pairs to apply to this resource.
last_modified_region	string	Last modified region.
last_modified_time	number	Last modified time.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
agent_status_arn	string	The Amazon Resource Name (ARN) of the agent status.
region	string	AWS region.

For more information, see AWS::Connect::AgentStatus.

Methods

Name	Resource	Accessible by	Required Params
create_resource	agent_statuses	INSERT	InstanceArn, Name, State, region
update_resource	agent_statuses	UPDATE	Identifier, PatchDocument, region
list_resources	agent_statuses_list_only	SELECT	region
get_resource	agent_statuses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual agent_status.

SELECT
  region,
  instance_arn,
  agent_status_arn,
  description,
  name,
  display_order,
  state,
  type,
  reset_order_number,
  tags,
  last_modified_region,
  last_modified_time
FROM awscc.connect.agent_statuses
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ agent_status_arn }}';

list (identifiers only)

Lists all agent_statuses in a region.

SELECT
  region,
  agent_status_arn
FROM awscc.connect.agent_statuses_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new agent_status resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.connect.agent_statuses (
  InstanceArn,
  Name,
  State,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ name }}',
  '{{ state }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.connect.agent_statuses (
  InstanceArn,
  Description,
  Name,
  DisplayOrder,
  State,
  Type,
  ResetOrderNumber,
  Tags,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ description }}',
  '{{ name }}',
  '{{ display_order }}',
  '{{ state }}',
  '{{ type }}',
  '{{ reset_order_number }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: agent_status
    props:
      - name: instance_arn
        value: '{{ instance_arn }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: display_order
        value: '{{ display_order }}'
      - name: state
        value: '{{ state }}'
      - name: type
        value: '{{ type }}'
      - name: reset_order_number
        value: '{{ reset_order_number }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a agent_status resource, using stack-deploy.

/*+ update */
UPDATE awscc.connect.agent_statuses
SET PatchDocument = string('{{ {
    "InstanceArn": instance_arn,
    "Description": description,
    "Name": name,
    "DisplayOrder": display_order,
    "State": state,
    "Type": type,
    "ResetOrderNumber": reset_order_number,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ agent_status_arn }}';

Permissions

To operate on the agent_statuses resource, the following permissions are required:

Create

connect:CreateAgentStatus,
connect:TagResource,
connect:ListAgentStatuses

Read

connect:DescribeAgentStatus

Update

connect:UpdateAgentStatus,
connect:UntagResource,
connect:TagResource

List

connect:ListAgentStatuses