/

POST

Provides organization Config rule deployment status for an organization.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OrganizationConfigRuleNames": [],
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
  "OrganizationConfigRuleStatuses": [],
  "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

OrganizationConfigRuleNames

array[string]

optional

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.

>= 0 items<= 25 items

Limit

integer

optional

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

OrganizationConfigRuleStatuses

array[object (OrganizationConfigRuleStatus) {5}]

optional

A list of OrganizationConfigRuleStatus objects.

OrganizationConfigRuleName

string

required

The name that you assign to organization Config rule.

>= 1 characters<= 64 characters

Match pattern:

.*\S.*

OrganizationRuleStatus

enum<string>

required

Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management 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 management account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

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.

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 organization Config rule creation or deletion has failed.

ErrorMessage

string

optional

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

LastUpdateTime

string <date-time>

optional

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