Amazon Config #X Amz Target=StarlingDoveService.DescribeDeliveryChannelStatus 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.DescribeDeliveryChannelStatus 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.DescribeDeliveryChannelStatus'
paths:
  /#X-Amz-Target=StarlingDoveService.DescribeDeliveryChannelStatus:
    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: DescribeDeliveryChannelStatus
      description: <p>Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.</p> <note> <p>Currently, you can specify only one delivery channel per region in your account.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDeliveryChannelStatusResponse'
              examples:
                DescribeDeliveryChannelStatus200Example:
                  summary: Default DescribeDeliveryChannelStatus 200
                  x-microcks-default: true
                  value:
                    DeliveryChannelsStatus: example
        '480':
          description: NoSuchDeliveryChannelException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoSuchDeliveryChannelException'
              examples:
                DescribeDeliveryChannelStatus480Example:
                  summary: Default DescribeDeliveryChannelStatus 480
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDeliveryChannelStatusRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StarlingDoveService.DescribeDeliveryChannelStatus
      summary: Amazon Config Describe Delivery Channel Status
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=StarlingDoveService.DescribeDeliveryChannelStatus'
components:
  schemas:
    ConfigStreamDeliveryInfo:
      type: object
      properties:
        lastStatus:
          allOf:
          - $ref: '#/components/schemas/DeliveryStatus'
          - description: <p>Status of the last attempted delivery.</p> <p> <b>Note</b> Providing an SNS topic on a <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html">DeliveryChannel</a> for Config is optional. If the SNS delivery is turned off, the last status will be <b>Not_Applicable</b>.</p>
        lastErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error code from the last attempted delivery.
        lastErrorMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error message from the last attempted delivery.
        lastStatusChangeTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time from the last status change.
      description: A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.
    DescribeDeliveryChannelStatusRequest:
      type: object
      title: DescribeDeliveryChannelStatusRequest
      properties:
        DeliveryChannelNames:
          allOf:
          - $ref: '#/components/schemas/DeliveryChannelNameList'
          - description: A list of delivery channel names.
      description: The input for the <a>DeliveryChannelStatus</a> action.
    ConfigExportDeliveryInfo:
      type: object
      properties:
        lastStatus:
          allOf:
          - $ref: '#/components/schemas/DeliveryStatus'
          - description: Status of the last attempted delivery.
        lastErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error code from the last attempted delivery.
        lastErrorMessage:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error message from the last attempted delivery.
        lastAttemptTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time of the last attempted delivery.
        lastSuccessfulTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time of the last successful delivery.
        nextDeliveryTime:
          allOf:
          - $ref: '#/components/schemas/Date'
          - description: The time that the next delivery occurs.
      description: Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.
    DeliveryStatus:
      type: string
      enum:
      - Success
      - Failure
      - Not_Applicable
    Date:
      type: string
      format: date-time
    NoSuchDeliveryChannelException: {}
    ChannelName:
      type: string
      minLength: 1
      maxLength: 256
    DescribeDeliveryChannelStatusResponse:
      type: object
      properties:
        DeliveryChannelsStatus:
          allOf:
          - $ref: '#/components/schemas/DeliveryChannelStatusList'
          - description: A list that contains the status of a specified delivery channel.
      description: The output for the <a>DescribeDeliveryChannelStatus</a> action.
    DeliveryChannelStatusList:
      type: array
      items:
        $ref: '#/components/schemas/DeliveryChannelStatus'
    String:
      type: string
    DeliveryChannelStatus:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the delivery channel.
        configSnapshotDeliveryInfo:
          allOf:
          - $ref: '#/components/schemas/ConfigExportDeliveryInfo'
          - description: A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
        configHistoryDeliveryInfo:
          allOf:
          - $ref: '#/components/schemas/ConfigExportDeliveryInfo'
          - description: A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
        configStreamDeliveryInfo:
          allOf:
          - $ref: '#/components/schemas/ConfigStreamDeliveryInfo'
          - description: A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
      description: '<p>The status of a specified delivery channel.</p> <p>Valid values: <code>Success</code> | <code>Failure</code> </p>'
    DeliveryChannelNameList:
      type: array
      items:
        $ref: '#/components/schemas/ChannelName'
  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
  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