Amazon CloudFormation Cloudformation Resource Scan API

openapi: 3.2.0
info:
  title: AWS CloudFormation Resource Scan API
  version: '2010-05-15'
  description: Generated from AWS's published Smithy model for AWS CloudFormation. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cloudformation.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Resource Scan
paths:
  /?Action=DescribeResourceScan:
    post:
      operationId: DescribeResourceScan
      summary: Describe Resource Scan
      description: Describes details of a resource scan.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeResourceScanOutput'
        '400':
          description: ResourceScanNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceScanNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeResourceScan
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/DescribeResourceScanInput'
      tags:
      - Resource Scan
  /?Action=ListResourceScans:
    post:
      operationId: ListResourceScans
      summary: List Resource Scans
      description: List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListResourceScansOutput'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListResourceScans
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/ListResourceScansInput'
      tags:
      - Resource Scan
  /?Action=StartResourceScan:
    post:
      operationId: StartResourceScan
      summary: Start Resource Scan
      description: Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StartResourceScanOutput'
              example:
                ResourceScanId: arn:aws:cloudformation:us-east-1:123456789012:resourceScan/88f09db1-d211-4cb7-964b-434e2b8469ca
        '400':
          description: ResourceScanInProgressException; ResourceScanLimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceScanInProgressException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: StartResourceScan
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/StartResourceScanInput'
      tags:
      - Resource Scan
components:
  schemas:
    ResourceScanSummary:
      type: object
      properties:
        ResourceScanId:
          type: string
          description: The Amazon Resource Name (ARN) of the resource scan.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETE
          - EXPIRED
          description: Status of the resource scan. IN_PROGRESS The resource scan is still in progress. COMPLETE The resource scan is complete. EXPIRED The resource scan has expired. FAILED The resource scan has failed.
        StatusReason:
          type: string
          description: The reason for the resource scan status, providing more information if a failure happened.
        StartTime:
          type: string
          format: date-time
          description: The time that the resource scan was started.
        EndTime:
          type: string
          format: date-time
          description: The time that the resource scan was finished.
        PercentageCompleted:
          type: number
          description: The percentage of the resource scan that has been completed.
        ScanType:
          type: string
          enum:
          - FULL
          - PARTIAL
          description: The scan type that has been completed.
    StartResourceScanOutput:
      type: object
      properties:
        ResourceScanId:
          type: string
          description: The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
    DescribeResourceScanInput:
      type: object
      properties:
        ResourceScanId:
          type: string
          description: The Amazon Resource Name (ARN) of the resource scan.
      required:
      - ResourceScanId
    ListResourceScansOutput:
      type: object
      properties:
        ResourceScanSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ResourceScanSummary'
          description: The list of scans returned.
        NextToken:
          type: string
          description: If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
    ScanFilter:
      type: object
      properties:
        Types:
          type: array
          items:
            type: string
          description: An array of strings where each string represents an Amazon Web Services resource type you want to scan. Each string defines the resource type using the format AWS::ServiceName::ResourceType, for example, AWS::DynamoDB::Table. For the full list of supported resource types, see the Resource type support table in the CloudFormation User Guide. To scan all resource types within a service, you can use a wildcard, represented by an asterisk (*). You can place an asterisk at only the end of the string, for example, AWS::S3::*.
    StartResourceScanInput:
      type: object
      properties:
        ClientRequestToken:
          type: string
          description: A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.
        ScanFilters:
          type: array
          items:
            $ref: '#/components/schemas/ScanFilter'
          description: The scan filters to use.
    DescribeResourceScanOutput:
      type: object
      properties:
        ResourceScanId:
          type: string
          description: The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETE
          - EXPIRED
          description: Status of the resource scan. IN_PROGRESS The resource scan is still in progress. COMPLETE The resource scan is complete. EXPIRED The resource scan has expired. FAILED The resource scan has failed.
        StatusReason:
          type: string
          description: The reason for the resource scan status, providing more information if a failure happened.
        StartTime:
          type: string
          format: date-time
          description: The time that the resource scan was started.
        EndTime:
          type: string
          format: date-time
          description: The time that the resource scan was finished.
        PercentageCompleted:
          type: number
          description: The percentage of the resource scan that has been completed.
        ResourceTypes:
          type: array
          items:
            type: string
          description: The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
        ResourcesScanned:
          type: integer
          description: The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .
        ResourcesRead:
          type: integer
          description: The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED. This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.
        ScanFilters:
          type: array
          items:
            $ref: '#/components/schemas/ScanFilter'
          description: The scan filters that were used.
    ListResourceScansInput:
      type: object
      properties:
        NextToken:
          type: string
          description: The token for the next set of items to return. (You received this token from a previous call.)
        MaxResults:
          type: integer
          description: If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.
        ScanTypeFilter:
          type: string
          enum:
          - FULL
          - PARTIAL
          description: The scan type that you want to get summary information about. The default is FULL.
    ResourceScanNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ResourceScanInProgressException:
      type: object
      properties:
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: cloudformation
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudformation/service/2010-05-15/cloudformation-2010-05-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)