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	aws.connect.agent_statuses

Fields

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, Name, State, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all agent_statuses in a region.

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

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 aws.connect.agent_statuses
WHERE region = 'us-east-1' AND data__Identifier = '<AgentStatusArn>';

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 aws.connect.agent_statuses (
 InstanceArn,
 Name,
 State,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ Name }}',
 '{{ State }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.agent_statuses (
 InstanceArn,
 Description,
 Name,
 DisplayOrder,
 State,
 Type,
 ResetOrderNumber,
 Tags,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ DisplayOrder }}',
 '{{ State }}',
 '{{ Type }}',
 '{{ ResetOrderNumber }}',
 '{{ 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: InstanceArn
        value: '{{ InstanceArn }}'
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: DisplayOrder
        value: '{{ DisplayOrder }}'
      - name: State
        value: '{{ State }}'
      - name: Type
        value: '{{ Type }}'
      - name: ResetOrderNumber
        value: '{{ ResetOrderNumber }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

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