Amazon Route 53 Route 53 Profile API

openapi: 3.1.0
info:
  title: Amazon Route 53 Profile API
  version: '2013-04-01'
  description: Generated from AWS's published Smithy model for Amazon Route 53. 4 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://route53profiles.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /profile:
    post:
      operationId: CreateProfile
      summary: Create Profile
      description: Creates an empty Route 53 Profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProfileResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProfileRequest'
      tags:
      - Profile
  /profile/{ProfileId}:
    delete:
      operationId: DeleteProfile
      summary: Delete Profile
      description: Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it
        from all VPCs.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteProfileResponse'
        '400':
          description: AccessDeniedException; ConflictException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteProfileRequest'
      tags:
      - Profile
    get:
      operationId: GetProfile
      summary: Get Profile
      description: Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared,
        and the current status of the Profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProfileResponse'
        '400':
          description: AccessDeniedException; ResourceNotFoundException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProfileRequest'
      tags:
      - Profile
  /profiles:
    get:
      operationId: ListProfiles
      summary: List Profiles
      description: Lists all the Route 53 Profiles associated with your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProfilesResponse'
        '400':
          description: AccessDeniedException; InvalidNextTokenException; InvalidParameterException; ThrottlingException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProfilesRequest'
      tags:
      - Profile
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: route53profiles
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CreateProfileRequest:
      type: object
      properties:
        Name:
          type: string
          description: A name for the Profile.
        ClientToken:
          type: string
          description: ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose
            the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this
            case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Route53ProfilesTag'
          description: A list of the tag keys and values that you want to associate with the Route 53 Profile.
      required:
      - Name
      - ClientToken
    CreateProfileResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/Profile'
    DeleteProfileRequest:
      type: object
      properties:
        ProfileId:
          type: string
          description: The ID of the Profile that you want to delete.
      required:
      - ProfileId
    DeleteProfileResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/Profile'
    GetProfileRequest:
      type: object
      properties:
        ProfileId:
          type: string
          description: ID of the Profile.
      required:
      - ProfileId
    GetProfileResponse:
      type: object
      properties:
        Profile:
          $ref: '#/components/schemas/Profile'
    ListProfilesRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of objects that you want to return for this request. If more objects are available,
            in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is
            provided. If you don't specify a value for MaxResults, up to 100 objects are returned.
        NextToken:
          type: string
          description: For the first call to this list request, omit this value. When you request a list of objects, at most
            the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken
            value is returned in the response. To retrieve the next batch of objects, use the token that was returned for
            the prior request in your next request.
    ListProfilesResponse:
      type: object
      properties:
        ProfileSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ProfileSummary'
          description: Summary information about the Profiles.
        NextToken:
          type: string
          description: If more than MaxResults resource associations match the specified criteria, you can submit another
            ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from
            the previous response.
    Profile:
      type: object
      properties:
        Id:
          type: string
          description: ID of the Profile.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Profile.
        Name:
          type: string
          description: Name of the Profile.
        OwnerId:
          type: string
          description: Amazon Web Services account ID of the Profile owner.
        Status:
          type: string
          enum:
          - COMPLETE
          - DELETING
          - UPDATING
          - CREATING
          - DELETED
          - FAILED
          description: The status for the Profile.
        StatusMessage:
          type: string
          description: Status message that includes additiona information about the Profile.
        ShareStatus:
          type: string
          enum:
          - NOT_SHARED
          - SHARED_WITH_ME
          - SHARED_BY_ME
          description: Sharing status for the Profile.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the Profile was created, in Unix time format and Coordinated Universal Time
            (UTC).
        ModificationTime:
          type: string
          format: date-time
          description: The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time
            (UTC).
        ClientToken:
          type: string
          description: The ClientToken value that was assigned when the Profile was created.
    ProfileSummary:
      type: object
      properties:
        Id:
          type: string
          description: ID of the Profile.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the Profile.
        Name:
          type: string
          description: Name of the Profile.
        ShareStatus:
          type: string
          enum:
          - NOT_SHARED
          - SHARED_WITH_ME
          - SHARED_BY_ME
          description: Share status of the Profile.
    Route53ProfilesTag:
      type: object
      properties:
        Key:
          type: string
          description: Key associated with the Tag.
        Value:
          type: string
          description: Value for the Tag.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/route53profiles/service/2018-05-10/route53profiles-2018-05-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)