[ aws . configservice ]

describe-organization-config-rule-statuses

Description

Provides organization config rule deployment status for an organization.

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.

Note

The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-organization-config-rule-statuses
[--organization-config-rule-names <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--organization-config-rule-names (list)

The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.

(string)

Syntax:

"string" "string" ...

--limit (integer)

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no 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

OrganizationConfigRuleStatuses -> (list)

A list of OrganizationConfigRuleStatus objects.

(structure)

Returns the status for an organization config rule in an organization.

OrganizationConfigRuleName -> (string)

The name that you assign to organization config rule.

OrganizationRuleStatus -> (string)

Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts. Additionally, config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com .

AWS Config sets the state of the rule to:

• CREATE_SUCCESSFUL when an organization config rule has been successfully created in all the member accounts.

• CREATE_IN_PROGRESS when an organization config rule creation is in progress.

• CREATE_FAILED when an organization config rule creation failed in one or more member accounts within that organization.

• DELETE_FAILED when an organization config rule deletion failed in one or more member accounts within that organization.

• DELETE_IN_PROGRESS when an organization config rule deletion is in progress.

• DELETE_SUCCESSFUL when an organization config rule has been successfully deleted from all the member accounts.

• UPDATE_SUCCESSFUL when an organization config rule has been successfully updated in all the member accounts.

• UPDATE_IN_PROGRESS when an organization config rule update is in progress.

• UPDATE_FAILED when an organization config rule update failed in one or more member accounts within that organization.

ErrorCode -> (string)

An error code that is returned when organization config rule creation or deletion has failed.

ErrorMessage -> (string)

An error message indicating that organization config rule creation or deletion failed due to an error.

LastUpdateTime -> (timestamp)

The timestamp of the last 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.