CloudFront Continuous Deployment Policy API

openapi: 3.1.0
info:
  title: Amazon CloudFront Continuous Deployment Policy API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 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://cloudfront.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2020-05-31/continuous-deployment-policy:
    post:
      operationId: CreateContinuousDeploymentPolicy
      summary: Create Continuous Deployment Policy
      description: Creates a continuous deployment policy that distributes traffic for a custom domain name to two different
        CloudFront distributions. To use a continuous deployment policy, first use CopyDistribution to create a staging distribution,
        then use UpdateDistribution to modify the staging distribution's configuration. After you create and update a staging
        distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution.
        This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production
        traffic to the new configuration.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateContinuousDeploymentPolicyResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '409':
          description: ContinuousDeploymentPolicyAlreadyExists; StagingDistributionInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ContinuousDeploymentPolicyAlreadyExists'
        '400':
          description: InconsistentQuantities; InvalidArgument; TooManyContinuousDeploymentPolicies
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InconsistentQuantities'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateContinuousDeploymentPolicyRequest'
      tags:
      - Continuous Deployment Policy
    get:
      operationId: ListContinuousDeploymentPolicies
      summary: List Continuous Deployment Policies
      description: Gets a list of the continuous deployment policies in your Amazon Web Services account. You can optionally
        specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the
        maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a
        subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent
        request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListContinuousDeploymentPoliciesResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchContinuousDeploymentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchContinuousDeploymentPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListContinuousDeploymentPoliciesRequest'
      tags:
      - Continuous Deployment Policy
  /2020-05-31/continuous-deployment-policy/{Id}:
    delete:
      operationId: DeleteContinuousDeploymentPolicy
      summary: Delete Continuous Deployment Policy
      description: Deletes a continuous deployment policy. You cannot delete a continuous deployment policy that's attached
        to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can
        delete the policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '409':
          description: ContinuousDeploymentPolicyInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ContinuousDeploymentPolicyInUse'
        '400':
          description: InvalidArgument; InvalidIfMatchVersion
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchContinuousDeploymentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchContinuousDeploymentPolicy'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteContinuousDeploymentPolicyRequest'
      tags:
      - Continuous Deployment Policy
    get:
      operationId: GetContinuousDeploymentPolicy
      summary: Get Continuous Deployment Policy
      description: Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time
        when the policy was last modified).
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetContinuousDeploymentPolicyResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: NoSuchContinuousDeploymentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchContinuousDeploymentPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetContinuousDeploymentPolicyRequest'
      tags:
      - Continuous Deployment Policy
    put:
      operationId: UpdateContinuousDeploymentPolicy
      summary: Update Continuous Deployment Policy
      description: 'Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable
        it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution
        that it sends traffic to. When you update a continuous deployment policy configuration, all the fields are updated
        with the values that are provided in the request. You cannot update some fields independent of others. To update a
        continuous deployment policy configuration: Use GetContinuousDeploymentPolicyConfig to get the current configuration.
        Locally modify the fields in the continuous deployment policy configuration that you want to update. Use UpdateContinuousDeploymentPolicy,
        providing the entire continuous deployment policy configuration, including the fields that you modified and those
        that you didn''t.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateContinuousDeploymentPolicyResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InconsistentQuantities; InvalidArgument; InvalidIfMatchVersion
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InconsistentQuantities'
        '404':
          description: NoSuchContinuousDeploymentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchContinuousDeploymentPolicy'
        '412':
          description: PreconditionFailed
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PreconditionFailed'
        '409':
          description: StagingDistributionInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StagingDistributionInUse'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateContinuousDeploymentPolicyRequest'
      tags:
      - Continuous Deployment Policy
  /2020-05-31/continuous-deployment-policy/{Id}/config:
    get:
      operationId: GetContinuousDeploymentPolicyConfig
      summary: Get Continuous Deployment Policy Config
      description: Gets configuration information about a continuous deployment policy.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetContinuousDeploymentPolicyConfigResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '404':
          description: NoSuchContinuousDeploymentPolicy
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchContinuousDeploymentPolicy'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetContinuousDeploymentPolicyConfigRequest'
      tags:
      - Continuous Deployment Policy
