agent_statuses

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

Overview

Name	agent_statuses
Type	Resource
Id	aws.connect.agent_statuses

Fields

The following fields are returned by SELECT queries:

list_agent_statuses

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the agent status.
id	string	The identifier for an 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.
type	string	The type of the agent status. (ROUTABLE, CUSTOM, OFFLINE)

search_agent_statuses

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
list_agent_statuses	select	instance_id, region	nextToken, maxResults, AgentStatusTypes	Lists agent statuses.
search_agent_statuses	select	region		Searches AgentStatuses in an Connect Customer instance, with optional filtering.

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
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)
AgentStatusTypes	array	Available agent status types.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

list_agent_statuses

Lists agent statuses.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name,
type
FROM aws.connect.agent_statuses
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND AgentStatusTypes = '{{ AgentStatusTypes }}'
;

search_agent_statuses

Searches AgentStatuses in an Connect Customer instance, with optional filtering.

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