/

POST

Returns detailed status for each member account within an organization for a given organization conformance pack.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

OrganizationConformancePackName

string

required

The name of organization conformance pack for which you want status details for member accounts.

>= 1 characters<= 128 characters

Match pattern:

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

Filters

object

optional

An OrganizationResourceDetailedStatusFilters object.

AccountId

string

optional

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

Match pattern:

\d{12}

Status

enum<string>

optional

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

CREATE_SUCCESSFUL when conformance pack has been created in the member account.
CREATE_IN_PROGRESS when conformance pack is being created in the member account.
CREATE_FAILED when conformance pack creation has failed in the member account.
DELETE_FAILED when conformance pack deletion has failed in the member account.
DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
UPDATE_FAILED when conformance pack 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 OrganizationConformancePackDetailedStatuses 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

OrganizationConformancePackDetailedStatuses

array[object (OrganizationConformancePackDetailedStatus) {6}]

optional

A list of OrganizationConformancePackDetailedStatus objects.

AccountId

string

required

The 12-digit account ID of a member account.

Match pattern:

\d{12}

ConformancePackName

string

required

The name of conformance pack deployed in the member account.

>= 1 characters<= 256 characters

Status

enum<string>

required

Config sets the state of the conformance pack to:

CREATE_SUCCESSFUL when conformance pack has been created in the member account.
CREATE_IN_PROGRESS when conformance pack is being created in the member account.
CREATE_FAILED when conformance pack creation has failed in the member account.
DELETE_FAILED when conformance pack deletion has failed in the member account.
DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
UPDATE_FAILED when conformance pack 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 conformance pack creation or deletion failed in the member account.

ErrorMessage

string

optional

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

🟠480NoSuchOrganizationConformancePackException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

🟠483OrganizationAccessDeniedException

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