/

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OrganizationConfigRuleName": "string",
    "Filters": {
        "AccountId": "string",
        "MemberAccountRuleStatus": "CREATE_SUCCESSFUL"
    },
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "OrganizationConfigRuleDetailedStatus": [],
    "NextToken": "string"
}

Request

Query Params

Limit

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

OrganizationConfigRuleName

string

required

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

>= 1 characters<= 64 characters

Match pattern:

.*\S.*

Filters

object

optional

A StatusDetailFilters object.

AccountId

string

optional

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

Match pattern:

\d{12}

MemberAccountRuleStatus

enum<string>

optional

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

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.

Allowed values:

CREATE_SUCCESSFULCREATE_IN_PROGRESSCREATE_FAILEDDELETE_SUCCESSFULDELETE_FAILEDDELETE_IN_PROGRESSUPDATE_SUCCESSFULUPDATE_IN_PROGRESSUPDATE_FAILED

Limit

integer

optional

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

>= 0<= 100

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

OrganizationConfigRuleDetailedStatus

array[object (MemberAccountStatus) {6}]

optional

A list of MemberAccountStatus objects.

AccountId

string

required

The 12-digit account ID of a member account.

Match pattern:

\d{12}

ConfigRuleName

string

required

The name of Config rule deployed in the member account.

>= 1 characters<= 64 characters

MemberAccountRuleStatus

enum<string>

required

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.

Allowed values:

CREATE_SUCCESSFULCREATE_IN_PROGRESSCREATE_FAILEDDELETE_SUCCESSFULDELETE_FAILEDDELETE_IN_PROGRESSUPDATE_SUCCESSFULUPDATE_IN_PROGRESSUPDATE_FAILED

ErrorCode

string

optional

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

ErrorMessage

string

optional

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

LastUpdateTime

string <date-time>

optional

The timestamp of the last status update.

NextToken

string

optional

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

🟠480NoSuchOrganizationConfigRuleException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

🟠483OrganizationAccessDeniedException

Modified at 2023-08-15 05:59:06