Amazon Device Farm #X Amz Target=DeviceFarm 20150623.GetAccountSettings API

openapi: 3.0.0
info:
  version: 2015-06-23
  x-release: v4
  title: 'AWS Device Farm #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.GetAccountSettings API'
  description: <p>Welcome to the AWS Device Farm API documentation, which contains APIs for:</p> <ul> <li> <p>Testing on desktop browsers</p> <p> Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain <code>TestGrid</code> in their names. For more information, see <a href="https://docs.aws.amazon.com/devicefarm/latest/testgrid/">Testing Web Applications on Selenium with Device Farm</a>.</p> </li> <li> <p>Testing on real mobile devices</p> <p>Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/">Device Farm Developer Guide</a>.</p> </li> </ul>
  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: devicefarm
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devicefarm-2015-06-23.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://devicefarm.{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 AWS Device Farm multi-region endpoint
- url: https://devicefarm.{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 AWS Device Farm multi-region endpoint
- url: http://devicefarm.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
- url: https://devicefarm.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DeviceFarm 20150623.GetAccountSettings'
paths:
  /#X-Amz-Target=DeviceFarm_20150623.GetAccountSettings:
    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: GetAccountSettings
      description: Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountSettingsResult'
        '480':
          description: ArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArgumentException'
        '481':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '482':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '483':
          description: ServiceAccountException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceAccountException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountSettingsRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DeviceFarm_20150623.GetAccountSettings
      tags:
      - '#X Amz Target=DeviceFarm 20150623.GetAccountSettings'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      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-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    PurchasedDevicesMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Integer'
    Integer:
      type: integer
    LimitExceededException: {}
    AWSAccountNumber:
      type: string
      minLength: 2
      maxLength: 16
    GetAccountSettingsRequest:
      type: object
      title: GetAccountSettingsRequest
      properties: {}
      description: Represents the request sent to retrieve the account settings.
    GetAccountSettingsResult:
      type: object
      example:
        accountSettings:
          awsAccountNumber: '123456789101'
          unmeteredDevices:
            ANDROID: 1
            IOS: 2
      properties:
        accountSettings:
          allOf:
          - $ref: '#/components/schemas/AccountSettings'
          - description: The account settings.
      description: Represents the account settings return values from the <code>GetAccountSettings</code> request.
    AccountSettings:
      type: object
      properties:
        awsAccountNumber:
          allOf:
          - $ref: '#/components/schemas/AWSAccountNumber'
          - description: The AWS account number specified in the <code>AccountSettings</code> container.
        unmeteredDevices:
          allOf:
          - $ref: '#/components/schemas/PurchasedDevicesMap'
          - description: Returns the unmetered devices you have purchased or want to purchase.
        unmeteredRemoteAccessDevices:
          allOf:
          - $ref: '#/components/schemas/PurchasedDevicesMap'
          - description: Returns the unmetered remote access devices you have purchased or want to purchase.
        maxJobTimeoutMinutes:
          allOf:
          - $ref: '#/components/schemas/JobTimeoutMinutes'
          - description: The maximum number of minutes a test run executes before it times out.
        trialMinutes:
          allOf:
          - $ref: '#/components/schemas/TrialMinutes'
          - description: Information about an AWS account's usage of free trial device minutes.
        maxSlots:
          allOf:
          - $ref: '#/components/schemas/MaxSlotMap'
          - description: The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an <code>offering-id:number</code> pair, where the <code>offering-id</code> represents one of the IDs returned by the <code>ListOfferings</code> command.
        defaultJobTimeoutMinutes:
          allOf:
          - $ref: '#/components/schemas/JobTimeoutMinutes'
          - description: The default number of minutes (at the account level) a test run executes before it times out. The default value is 150 minutes.
        skipAppResign:
          allOf:
          - $ref: '#/components/schemas/SkipAppResign'
          - description: <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>
      description: A container for account-level settings in AWS Device Farm.
    MaxSlotMap:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Integer'
    ServiceAccountException: {}
    NotFoundException: {}
    Double:
      type: number
      format: double
    JobTimeoutMinutes:
      type: integer
    ArgumentException: {}
    TrialMinutes:
      type: object
      properties:
        total:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The total number of free trial minutes that the account started with.
        remaining:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The number of free trial minutes remaining in the account.
      description: Represents information about free trial device minutes for an AWS account.
    SkipAppResign:
      type: boolean
  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/devicefarm/
x-hasEquivalentPaths: true