Amazon Config #X Amz Target=StarlingDoveService.DescribeConfigurationRecorderStatus 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.DescribeConfigurationRecorderStatus 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.DescribeConfigurationRecorderStatus'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeConfigurationRecorderStatus:
    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: DescribeConfigurationRecorderStatus
      description: <p>Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.</p> <note> <p>&gt;You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConfigurationRecorderStatusResponse'
              examples:
                DescribeConfigurationRecorderStatus200Example:
                  summary: Default DescribeConfigurationRecorderStatus 200
                  x-microcks-default: true
                  value:
                    ConfigurationRecordersStatus: example
        '480':
          description: NoSuchConfigurationRecorderException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchConfigurationRecorderException'
              examples:
                DescribeConfigurationRecorderStatus480Example:
                  summary: Default DescribeConfigurationRecorderStatus 480
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConfigurationRecorderStatusRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.DescribeConfigurationRecorderStatus
      summary: Amazon Config Describe Configuration Recorder Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeConfigurationRecorderStatus'
components:
  schemas:
    RecorderStatus:
      type: string
      enum:
      - Pending
      - Success
      - Failure
    ConfigurationRecorderNameList:
      type: array
      items:
        $ref: '#/components/schemas/RecorderName'
    String:
      type: string
    NoSuchConfigurationRecorderException: {}
    Boolean:
      type: boolean
    Date:
      type: string
      format: date-time
    ConfigurationRecorderStatusList:
      type: array
      items:
        $ref: '#/components/schemas/ConfigurationRecorderStatus'
    DescribeConfigurationRecorderStatusRequest:
      type: object
      title: DescribeConfigurationRecorderStatusRequest
      properties:
        ConfigurationRecorderNames:
          allOf:
          - $ref: '#/components/schemas/ConfigurationRecorderNameList'
          - description: The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
      description: The input for the <a>DescribeConfigurationRecorderStatus</a> action.
    DescribeConfigurationRecorderStatusResponse:
      type: object
      properties:
        ConfigurationRecordersStatus:
          allOf:
          - $ref: '#/components/schemas/ConfigurationRecorderStatusList'
          - description: A list that contains status of the specified recorders.
      description: The output for the <a>DescribeConfigurationRecorderStatus</a> action, in JSON format.
    RecorderName:
      type: string
      minLength: 1
      maxLength: 256
    ConfigurationRecorderStatus:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the configuration recorder.
        lastStartTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time the recorder was last started.
        lastStopTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time the recorder was last stopped.
        recording:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Specifies whether or not the recorder is currently recording.
        lastStatus:
          allOf:
          - $ref: '#/components/schemas/RecorderStatus'
          - description: The status of the latest recording event processed by the recorder.
        lastErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The latest error code from when the recorder last failed.
        lastErrorMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The latest error message from when the recorder last failed.
        lastStatusChangeTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time of the latest change in status of an recording event processed by the recorder.
      description: <p>The current status of the configuration recorder.</p> <note> <p>For a detailed status of recording events over time, add your Config events to CloudWatch metrics and use CloudWatch metrics.</p> </note>
  parameters:
    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
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      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
  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