Skip to content

Provides organization Config rule deployment status for an organization

Description

Provides organization Config rule deployment status for an organization.

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.

Usage

configservice_describe_organization_config_rule_statuses(
  OrganizationConfigRuleNames, Limit, NextToken)

Arguments

  • OrganizationConfigRuleNames

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

  • Limit

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

  • NextToken

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

Value

A list with the following syntax:

list(
  OrganizationConfigRuleStatuses = list(
    list(
      OrganizationConfigRuleName = "string",
      OrganizationRuleStatus = "CREATE_SUCCESSFUL"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_SUCCESSFUL"|"DELETE_FAILED"|"DELETE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED",
      ErrorCode = "string",
      ErrorMessage = "string",
      LastUpdateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_organization_config_rule_statuses(
  OrganizationConfigRuleNames = list(
    "string"
  ),
  Limit = 123,
  NextToken = "string"
)