AWS Backup Backup Tiering Configurations API

openapi: 3.2.0
info:
  title: AWS Backup Tiering Configurations API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 5 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://backup.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Tiering Configurations
paths:
  /tiering-configurations:
    put:
      operationId: CreateTieringConfiguration
      summary: Create Tiering Configuration
      description: Creates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTieringConfigurationOutput'
        '400':
          description: AlreadyExistsException; InvalidParameterValueException; LimitExceededException; MissingParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTieringConfigurationInput'
      tags:
      - Tiering Configurations
    get:
      operationId: ListTieringConfigurations
      summary: List Tiering Configurations
      description: Returns a list of tiering configurations.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTieringConfigurationsOutput'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTieringConfigurationsInput'
      tags:
      - Tiering Configurations
  /tiering-configurations/{TieringConfigurationName}:
    delete:
      operationId: DeleteTieringConfiguration
      summary: Delete Tiering Configuration
      description: Deletes the tiering configuration specified by a tiering configuration name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteTieringConfigurationOutput'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteTieringConfigurationInput'
      tags:
      - Tiering Configurations
    get:
      operationId: GetTieringConfiguration
      summary: Get Tiering Configuration
      description: Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTieringConfigurationOutput'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTieringConfigurationInput'
      tags:
      - Tiering Configurations
    put:
      operationId: UpdateTieringConfiguration
      summary: Update Tiering Configuration
      description: 'This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceType'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTieringConfigurationOutput'
        '400':
          description: AlreadyExistsException; InvalidParameterValueException; LimitExceededException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTieringConfigurationInput'
      tags:
      - Tiering Configurations
components:
  schemas:
    AlreadyExistsException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        CreatorRequestId:
          type: string
        Arn:
          type: string
        Type:
          type: string
        Context:
          type: string
    TieringConfiguration:
      type: object
      properties:
        TieringConfigurationName:
          type: string
          description: The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
        TieringConfigurationArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
        BackupVaultName:
          type: string
          description: The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.
        ResourceSelection:
          type: array
          items:
            $ref: '#/components/schemas/ResourceSelection'
          description: An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
        CreatorRequestId:
          type: string
          description: This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
        CreationTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
      required:
      - TieringConfigurationName
      - BackupVaultName
      - ResourceSelection
    UpdateTieringConfigurationOutput:
      type: object
      properties:
        TieringConfigurationArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies the updated tiering configuration.
        TieringConfigurationName:
          type: string
          description: This unique string is the name of the tiering configuration.
        CreationTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    CreateTieringConfigurationInput:
      type: object
      properties:
        TieringConfiguration:
          $ref: '#/components/schemas/TieringConfigurationInputForCreate'
        TieringConfigurationTags:
          type: object
          additionalProperties:
            type: string
          description: The tags to assign to the tiering configuration.
        CreatorRequestId:
          type: string
          description: This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
      required:
      - TieringConfiguration
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    DeleteTieringConfigurationOutput:
      type: object
      properties: {}
    ListTieringConfigurationsOutput:
      type: object
      properties:
        TieringConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TieringConfigurationsListMember'
          description: An array of tiering configurations returned by the ListTieringConfigurations call.
        NextToken:
          type: string
          description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    GetTieringConfigurationOutput:
      type: object
      properties:
        TieringConfiguration:
          $ref: '#/components/schemas/TieringConfiguration'
    DeleteTieringConfigurationInput:
      type: object
      properties:
        TieringConfigurationName:
          type: string
          description: The unique name of a tiering configuration.
      required:
      - TieringConfigurationName
    GetTieringConfigurationInput:
      type: object
      properties:
        TieringConfigurationName:
          type: string
          description: The unique name of a tiering configuration.
      required:
      - TieringConfigurationName
    UpdateTieringConfigurationInput:
      type: object
      properties:
        TieringConfigurationName:
          type: string
          description: The name of a tiering configuration to update.
        TieringConfiguration:
          $ref: '#/components/schemas/TieringConfigurationInputForUpdate'
      required:
      - TieringConfigurationName
      - TieringConfiguration
    ListTieringConfigurationsInput:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of items to be returned.
        NextToken:
          type: string
          description: The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    TieringConfigurationsListMember:
      type: object
      properties:
        TieringConfigurationArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
        TieringConfigurationName:
          type: string
          description: The unique name of the tiering configuration.
        BackupVaultName:
          type: string
          description: The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.
        CreationTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
    CreateTieringConfigurationOutput:
      type: object
      properties:
        TieringConfigurationArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies the created tiering configuration.
        TieringConfigurationName:
          type: string
          description: This unique string is the name of the tiering configuration. The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 200.
        CreationTime:
          type: string
          format: date-time
          description: The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
    TieringConfigurationInputForCreate:
      type: object
      properties:
        TieringConfigurationName:
          type: string
          description: The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
        BackupVaultName:
          type: string
          description: The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.
        ResourceSelection:
          type: array
          items:
            $ref: '#/components/schemas/ResourceSelection'
          description: An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
      required:
      - TieringConfigurationName
      - BackupVaultName
      - ResourceSelection
    TieringConfigurationInputForUpdate:
      type: object
      properties:
        ResourceSelection:
          type: array
          items:
            $ref: '#/components/schemas/ResourceSelection'
          description: An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
        BackupVaultName:
          type: string
          description: The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults.
      required:
      - ResourceSelection
      - BackupVaultName
    ConflictException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    ResourceSelection:
      type: object
      properties:
        Resources:
          type: array
          items:
            type: string
          description: An array of strings that either contains ARNs of the associated resources or contains a wildcard * to specify all resources. You can specify up to 100 specific resources per tiering configuration.
        TieringDownSettingsInDays:
          type: integer
          description: The number of days after creation within a backup vault that an object can transition to the low cost warm storage tier. Must be a positive integer between 60 and 36500 days.
        ResourceType:
          type: string
          description: The type of Amazon Web Services resource; for example, S3 for Amazon S3. For tiering configurations, this is currently limited to S3.
      required:
      - Resources
      - TieringDownSettingsInDays
      - ResourceType
  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: backup
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/backup/service/2018-11-15/backup-2018-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)