Amazon GameLift #X Amz Target=GameLift.UpdateFleetAttributes API

openapi: 3.2.0
info:
  version: 2015-10-01
  x-release: v4
  title: 'Amazon GameLift #X Amz Target=GameLift.UpdateFleetAttributes…'
  description: Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: gamelift
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/gamelift-2015-10-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://gamelift.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon GameLift multi-region endpoint
- url: https://gamelift.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon GameLift multi-region endpoint
- url: http://gamelift.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia)
- url: https://gamelift.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GameLift.UpdateFleetAttributes'
paths:
  /#X-Amz-Target=GameLift.UpdateFleetAttributes:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: UpdateFleetAttributes
      description: 'Updates a fleet''s mutable attributes, including game session protection and resource creation limits.


        To update fleet attributes, specify the fleet ID and the property values that you want to change.


        If successful, an updated FleetAttributes object is returned.


        Learn more


        Setting up Amazon GameLift fleets'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFleetAttributesOutput'
              examples:
                UpdateFleetAttributes200Example:
                  summary: Default UpdateFleetAttributes 200 response
                  x-microcks-default: true
                  value:
                    FleetId: fleet-1a2b3c4d-5678-90ab-cdef-1234567890ab
                    FleetArn: arn:aws:gamelift:us-east-1:123456789012:fleet/fleet-1a2b3c4d
        '480':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                UpdateFleetAttributes480Example:
                  summary: Default UpdateFleetAttributes 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                UpdateFleetAttributes481Example:
                  summary: Default UpdateFleetAttributes 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidFleetStatusException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidFleetStatusException'
              examples:
                UpdateFleetAttributes482Example:
                  summary: Default UpdateFleetAttributes 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                UpdateFleetAttributes483Example:
                  summary: Default UpdateFleetAttributes 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateFleetAttributes484Example:
                  summary: Default UpdateFleetAttributes 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                UpdateFleetAttributes485Example:
                  summary: Default UpdateFleetAttributes 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                UpdateFleetAttributes486Example:
                  summary: Default UpdateFleetAttributes 486 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFleetAttributesInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.UpdateFleetAttributes
      summary: Amazon GameLift Update Fleet Attributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.UpdateFleetAttributes'
components:
  schemas:
    AnywhereConfiguration:
      type: object
      required:
      - Cost
      properties:
        Cost:
          allOf:
          - $ref: '#/components/schemas/NonNegativeLimitedLengthDouble'
          - description: The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting up queues</a> in the <i>Amazon GameLift Developer Guide</i>.
      description: Amazon GameLift Anywhere configuration options for your Anywhere fleets.
    LimitExceededException: {}
    MetricGroupList:
      type: array
      items:
        $ref: '#/components/schemas/MetricGroup'
      maxItems: 1
    InvalidFleetStatusException: {}
    InvalidRequestException: {}
    ConflictException: {}
    ProtectionPolicy:
      type: string
      enum:
      - NoProtection
      - FullProtection
    FleetId:
      type: string
      pattern: ^fleet-\S+
    NotFoundException: {}
    NonZeroAndMaxString:
      type: string
      minLength: 1
      maxLength: 1024
    UpdateFleetAttributesOutput:
      type: object
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetId'
          - description: A unique identifier for the fleet that was updated.
        FleetArn:
          allOf:
          - $ref: '#/components/schemas/FleetArn'
          - description: The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.
    FleetIdOrArn:
      type: string
      pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+
    UpdateFleetAttributesInput:
      type: object
      required:
      - FleetId
      title: UpdateFleetAttributesInput
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetIdOrArn'
          - description: A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
        Name:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
        Description:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A human-readable description of a fleet.
        NewGameSessionProtectionPolicy:
          allOf:
          - $ref: '#/components/schemas/ProtectionPolicy'
          - description: <p>The game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>
        ResourceCreationLimitPolicy:
          allOf:
          - $ref: '#/components/schemas/ResourceCreationLimitPolicy'
          - description: 'Policy settings that limit the number of game sessions an individual player can create over a span of time. '
        MetricGroups:
          allOf:
          - $ref: '#/components/schemas/MetricGroupList'
          - description: The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.
        AnywhereConfiguration:
          allOf:
          - $ref: '#/components/schemas/AnywhereConfiguration'
          - description: Amazon GameLift Anywhere configuration options.
    WholeNumber:
      type: integer
      minimum: 0
    NonNegativeLimitedLengthDouble:
      type: string
      pattern: ^\d{1,5}(?:\.\d{1,5})?$
      minLength: 1
      maxLength: 11
    InternalServiceException: {}
    MetricGroup:
      type: string
      minLength: 1
      maxLength: 255
    FleetArn:
      type: string
      pattern: ^arn:.*:fleet\/fleet-\S+
    ResourceCreationLimitPolicy:
      type: object
      properties:
        NewGameSessionsPerCreator:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: <p>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</p> <p>The policy is evaluated when a player tries to create a new game session. On receiving a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by <code>CreatorId</code>) has created fewer than game session limit in the specified time period.</p>
        PolicyPeriodInMinutes:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: 'The time span used in evaluating the resource creation limit policy. '
      description: <p>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</p> <p>The policy is evaluated when a player tries to create a new game session. On receiving a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by <code>CreatorId</code>) has created fewer than game session limit in the specified time period.</p>
    UnauthorizedException: {}
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/gamelift/
x-hasEquivalentPaths: true