Amazon Config #X Amz Target=StarlingDoveService.DescribeOrganizationConfigRuleStatuses 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.DescribeOrganizationConfigRuleStatuses 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.DescribeOrganizationConfigRuleStatuses'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeOrganizationConfigRuleStatuses:
    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: DescribeOrganizationConfigRuleStatuses
      description: <p>Provides organization Config rule deployment status for an organization.</p> <note> <p>The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.</p> <p>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 Config rule names. It is only applicable, when you request all the organization Config rules.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeOrganizationConfigRuleStatusesResponse'
              examples:
                DescribeOrganizationConfigRuleStatuses200Example:
                  summary: Default DescribeOrganizationConfigRuleStatuses 200
                  x-microcks-default: true
                  value:
                    OrganizationConfigRuleStatuses: example
                    NextToken: example
        '480':
          description: NoSuchOrganizationConfigRuleException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchOrganizationConfigRuleException'
              examples:
                DescribeOrganizationConfigRuleStatuses480Example:
                  summary: Default DescribeOrganizationConfigRuleStatuses 480
                  x-microcks-default: true
                  value: example
        '481':
          description: InvalidLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLimitException'
              examples:
                DescribeOrganizationConfigRuleStatuses481Example:
                  summary: Default DescribeOrganizationConfigRuleStatuses 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                DescribeOrganizationConfigRuleStatuses482Example:
                  summary: Default DescribeOrganizationConfigRuleStatuses 482
                  x-microcks-default: true
                  value: example
        '483':
          description: OrganizationAccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationAccessDeniedException'
              examples:
                DescribeOrganizationConfigRuleStatuses483Example:
                  summary: Default DescribeOrganizationConfigRuleStatuses 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeOrganizationConfigRuleStatusesRequest'
      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.DescribeOrganizationConfigRuleStatuses
      summary: Amazon Config Describe Organization Config Rule Statuses
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeOrganizationConfigRuleStatuses'
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:
    StringWithCharLimit64:
      type: string
      minLength: 1
      maxLength: 64
    DescribeOrganizationConfigRuleStatusesResponse:
      type: object
      properties:
        OrganizationConfigRuleStatuses:
          allOf:
          - $ref: '#/components/schemas/OrganizationConfigRuleStatuses'
          - description: A list of <code>OrganizationConfigRuleStatus</code> objects.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. '
    OrganizationConfigRuleNames:
      type: array
      items:
        $ref: '#/components/schemas/StringWithCharLimit64'
      minItems: 0
      maxItems: 25
    NoSuchOrganizationConfigRuleException: {}
    OrganizationConfigRuleName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 64
    OrganizationConfigRuleStatuses:
      type: array
      items:
        $ref: '#/components/schemas/OrganizationConfigRuleStatus'
    Date:
      type: string
      format: date-time
    InvalidNextTokenException: {}
    CosmosPageLimit:
      type: integer
      minimum: 0
      maximum: 100
    InvalidLimitException: {}
    OrganizationConfigRuleStatus:
      type: object
      required:
      - OrganizationConfigRuleName
      - OrganizationRuleStatus
      properties:
        OrganizationConfigRuleName:
          allOf:
          - $ref: '#/components/schemas/OrganizationConfigRuleName'
          - description: The name that you assign to organization Config rule.
        OrganizationRuleStatus:
          allOf:
          - $ref: '#/components/schemas/OrganizationRuleStatus'
          - description: <p>Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <p>Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when an organization Config rule has been successfully created in all the member accounts. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when an organization Config rule creation is in progress.</p> </li> <li> <p> <code>CREATE_FAILED</code> when an organization Config rule creation failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_FAILED</code> when an organization Config rule deletion failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when an organization Config rule deletion is in progress.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when an organization Config rule has been successfully deleted from all the member accounts.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when an organization Config rule has been successfully updated in all the member accounts.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when an organization Config rule update is in progress.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when an organization Config rule update failed in one or more member accounts within that organization.</p> </li> </ul>
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: An error code that is returned when organization Config rule creation or deletion has failed.
        ErrorMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: An error message indicating that organization Config rule creation or deletion failed due to an error.
        LastUpdateTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The timestamp of the last update.
      description: Returns the status for an organization Config rule in an organization.
    DescribeOrganizationConfigRuleStatusesRequest:
      type: object
      title: DescribeOrganizationConfigRuleStatusesRequest
      properties:
        OrganizationConfigRuleNames:
          allOf:
          - $ref: '#/components/schemas/OrganizationConfigRuleNames'
          - description: The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.
        Limit:
          allOf:
          - $ref: '#/components/schemas/CosmosPageLimit'
          - description: The maximum number of <code>OrganizationConfigRuleStatuses</code> returned on each page. If you do no specify a number, Config uses the default. The default is 100.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. '
    String:
      type: string
    OrganizationRuleStatus:
      type: string
      enum:
      - CREATE_SUCCESSFUL
      - CREATE_IN_PROGRESS
      - CREATE_FAILED
      - DELETE_SUCCESSFUL
      - DELETE_FAILED
      - DELETE_IN_PROGRESS
      - UPDATE_SUCCESSFUL
      - UPDATE_IN_PROGRESS
      - UPDATE_FAILED
    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