[ aws . configservice ]

get-organization-config-rule-detailed-status

Description

Returns detailed status for each member account within an organization for a given organization config rule.

Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-organization-config-rule-detailed-status
--organization-config-rule-name <value>
[--filters <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--organization-config-rule-name (string)

The name of organization config rule for which you want status details for member accounts.

--filters (structure)

A StatusDetailFilters object.

AccountId -> (string)

The 12-digit account ID of the member account within an organization.

MemberAccountRuleStatus -> (string)

Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .

AWS Config sets the state of the rule to:

• CREATE_SUCCESSFUL when config rule has been created in the member account.

• CREATE_IN_PROGRESS when config rule is being created in the member account.

• CREATE_FAILED when config rule creation has failed in the member account.

• DELETE_FAILED when config rule deletion has failed in the member account.

• DELETE_IN_PROGRESS when config rule is being deleted in the member account.

• DELETE_SUCCESSFUL when config rule has been deleted in the member account.

• UPDATE_SUCCESSFUL when config rule has been updated in the member account.

• UPDATE_IN_PROGRESS when config rule is being updated in the member account.

• UPDATE_FAILED when config rule deletion has failed in the member account.

Shorthand Syntax:

AccountId=string,MemberAccountRuleStatus=string

JSON Syntax:

{
  "AccountId": "string",
  "MemberAccountRuleStatus": "CREATE_SUCCESSFUL"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_SUCCESSFUL"|"DELETE_FAILED"|"DELETE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"
}

--limit (integer)

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.

--next-token (string)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

OrganizationConfigRuleDetailedStatus -> (list)

A list of MemberAccountStatus objects.

(structure)

Organization config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

AccountId -> (string)

The 12-digit account ID of a member account.

ConfigRuleName -> (string)

The name of config rule deployed in the member account.

MemberAccountRuleStatus -> (string)

Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .

AWS Config sets the state of the rule to:

• CREATE_SUCCESSFUL when config rule has been created in the member account.

• CREATE_IN_PROGRESS when config rule is being created in the member account.

• CREATE_FAILED when config rule creation has failed in the member account.

• DELETE_FAILED when config rule deletion has failed in the member account.

• DELETE_IN_PROGRESS when config rule is being deleted in the member account.

• DELETE_SUCCESSFUL when config rule has been deleted in the member account.

• UPDATE_SUCCESSFUL when config rule has been updated in the member account.

• UPDATE_IN_PROGRESS when config rule is being updated in the member account.

• UPDATE_FAILED when config rule deletion has failed in the member account.

ErrorCode -> (string)

An error code that is returned when config rule creation or deletion failed in the member account.

ErrorMessage -> (string)

An error message indicating that config rule account creation or deletion has failed due to an error in the member account.

LastUpdateTime -> (timestamp)

The timestamp of the last status update.

NextToken -> (string)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.