/

POST

Provides organization conformance pack 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 '{
    "OrganizationConformancePackNames": [],
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

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

OrganizationConformancePackNames

array[string]

optional

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

>= 0 items<= 25 items

Limit

integer

optional

The maximum number of OrganizationConformancePackStatuses 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

OrganizationConformancePackStatuses

array[object (OrganizationConformancePackStatus) {5}]

optional

A list of OrganizationConformancePackStatus objects.

OrganizationConformancePackName

string

required

The name that you assign to organization conformance pack.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z][-a-zA-Z0-9]*

Status

enum<string>

required

Indicates deployment status of an organization conformance pack. When management account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When management account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the management account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the member accounts.
CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.
CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.
DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.
DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.
DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the member accounts.
UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.
UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.
UPDATE_FAILED when an organization conformance pack 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 conformance pack creation or deletion has failed in a member account.

ErrorMessage

string

optional

An error message indicating that organization conformance pack 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.

🟠480NoSuchOrganizationConformancePackException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

🟠483OrganizationAccessDeniedException

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