organization_admin_account#

State module for enabling organization admin account for Guardduty.

async idem_aws.states.aws.guardduty.organization_admin_account.present(hub, ctx, name: str, resource_id: str) → Dict[str, Any][source]#

Enables an Amazon Web Services account within the organization as the GuardDuty delegated administrator.

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str) – An identifier of the resource in the provider. Here it is the Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated administrator.

Request Syntax:
Returns:

Dict[str, Any]

Examples

resource_is_present:
  aws.guardduty.organization_admin_account.present:
    - name: value
    - resource_id: value
async idem_aws.states.aws.guardduty.organization_admin_account.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Disables an Amazon Web Services account within the Organization as the GuardDuty delegated administrator.

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated administrator.

Returns:

Dict[str, Any]

Examples

resource_is_absent:
  aws.guardduty.organization_admin_account.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.guardduty.organization_admin_account.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Lists the accounts configured as GuardDuty delegated administrators.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.guardduty.organization_admin_account