Amazon Route 53 Resolver Route53 Resolver Outpost Resolver API

openapi: 3.2.0
info:
  title: Amazon Route 53 Resolver Outpost Resolver API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53 Resolver. 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://route53resolver.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Outpost Resolver
paths:
  /#CreateOutpostResolver:
    post:
      operationId: CreateOutpostResolver
      summary: Create Outpost Resolver
      description: Creates a Route 53 Resolver on an Outpost. This operation applies to first-generation Outposts only. On second-generation Outposts, Resolver is enabled by default and managed automatically by Amazon Web Services, so you don't need to create it.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateOutpostResolverResponse'
        '400':
          description: AccessDeniedException; InternalServiceErrorException; ResourceNotFoundException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.CreateOutpostResolver
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateOutpostResolverRequest'
      tags:
      - Outpost Resolver
  /#DeleteOutpostResolver:
    post:
      operationId: DeleteOutpostResolver
      summary: Delete Outpost Resolver
      description: Deletes a Resolver on the Outpost. This operation applies to first-generation Outposts only. On second-generation Outposts, Resolver is managed automatically by Amazon Web Services and can't be deleted directly. To opt out of Resolver on second-generation Outposts, contact Amazon Web Services Support.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteOutpostResolverResponse'
        '400':
          description: AccessDeniedException; ConflictException; InternalServiceErrorException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.DeleteOutpostResolver
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteOutpostResolverRequest'
      tags:
      - Outpost Resolver
  /#GetOutpostResolver:
    post:
      operationId: GetOutpostResolver
      summary: Get Outpost Resolver
      description: Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetOutpostResolverResponse'
        '400':
          description: AccessDeniedException; InternalServiceErrorException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.GetOutpostResolver
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetOutpostResolverRequest'
      tags:
      - Outpost Resolver
  /#ListOutpostResolvers:
    post:
      operationId: ListOutpostResolvers
      summary: List Outpost Resolvers
      description: Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListOutpostResolversResponse'
        '400':
          description: AccessDeniedException; InternalServiceErrorException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.ListOutpostResolvers
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListOutpostResolversRequest'
      tags:
      - Outpost Resolver
  /#UpdateOutpostResolver:
    post:
      operationId: UpdateOutpostResolver
      summary: Update Outpost Resolver
      description: You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost. This operation applies to first-generation Outposts only. On second-generation Outposts, Resolver is managed automatically by Amazon Web Services and can't be updated directly.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateOutpostResolverResponse'
        '400':
          description: AccessDeniedException; ConflictException; InternalServiceErrorException; ResourceNotFoundException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53Resolver.UpdateOutpostResolver
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateOutpostResolverRequest'
      tags:
      - Outpost Resolver
components:
  schemas:
    DeleteOutpostResolverResponse:
      type: object
      properties:
        OutpostResolver:
          $ref: '#/components/schemas/OutpostResolver'
    CreateOutpostResolverRequest:
      type: object
      properties:
        CreatorRequestId:
          type: string
          description: A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
        Name:
          type: string
          description: A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
        InstanceCount:
          type: integer
          description: Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.
        PreferredInstanceType:
          type: string
          description: The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.
        OutpostArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A string that helps identify the Route 53 Resolvers on Outpost.
      required:
      - CreatorRequestId
      - Name
      - PreferredInstanceType
      - OutpostArn
    ListOutpostResolversResponse:
      type: object
      properties:
        OutpostResolvers:
          type: array
          items:
            $ref: '#/components/schemas/OutpostResolver'
          description: The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
        NextToken:
          type: string
          description: If more than MaxResults Resolvers match the specified criteria, you can submit another ListOutpostResolver request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
    UpdateOutpostResolverRequest:
      type: object
      properties:
        Id:
          type: string
          description: A unique string that identifies Resolver on an Outpost.
        Name:
          type: string
          description: Name of the Resolver on the Outpost.
        InstanceCount:
          type: integer
          description: The Amazon EC2 instance count for a Resolver on the Outpost.
        PreferredInstanceType:
          type: string
          description: Amazon EC2 instance type.
      required:
      - Id
    ListOutpostResolversRequest:
      type: object
      properties:
        OutpostArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Outpost.
        MaxResults:
          type: integer
          description: The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don't specify a value for MaxResults, the request returns up to 100 Resolvers.
        NextToken:
          type: string
          description: For the first ListOutpostResolver request, omit this value.
    GetOutpostResolverRequest:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the Resolver on the Outpost.
      required:
      - Id
    CreateOutpostResolverResponse:
      type: object
      properties:
        OutpostResolver:
          $ref: '#/components/schemas/OutpostResolver'
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.
        Value:
          type: string
          description: The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.
      required:
      - Key
      - Value
    UpdateOutpostResolverResponse:
      type: object
      properties:
        OutpostResolver:
          $ref: '#/components/schemas/OutpostResolver'
    DeleteOutpostResolverRequest:
      type: object
      properties:
        Id:
          type: string
          description: A unique string that identifies the Resolver on the Outpost.
      required:
      - Id
    OutpostResolver:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN (Amazon Resource Name) for the Resolver on an Outpost.
        CreationTime:
          type: string
          description: The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).
        ModificationTime:
          type: string
          description: The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).
        CreatorRequestId:
          type: string
          description: A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
        Id:
          type: string
          description: The ID of the Resolver on Outpost.
        InstanceCount:
          type: integer
          description: Amazon EC2 instance count for the Resolver on the Outpost.
        PreferredInstanceType:
          type: string
          description: The Amazon EC2 instance type.
        Name:
          type: string
          description: Name of the Resolver.
        Status:
          type: string
          enum:
          - CREATING
          - OPERATIONAL
          - UPDATING
          - DELETING
          - ACTION_NEEDED
          - FAILED_CREATION
          - FAILED_DELETION
          description: Status of the Resolver.
        StatusMessage:
          type: string
          description: A detailed description of the Resolver.
        OutpostArn:
          type: string
          description: The ARN (Amazon Resource Name) for the Outpost.
    GetOutpostResolverResponse:
      type: object
      properties:
        OutpostResolver:
          $ref: '#/components/schemas/OutpostResolver'
  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: route53resolver
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/route53resolver/service/2018-04-01/route53resolver-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)