instance_onboarding_job_status

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

Overview

Name	instance_onboarding_job_status
Type	Resource
Id	aws.connectcampaignsv2.instance_onboarding_job_status

Fields

The following fields are returned by SELECT queries:

get_instance_onboarding_job_status

Name	Datatype	Description
connect_instance_id	string	Amazon Connect Instance Id (pattern: <code>[-_.a-zA-Z0-9]+</code>)
failure_code	string	Enumeration of the possible failure codes for instance onboarding job (EVENT_BRIDGE_ACCESS_DENIED, EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED, IAM_ACCESS_DENIED, KMS_ACCESS_DENIED, KMS_KEY_NOT_FOUND, INTERNAL_FAILURE)
status	string	Enumeration of the possible states for instance onboarding job (IN_PROGRESS, SUCCEEDED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instance_onboarding_job_status	select	connect_instance_id, region		Get the specific instance onboarding job 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
connect_instance_id	string
region	string	AWS region (default: us-east-1)

SELECT examples

get_instance_onboarding_job_status

Get the specific instance onboarding job status.

SELECT
connect_instance_id,
failure_code,
status
FROM aws.connectcampaignsv2.instance_onboarding_job_status
WHERE connect_instance_id = '{{ connect_instance_id }}' -- required
AND region = '{{ region }}' -- required
;