ConfigService / Client / describe_organization_conformance_pack_statuses

describe_organization_conformance_pack_statuses#

ConfigService.Client.describe_organization_conformance_pack_statuses(**kwargs)#

Provides organization conformance pack deployment status for an organization.

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

Request Syntax

response = client.describe_organization_conformance_pack_statuses(
    OrganizationConformancePackNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
Parameters:

  • OrganizationConformancePackNames (list) –

    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.

    • (string) –

  • Limit (integer) – The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

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

Return type:

dict

Returns:

Response Syntax

{
    'OrganizationConformancePackStatuses': [
        {
            'OrganizationConformancePackName': 'string',
            'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • OrganizationConformancePackStatuses (list) –

      A list of OrganizationConformancePackStatus objects.

      • (dict) –

        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 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.

        • 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 (datetime) –

          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.

Exceptions