[ aws . configservice ]
Provides organization conformance pack deployment status for an organization.
Only a master account and a delegated administrator account can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator
permissions are added.
Note
The status is not considered successful until organization conformance pack 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 conformance pack names. They are only applicable, when you request all the organization conformance packs.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-organization-conformance-pack-statuses
[--organization-conformance-pack-names <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--organization-conformance-pack-names
(list)
The names of organization conformance packs for which you want status details. If you do not specify any names, AWS Config returns details for all your organization conformance packs.
(string)
Syntax:
"string" "string" ...
--limit
(integer)
The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
--next-token
(string)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
OrganizationConformancePackStatuses -> (list)
A list of
OrganizationConformancePackStatus
objects.(structure)
Returns the status for an organization conformance pack in an organization.
OrganizationConformancePackName -> (string)
The name that you assign to organization conformance pack.
Status -> (string)
Indicates deployment status of an organization conformance pack. When master account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When master 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 master account deletes OrganizationConformancePack in all the member accounts and disables service access for
config-multiaccountsetup.amazonaws.com
.AWS 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.ErrorCode -> (string)
An error code that is returned when organization conformance pack creation or deletion has failed in a member account.
ErrorMessage -> (string)
An error message indicating that organization conformance pack creation or deletion failed due to an error.
LastUpdateTime -> (timestamp)
The timestamp of the last update.
NextToken -> (string)
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.