agent_status

Creates, updates, deletes, gets or lists an agent_status resource.

Overview

Name	agent_status
Type	Resource
Id	aws.connect.agent_status

Fields

The following fields are returned by SELECT queries:

describe_agent_status

Name	Datatype	Description
agent_status_arn	string	The Amazon Resource Name (ARN) of the agent status.
agent_status_id	string	The identifier of the agent status.
description	string	The description of the agent status.
display_order	integer	The display order of the agent status.
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the agent status.
state	string	The state of the agent status. (ENABLED, DISABLED)
tags	object	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
type	string	The type of agent status. (ROUTABLE, CUSTOM, OFFLINE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_agent_status	select	instance_id, agent_status_id, region		Describes an agent status.
create_agent_status	insert	instance_id, region, Name, State		Creates an agent status for the specified Connect Customer instance.
update_agent_status	update	instance_id, agent_status_id, region		Updates agent status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_status_id	string	The identifier of the agent status.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_agent_status

Describes an agent status.

SELECT
agent_status_arn,
agent_status_id,
description,
display_order,
last_modified_region,
last_modified_time,
name,
state,
tags,
type
FROM aws.connect.agent_status
WHERE instance_id = '{{ instance_id }}' -- required
AND agent_status_id = '{{ agent_status_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_agent_status

Creates an agent status for the specified Connect Customer instance.

INSERT INTO aws.connect.agent_status (
Name,
Description,
State,
DisplayOrder,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ State }}' /* required */,
{{ DisplayOrder }},
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
agent_status_arn,
agent_status_id
;

Manifest

# Description fields are for documentation purposes
- name: agent_status
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the agent_status resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_status resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: State
    value: "{{ State }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: DisplayOrder
    value: {{ DisplayOrder }}
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_agent_status

Updates agent status.

UPDATE aws.connect.agent_status
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
State = '{{ State }}',
DisplayOrder = {{ DisplayOrder }},
ResetOrderNumber = {{ ResetOrderNumber }}
WHERE 
instance_id = '{{ instance_id }}' --required
AND agent_status_id = '{{ agent_status_id }}' --required
AND region = '{{ region }}' --required;