Amazon Config #X Amz Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatus API

openapi: 3.0.0
info:
  version: '2014-11-12'
  x-release: v4
  title: 'AWS Config #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.BatchGetAggregateResourceConfig #X Amz Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatus API'
  description: <fullname>Config</fullname> <p>Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p> <p>You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer Guide</i>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: config
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/config-2014-11-12.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://config.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Config Service multi-region endpoint
- url: https://config.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Config Service multi-region endpoint
- url: http://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
- url: https://config.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Config Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatus'
paths:
  /#X-Amz-Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatus:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetOrganizationConformancePackDetailedStatus
      description: Returns detailed status for each member account within an organization for a given organization conformance pack.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationConformancePackDetailedStatusResponse'
              examples:
                GetOrganizationConformancePackDetailedStatus200Example:
                  summary: Default GetOrganizationConformancePackDetailedStatus 200
                  x-microcks-default: true
                  value:
                    OrganizationConformancePackDetailedStatuses: example
                    NextToken: example
        '480':
          description: NoSuchOrganizationConformancePackException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchOrganizationConformancePackException'
              examples:
                GetOrganizationConformancePackDetailedStatus480Example:
                  summary: Default GetOrganizationConformancePackDetailedStatus 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                GetOrganizationConformancePackDetailedStatus481Example:
                  summary: Default GetOrganizationConformancePackDetailedStatus 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                GetOrganizationConformancePackDetailedStatus482Example:
                  summary: Default GetOrganizationConformancePackDetailedStatus 482
                  x-microcks-default: true
                  value: example
        '483':
          description: OrganizationAccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAccessDeniedException'
              examples:
                GetOrganizationConformancePackDetailedStatus483Example:
                  summary: Default GetOrganizationConformancePackDetailedStatus 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrganizationConformancePackDetailedStatusRequest'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.GetOrganizationConformancePackDetailedStatus
      summary: Amazon Config Get Organization Conformance Pack Detailed Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatus'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  schemas:
    OrganizationConformancePackDetailedStatus:
      type: object
      required:
      - AccountId
      - ConformancePackName
      - Status
      properties:
        AccountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: The 12-digit account ID of a member account.
        ConformancePackName:
          allOf:
          - $ref: '#/components/schemas/StringWithCharLimit256'
          - description: The name of conformance pack deployed in the member account.
        Status:
          allOf:
          - $ref: '#/components/schemas/OrganizationResourceDetailedStatus'
          - description: <p>Indicates deployment status for conformance pack in a member account. When management account calls <code>PutOrganizationConformancePack</code> action for the first time, conformance pack status is created in the member account. When management account calls <code>PutOrganizationConformancePack</code> action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes <code>OrganizationConformancePack</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p> Config sets the state of the conformance pack to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when conformance pack has been created in the member account. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when conformance pack is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when conformance pack creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when conformance pack deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when conformance pack is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when conformance pack has been deleted in the member account. </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when conformance pack has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when conformance pack is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when conformance pack deletion has failed in the member account.</p> </li> </ul>
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An error code that is returned when conformance pack creation or deletion failed in the member account. '
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account. '
        LastUpdateTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The timestamp of the last status update.
      description: 'Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed. '
    StringWithCharLimit256:
      type: string
      minLength: 1
      maxLength: 256
    OrganizationConformancePackDetailedStatuses:
      type: array
      items:
        $ref: '#/components/schemas/OrganizationConformancePackDetailedStatus'
    OrganizationConformancePackName:
      type: string
      pattern: '[a-zA-Z][-a-zA-Z0-9]*'
      minLength: 1
      maxLength: 128
    OrganizationResourceDetailedStatusFilters:
      type: object
      properties:
        AccountId:
          allOf:
          - $ref: '#/components/schemas/AccountId'
          - description: The 12-digit account ID of the member account within an organization.
        Status:
          allOf:
          - $ref: '#/components/schemas/OrganizationResourceDetailedStatus'
          - description: <p>Indicates deployment status for conformance pack in a member account. When management account calls <code>PutOrganizationConformancePack</code> action for the first time, conformance pack status is created in the member account. When management account calls <code>PutOrganizationConformancePack</code> action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes <code>OrganizationConformancePack</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p> Config sets the state of the conformance pack to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when conformance pack has been created in the member account. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when conformance pack is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when conformance pack creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when conformance pack deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when conformance pack is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when conformance pack has been deleted in the member account. </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when conformance pack has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when conformance pack is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when conformance pack deletion has failed in the member account.</p> </li> </ul>
      description: Status filter object to filter results based on specific member account ID or status type for an organization conformance pack.
    NoSuchOrganizationConformancePackException: {}
    Date:
      type: string
      format: date-time
    InvalidNextTokenException: {}
    GetOrganizationConformancePackDetailedStatusResponse:
      type: object
      properties:
        OrganizationConformancePackDetailedStatuses:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePackDetailedStatuses'
          - description: 'A list of <code>OrganizationConformancePackDetailedStatus</code> objects. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
    CosmosPageLimit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidLimitException: {}
    OrganizationResourceDetailedStatus:
      type: string
      enum:
      - CREATE_SUCCESSFUL
      - CREATE_IN_PROGRESS
      - CREATE_FAILED
      - DELETE_SUCCESSFUL
      - DELETE_FAILED
      - DELETE_IN_PROGRESS
      - UPDATE_SUCCESSFUL
      - UPDATE_IN_PROGRESS
      - UPDATE_FAILED
    String:
      type: string
    GetOrganizationConformancePackDetailedStatusRequest:
      type: object
      required:
      - OrganizationConformancePackName
      title: GetOrganizationConformancePackDetailedStatusRequest
      properties:
        OrganizationConformancePackName:
          allOf:
          - $ref: '#/components/schemas/OrganizationConformancePackName'
          - description: The name of organization conformance pack for which you want status details for member accounts.
        Filters:
          allOf:
          - $ref: '#/components/schemas/OrganizationResourceDetailedStatusFilters'
          - description: An <code>OrganizationResourceDetailedStatusFilters</code> object.
        Limit:
          allOf:
          - $ref: '#/components/schemas/CosmosPageLimit'
          - description: 'The maximum number of <code>OrganizationConformancePackDetailedStatuses</code> returned on each page. If you do not specify a number, Config uses the default. The default is 100. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. '
    AccountId:
      type: string
      pattern: \d{12}
    OrganizationAccessDeniedException: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/config/
x-hasEquivalentPaths: true