member_ec2_deep_inspection_status
Creates, updates, deletes, gets or lists a member_ec2_deep_inspection_status resource.
Overview
| Name | member_ec2_deep_inspection_status |
| Type | Resource |
| Id | aws.inspector2.member_ec2_deep_inspection_status |
Fields
The following fields are returned by SELECT queries:
- batch_get_member_ec2_deep_inspection_status
| Name | Datatype | Description |
|---|---|---|
account_ids | array | An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts. |
failed_account_ids | array | An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
batch_get_member_ec2_deep_inspection_status | select | region | Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API. | |
batch_update_member_ec2_deep_inspection_status | exec | region, accountIds | Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API. |
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
- batch_get_member_ec2_deep_inspection_status
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
SELECT
account_ids,
failed_account_ids
FROM aws.inspector2.member_ec2_deep_inspection_status
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- batch_update_member_ec2_deep_inspection_status
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.
EXEC aws.inspector2.member_ec2_deep_inspection_status.batch_update_member_ec2_deep_inspection_status
@region='{{ region }}' --required
@@json=
'{
"accountIds": "{{ accountIds }}"
}'
;