Amazon Cloud Map Cloud Map Service Attribute API

openapi: 3.1.0
info:
  title: AWS Cloud Map Service Attribute API
  version: '2017-03-14'
  description: Generated from AWS's published Smithy model for AWS Cloud Map. 3 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://servicediscovery.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteServiceAttributes:
    post:
      operationId: DeleteServiceAttributes
      summary: Delete Service Attributes
      description: Deletes specific attributes associated with a service.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteServiceAttributesResponse'
              example: {}
        '400':
          description: InvalidInput
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: ServiceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53AutoNaming_v20170314.DeleteServiceAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteServiceAttributesRequest'
            example:
              Attributes:
              - port
              ServiceId: srv-e4anhexample0004
      tags:
      - Service Attribute
  /#GetServiceAttributes:
    post:
      operationId: GetServiceAttributes
      summary: Get Service Attributes
      description: Returns the attributes associated with a specified service.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetServiceAttributesResponse'
              example:
                ServiceAttributes:
                  ServiceArn: arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678
                  Attributes:
                    Port: '80'
                  ResourceOwner: '123456789012'
        '400':
          description: InvalidInput
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: ServiceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53AutoNaming_v20170314.GetServiceAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetServiceAttributesRequest'
            example:
              ServiceId: arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678
      tags:
      - Service Attribute
  /#UpdateServiceAttributes:
    post:
      operationId: UpdateServiceAttributes
      summary: Update Service Attributes
      description: Submits a request to update a specified service to add service-level attributes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateServiceAttributesResponse'
              example: {}
        '400':
          description: InvalidInput; ServiceAttributesLimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidInput'
        '404':
          description: ServiceNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Route53AutoNaming_v20170314.UpdateServiceAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateServiceAttributesRequest'
            example:
              ServiceId: arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678
              Attributes:
                Port: '8080'
                Protocol: HTTP
      tags:
      - Service Attribute
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: servicediscovery
  schemas:
    DeleteServiceAttributesRequest:
      type: object
      properties:
        ServiceId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the service from which the attributes will be deleted. For
            services created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more
            information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer
            Guide.
        Attributes:
          type: array
          items:
            type: string
          description: A list of keys corresponding to each attribute that you want to delete.
      required:
      - ServiceId
      - Attributes
    DeleteServiceAttributesResponse:
      type: object
      properties: {}
    GetServiceAttributesRequest:
      type: object
      properties:
        ServiceId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the service that you want to get attributes for. For services
            created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information
            about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.
      required:
      - ServiceId
    GetServiceAttributesResponse:
      type: object
      properties:
        ServiceAttributes:
          $ref: '#/components/schemas/ServiceAttributes'
    InvalidInput:
      type: object
      properties:
        Message:
          type: string
    ServiceAttributes:
      type: object
      properties:
        ServiceArn:
          type: string
          description: The ARN of the service that the attributes are associated with.
        ResourceOwner:
          type: string
          description: The ID of the Amazon Web Services account that created the namespace with which the service is associated.
            If this isn't your account ID, it is the ID of the account that shared the namespace with your account. For more
            information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer
            Guide.
        Attributes:
          type: object
          additionalProperties:
            type: string
          description: 'A string map that contains the following information for the service that you specify in ServiceArn:
            The attributes that apply to the service. For each attribute, the applicable value. You can specify a total of
            30 attributes.'
    ServiceNotFound:
      type: object
      properties:
        Message:
          type: string
    UpdateServiceAttributesRequest:
      type: object
      properties:
        ServiceId:
          type: string
          description: The ID or Amazon Resource Name (ARN) of the service that you want to update. For services created in
            a namespace shared with your Amazon Web Services account, specify the service ARN.
        Attributes:
          type: object
          additionalProperties:
            type: string
          description: A string map that contains attribute key-value pairs.
      required:
      - ServiceId
      - Attributes
    UpdateServiceAttributesResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)