components:
  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: cloudfront
  schemas:
    AccessDenied:
      type: object
      properties:
        Message:
          type: string
    ContinuousDeploymentPolicy:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the continuous deployment policy.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time the continuous deployment policy was last modified.
        ContinuousDeploymentPolicyConfig:
          $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig'
      required:
      - Id
      - LastModifiedTime
      - ContinuousDeploymentPolicyConfig
    ContinuousDeploymentPolicyAlreadyExists:
      type: object
      properties:
        Message:
          type: string
    ContinuousDeploymentPolicyConfig:
      type: object
      properties:
        StagingDistributionDnsNames:
          $ref: '#/components/schemas/StagingDistributionDnsNames'
        Enabled:
          type: boolean
          description: A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this
            value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and
            has no effect.
        TrafficConfig:
          $ref: '#/components/schemas/TrafficConfig'
      required:
      - StagingDistributionDnsNames
      - Enabled
    ContinuousDeploymentPolicyInUse:
      type: object
      properties:
        Message:
          type: string
    ContinuousDeploymentPolicyList:
      type: object
      properties:
        NextMarker:
          type: string
          description: Indicates the next page of continuous deployment policies. To get the next page of the list, use this
            value in the Marker field of your request.
        MaxItems:
          type: integer
          description: The maximum number of continuous deployment policies that were specified in your request.
        Quantity:
          type: integer
          description: The total number of continuous deployment policies in your Amazon Web Services account, regardless
            of the MaxItems value.
        Items:
          type: array
          items:
            $ref: '#/components/schemas/ContinuousDeploymentPolicySummary'
          description: A list of continuous deployment policy items.
      required:
      - MaxItems
      - Quantity
    ContinuousDeploymentPolicySummary:
      type: object
      properties:
        ContinuousDeploymentPolicy:
          $ref: '#/components/schemas/ContinuousDeploymentPolicy'
      required:
      - ContinuousDeploymentPolicy
    ContinuousDeploymentSingleHeaderConfig:
      type: object
      properties:
        Header:
          type: string
          description: The request header name that you want CloudFront to send to your staging distribution. The header must
            contain the prefix aws-cf-cd-.
        Value:
          type: string
          description: The request header value.
      required:
      - Header
      - Value
    ContinuousDeploymentSingleWeightConfig:
      type: object
      properties:
        Weight:
          type: number
          description: The percentage of traffic to send to a staging distribution, expressed as a decimal number between
            0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
        SessionStickinessConfig:
          $ref: '#/components/schemas/SessionStickinessConfig'
      required:
      - Weight
    CreateContinuousDeploymentPolicyRequest:
      type: object
      properties:
        ContinuousDeploymentPolicyConfig:
          $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig'
      required:
      - ContinuousDeploymentPolicyConfig
    CreateContinuousDeploymentPolicyResult:
      type: object
      properties:
        ContinuousDeploymentPolicy:
          $ref: '#/components/schemas/ContinuousDeploymentPolicy'
        Location:
          type: string
          description: The location of the continuous deployment policy.
        ETag:
          type: string
          description: The version identifier for the current version of the continuous deployment policy.
    DeleteContinuousDeploymentPolicyRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the continuous deployment policy that you are deleting.
        IfMatch:
          type: string
          description: The current version (ETag value) of the continuous deployment policy that you are deleting.
      required:
      - Id
    GetContinuousDeploymentPolicyConfigRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the continuous deployment policy whose configuration you are getting.
      required:
      - Id
    GetContinuousDeploymentPolicyConfigResult:
      type: object
      properties:
        ContinuousDeploymentPolicyConfig:
          $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig'
        ETag:
          type: string
          description: The version identifier for the current version of the continuous deployment policy.
    GetContinuousDeploymentPolicyRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the continuous deployment policy that you are getting.
      required:
      - Id
    GetContinuousDeploymentPolicyResult:
      type: object
      properties:
        ContinuousDeploymentPolicy:
          $ref: '#/components/schemas/ContinuousDeploymentPolicy'
        ETag:
          type: string
          description: The version identifier for the current version of the continuous deployment policy.
    InconsistentQuantities:
      type: object
      properties:
        Message:
          type: string
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    ListContinuousDeploymentPoliciesRequest:
      type: object
      properties:
        Marker:
          type: string
          description: Use this field when paginating results to indicate where to begin in your list of continuous deployment
            policies. The response includes policies in the list that occur after the marker. To get the next page of the
            list, set this field's value to the value of NextMarker from the current page's response.
        MaxItems:
          type: integer
          description: The maximum number of continuous deployment policies that you want returned in the response.
    ListContinuousDeploymentPoliciesResult:
      type: object
      properties:
        ContinuousDeploymentPolicyList:
          $ref: '#/components/schemas/ContinuousDeploymentPolicyList'
    NoSuchContinuousDeploymentPolicy:
      type: object
      properties:
        Message:
          type: string
    PreconditionFailed:
      type: object
      properties:
        Message:
          type: string
    SessionStickinessConfig:
      type: object
      properties:
        IdleTTL:
          type: integer
          description: The amount of time after which you want sessions to cease if no requests are received. Allowed values
            are 300–3600 seconds (5–60 minutes). The value must be less than or equal to MaximumTTL.
        MaximumTTL:
          type: integer
          description: The maximum amount of time to consider requests from the viewer as being part of the same session.
            Allowed values are 300–3600 seconds (5–60 minutes). The value must be greater than or equal to IdleTTL.
      required:
      - IdleTTL
      - MaximumTTL
    StagingDistributionDnsNames:
      type: object
      properties:
        Quantity:
          type: integer
          description: The number of CloudFront domain names in your staging distribution.
        Items:
          type: array
          items:
            type: string
          description: The CloudFront domain name of the staging distribution.
      required:
      - Quantity
    StagingDistributionInUse:
      type: object
      properties:
        Message:
          type: string
    TrafficConfig:
      type: object
      properties:
        SingleWeightConfig:
          $ref: '#/components/schemas/ContinuousDeploymentSingleWeightConfig'
        SingleHeaderConfig:
          $ref: '#/components/schemas/ContinuousDeploymentSingleHeaderConfig'
        Type:
          type: string
          enum:
          - SingleWeight
          - SingleHeader
          description: The type of traffic configuration.
      required:
      - Type
    UpdateContinuousDeploymentPolicyRequest:
      type: object
      properties:
        ContinuousDeploymentPolicyConfig:
          $ref: '#/components/schemas/ContinuousDeploymentPolicyConfig'
        Id:
          type: string
          description: The identifier of the continuous deployment policy that you are updating.
        IfMatch:
          type: string
          description: The current version (ETag value) of the continuous deployment policy that you are updating.
      required:
      - ContinuousDeploymentPolicyConfig
      - Id
    UpdateContinuousDeploymentPolicyResult:
      type: object
      properties:
        ContinuousDeploymentPolicy:
          $ref: '#/components/schemas/ContinuousDeploymentPolicy'
        ETag:
          type: string
          description: The version identifier for the current version of the continuous deployment policy.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)