Amazon CloudFormation Cloudformation Generated Template API

openapi: 3.2.0
info:
  title: AWS CloudFormation Generated Template API
  version: '2010-05-15'
  description: Generated from AWS's published Smithy model for AWS CloudFormation. 6 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: Generated Template
paths:
  /?Action=CreateGeneratedTemplate:
    post:
      operationId: CreateGeneratedTemplate
      summary: Create Generated Template
      description: Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateGeneratedTemplateOutput'
              example:
                GeneratedTemplateId: arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca
        '400':
          description: AlreadyExistsException; LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '429':
          description: ConcurrentResourcesLimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentResourcesLimitExceededException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateGeneratedTemplate
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/CreateGeneratedTemplateInput'
            example:
              Resources:
              - ResourceType: AWS::S3::Bucket
                ResourceIdentifier:
                  BucketName: jazz-bucket
              - ResourceType: AWS::EC2::DHCPOptions
                ResourceIdentifier:
                  DhcpOptionsId: random-id123
              GeneratedTemplateName: JazzyTemplate
      tags:
      - Generated Template
  /?Action=DeleteGeneratedTemplate:
    post:
      operationId: DeleteGeneratedTemplate
      summary: Delete Generated Template
      description: Deleted a generated template.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '429':
          description: ConcurrentResourcesLimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConcurrentResourcesLimitExceededException'
        '404':
          description: GeneratedTemplateNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GeneratedTemplateNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteGeneratedTemplate
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/DeleteGeneratedTemplateInput'
            example:
              GeneratedTemplateName: JazzyTemplate
      tags:
      - Generated Template
  /?Action=DescribeGeneratedTemplate:
    post:
      operationId: DescribeGeneratedTemplate
      summary: Describe Generated Template
      description: Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeGeneratedTemplateOutput'
        '404':
          description: GeneratedTemplateNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GeneratedTemplateNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeGeneratedTemplate
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/DescribeGeneratedTemplateInput'
      tags:
      - Generated Template
  /?Action=GetGeneratedTemplate:
    post:
      operationId: GetGeneratedTemplate
      summary: Get Generated Template
      description: Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetGeneratedTemplateOutput'
              example:
                Status: COMPLETE
                TemplateBody: '{"Metadata":{"TemplateId":"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*"},"Parameters":{"Stage":{"Default":"beta","Type":"String"}},"Resources":{"TestRole":{"Properties":{"AssumeRolePolicyDocument":{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":{"Fn::Sub":["arn:${AWS::Partition}:iam::${AccountId}:root",{"AccountId":{"Fn::AccountIdFromAlias":"test-account-alias"}}]}},"Action":"sts:AssumeRole"}]}},"Type":"AWS::IAM::Role","DeletionPolicy":"Delete"},"DocumentationPartl7ob4vsd76vs":{"UpdateReplacePolicy":"Retain","Type":"AWS::ApiGateway::DocumentationPart","DeletionPolicy":"Retain","Properties":{"RestApiId":"l7ob4vsd76","Properties":"{\n  \"description\" : \"ListGeneratedTemplates 200 response\"\n}","Location":{"Path":"/ListGeneratedTemplates","Type":"RESPONSE","Method":"POST","StatusCode":"200"}}}}}'
        '404':
          description: GeneratedTemplateNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GeneratedTemplateNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetGeneratedTemplate
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/GetGeneratedTemplateInput'
            example:
              GeneratedTemplateName: JazzyTemplate
      tags:
      - Generated Template
  /?Action=ListGeneratedTemplates:
    post:
      operationId: ListGeneratedTemplates
      summary: List Generated Templates
      description: Lists your generated templates in this Region.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListGeneratedTemplatesOutput'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ListGeneratedTemplates
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/ListGeneratedTemplatesInput'
      tags:
      - Generated Template
  /?Action=UpdateGeneratedTemplate:
    post:
      operationId: UpdateGeneratedTemplate
      summary: Update Generated Template
      description: Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateGeneratedTemplateOutput'
              example:
                GeneratedTemplateId: arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca
        '400':
          description: AlreadyExistsException; LimitExceededException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '404':
          description: GeneratedTemplateNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GeneratedTemplateNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: UpdateGeneratedTemplate
                  Version:
                    type: string
                    const: '2010-05-15'
              - $ref: '#/components/schemas/UpdateGeneratedTemplateInput'
            example:
              GeneratedTemplateName: JazzyTemplate
              AddResources:
              - ResourceType: AWS::S3::Bucket
                ResourceIdentifier:
                  BucketName: jazz-bucket
              - ResourceType: AWS::EC2::DHCPOptions
                ResourceIdentifier:
                  DhcpOptionsId: random-id123
      tags:
      - Generated Template
