delegated_admin_accounts

Creates, updates, deletes, gets or lists a delegated_admin_accounts resource.

Overview

Name	delegated_admin_accounts
Type	Resource
Id	aws.inspector2.delegated_admin_accounts

Fields

The following fields are returned by SELECT queries:

get_delegated_admin_account

Name	Datatype	Description
account_id	string	The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization. (pattern: <code>\d{12}</code>)
relationship_status	string	The status of the Amazon Inspector delegated administrator. (CREATED, INVITED, DISABLED, ENABLED, REMOVED, RESIGNED, DELETED, EMAIL_VERIFICATION_IN_PROGRESS, EMAIL_VERIFICATION_FAILED, REGION_DISABLED, ACCOUNT_SUSPENDED, CANNOT_CREATE_DETECTOR_IN_ORG_MASTER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_delegated_admin_account	select	region		Retrieves information about the Amazon Inspector delegated administrator for your organization.
disable_delegated_admin_account	exec	region, delegatedAdminAccountId		Disables the Amazon Inspector delegated administrator for your organization.
enable_delegated_admin_account	exec	region, delegatedAdminAccountId		Enables the Amazon Inspector delegated administrator for your Organizations organization.
list_delegated_admin_accounts	exec	region		Lists information about the Amazon Inspector delegated administrator of your organization.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_delegated_admin_account

Retrieves information about the Amazon Inspector delegated administrator for your organization.

SELECT
account_id,
relationship_status
FROM aws.inspector2.delegated_admin_accounts
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

disable_delegated_admin_account

Disables the Amazon Inspector delegated administrator for your organization.

EXEC aws.inspector2.delegated_admin_accounts.disable_delegated_admin_account 
@region='{{ region }}' --required 
@@json=
'{
"delegatedAdminAccountId": "{{ delegatedAdminAccountId }}"
}'
;

enable_delegated_admin_account

Enables the Amazon Inspector delegated administrator for your Organizations organization.

EXEC aws.inspector2.delegated_admin_accounts.enable_delegated_admin_account 
@region='{{ region }}' --required 
@@json=
'{
"delegatedAdminAccountId": "{{ delegatedAdminAccountId }}", 
"clientToken": "{{ clientToken }}"
}'
;

list_delegated_admin_accounts

Lists information about the Amazon Inspector delegated administrator of your organization.

EXEC aws.inspector2.delegated_admin_accounts.list_delegated_admin_accounts 
@region='{{ region }}' --required 
@@json=
'{
"maxResults": {{ maxResults }}, 
"nextToken": "{{ nextToken }}"
}'
;