components:
  schemas:
    AlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
    TemplateProgress:
      type: object
      properties:
        ResourcesSucceeded:
          type: integer
          description: The number of resources that succeeded the template generation.
        ResourcesFailed:
          type: integer
          description: The number of resources that failed the template generation.
        ResourcesProcessing:
          type: integer
          description: The number of resources that are in-process for the template generation.
        ResourcesPending:
          type: integer
          description: The number of resources that are still pending the template generation.
    CreateGeneratedTemplateOutput:
      type: object
      properties:
        GeneratedTemplateId:
          type: string
          description: The ID of the generated template.
    GetGeneratedTemplateInput:
      type: object
      properties:
        Format:
          type: string
          enum:
          - JSON
          - YAML
          description: 'The language to use to retrieve for the generated template. Supported values are: JSON YAML'
        GeneratedTemplateName:
          type: string
          description: The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
      required:
      - GeneratedTemplateName
    ConcurrentResourcesLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    WarningDetail:
      type: object
      properties:
        Type:
          type: string
          enum:
          - MUTUALLY_EXCLUSIVE_PROPERTIES
          - UNSUPPORTED_PROPERTIES
          - MUTUALLY_EXCLUSIVE_TYPES
          - EXCLUDED_PROPERTIES
          - EXCLUDED_RESOURCES
          description: The type of this warning. For more information, see Resolve write-only properties in the CloudFormation User Guide. MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties. UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported pr
        Properties:
          type: array
          items:
            $ref: '#/components/schemas/WarningProperty'
          description: The properties of the resource that are impacted by this warning.
    DeleteGeneratedTemplateInput:
      type: object
      properties:
        GeneratedTemplateName:
          type: string
          description: The name or Amazon Resource Name (ARN) of a generated template.
      required:
      - GeneratedTemplateName
    TemplateConfiguration:
      type: object
      properties:
        DeletionPolicy:
          type: string
          enum:
          - DELETE
          - RETAIN
          description: 'The DeletionPolicy assigned to resources in the generated template. Supported values are: DELETE - delete all resources when the stack is deleted. RETAIN - retain all resources when the stack is deleted. For more information, see DeletionPolicy attribute in the CloudFormation User Guide.'
        UpdateReplacePolicy:
          type: string
          enum:
          - DELETE
          - RETAIN
          description: 'The UpdateReplacePolicy assigned to resources in the generated template. Supported values are: DELETE - delete all resources when the resource is replaced during an update operation. RETAIN - retain all resources when the resource is replaced during an update operation. For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.'
    UpdateGeneratedTemplateOutput:
      type: object
      properties:
        GeneratedTemplateId:
          type: string
          description: The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
    WarningProperty:
      type: object
      properties:
        PropertyPath:
          type: string
          description: The path of the property. For example, if this is for the S3Bucket member of the Code property, the property path would be Code/S3Bucket.
        Required:
          type: boolean
          description: If true, the specified property is required.
        Description:
          type: string
          description: The description of the property from the resource provider schema.
    GetGeneratedTemplateOutput:
      type: object
      properties:
        Status:
          type: string
          enum:
          - CREATE_PENDING
          - UPDATE_PENDING
          - DELETE_PENDING
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - DELETE_IN_PROGRESS
          - FAILED
          - COMPLETE
          description: 'The status of the template generation. Supported values are: CreatePending - the creation of the template is pending. CreateInProgress - the creation of the template is in progress. DeletePending - the deletion of the template is pending. DeleteInProgress - the deletion of the template is in progress. UpdatePending - the update of the template is pending. UpdateInProgress - the update of the template is in progress. Failed - the template operation failed. Complete - the template operation is complete.'
        TemplateBody:
          type: string
          description: The template body of the generated template, in the language specified by the Language parameter.
    GeneratedTemplateNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ResourceDefinition:
      type: object
      properties:
        ResourceType:
          type: string
          description: The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection in the CloudFormation User Guide
        LogicalResourceId:
          type: string
          description: The logical resource id for this resource in the generated template.
        ResourceIdentifier:
          type: object
          additionalProperties:
            type: string
          description: 'A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.'
      required:
      - ResourceType
      - ResourceIdentifier
    ResourceDetail:
      type: object
      properties:
        ResourceType:
          type: string
          description: The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see Resource type support for imports and drift detection In the CloudFormation User Guide
        LogicalResourceId:
          type: string
          description: The logical id for this resource in the final generated template.
        ResourceIdentifier:
          type: object
          additionalProperties:
            type: string
          description: 'A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.'
        ResourceStatus:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - FAILED
          - COMPLETE
          description: Status of the processing of a resource in a generated template. InProgress The resource processing is still in progress. Complete The resource processing is complete. Pending The resource processing is pending. Failed The resource processing has failed.
        ResourceStatusReason:
          type: string
          description: The reason for the resource detail, providing more information if a failure happened.
        Warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningDetail'
          description: The warnings generated for this resource.
    CreateGeneratedTemplateInput:
      type: object
      properties:
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDefinition'
          description: An optional list of resources to be included in the generated template. If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.
        GeneratedTemplateName:
          type: string
          description: The name assigned to the generated template.
        StackName:
          type: string
          description: An optional name or ARN of a stack to use as the base stack for the generated template.
        TemplateConfiguration:
          $ref: '#/components/schemas/TemplateConfiguration'
      required:
      - GeneratedTemplateName
    DescribeGeneratedTemplateInput:
      type: object
      properties:
        GeneratedTemplateName:
          type: string
          description: The name or Amazon Resource Name (ARN) of a generated template.
      required:
      - GeneratedTemplateName
    DescribeGeneratedTemplateOutput:
      type: object
      properties:
        GeneratedTemplateId:
          type: string
          description: The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
        GeneratedTemplateName:
          type: string
          description: The name of the generated template.
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDetail'
          description: A list of objects describing the details of the resources in the template generation.
        Status:
          type: string
          enum:
          - CREATE_PENDING
          - UPDATE_PENDING
          - DELETE_PENDING
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - DELETE_IN_PROGRESS
          - FAILED
          - COMPLETE
          description: 'The status of the template generation. Supported values are: CreatePending - the creation of the template is pending. CreateInProgress - the creation of the template is in progress. DeletePending - the deletion of the template is pending. DeleteInProgress - the deletion of the template is in progress. UpdatePending - the update of the template is pending. UpdateInProgress - the update of the template is in progress. Failed - the template operation failed. Complete - the template operation is complete.'
        StatusReason:
          type: string
          description: The reason for the current template generation status. This will provide more details if a failure happened.
        CreationTime:
          type: string
          format: date-time
          description: The time the generated template was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time the generated template was last updated.
        Progress:
          $ref: '#/components/schemas/TemplateProgress'
        StackId:
          type: string
          description: The stack ARN of the base stack if a base stack was provided when generating the template.
        TemplateConfiguration:
          $ref: '#/components/schemas/TemplateConfiguration'
        TotalWarnings:
          type: integer
          description: The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
    UpdateGeneratedTemplateInput:
      type: object
      properties:
        GeneratedTemplateName:
          type: string
          description: The name or Amazon Resource Name (ARN) of a generated template.
        NewGeneratedTemplateName:
          type: string
          description: An optional new name to assign to the generated template.
        AddResources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDefinition'
          description: An optional list of resources to be added to the generated template.
        RemoveResources:
          type: array
          items:
            type: string
          description: A list of logical ids for resources to remove from the generated template.
        RefreshAllResources:
          type: boolean
          description: If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.
        TemplateConfiguration:
          $ref: '#/components/schemas/TemplateConfiguration'
      required:
      - GeneratedTemplateName
    ListGeneratedTemplatesInput:
      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. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.
    ListGeneratedTemplatesOutput:
      type: object
      properties:
        Summaries:
          type: array
          items:
            $ref: '#/components/schemas/TemplateSummary'
          description: A list of summaries of the generated templates.
        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 ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
    TemplateSummary:
      type: object
      properties:
        GeneratedTemplateId:
          type: string
          description: The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .
        GeneratedTemplateName:
          type: string
          description: The name of the generated template.
        Status:
          type: string
          enum:
          - CREATE_PENDING
          - UPDATE_PENDING
          - DELETE_PENDING
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - DELETE_IN_PROGRESS
          - FAILED
          - COMPLETE
          description: 'The status of the template generation. Supported values are: CreatePending - the creation of the template is pending. CreateInProgress - the creation of the template is in progress. DeletePending - the deletion of the template is pending. DeleteInProgress - the deletion of the template is in progress. UpdatePending - the update of the template is pending. UpdateInProgress - the update of the template is in progress. Failed - the template operation failed. Complete - the template operation is complete.'
        StatusReason:
          type: string
          description: The reason for the current template generation status. This will provide more details if a failure happened.
        CreationTime:
          type: string
          format: date-time
          description: The time the generated template was created.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time the generated template was last updated.
        NumberOfResources:
          type: integer
          description: The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.
  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)