Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.ListDevices API

openapi: 3.2.0
info:
  version: '2016-04-18'
  x-release: v4
  title: 'Amazon Cognito Identity Provider #X Amz…'
  description: With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    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: cognito-idp
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-idp-2016-04-18.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://cognito-idp.{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 Cognito Identity Provider multi-region endpoint
- url: https://cognito-idp.{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 Cognito Identity Provider multi-region endpoint
- url: http://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.ListDevices'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.ListDevices:
    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: ListDevices
      description: 'Lists the sign-in devices that Amazon Cognito has registered to the current user.


        Amazon Cognito doesn''t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can''t use IAM credentials to authorize requests, and you can''t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDevicesResponse'
              examples:
                ListDevices200Example:
                  summary: Default ListDevices 200 response
                  x-microcks-default: true
                  value:
                    Devices: example
                    PaginationToken: example
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
              examples:
                ListDevices480Example:
                  summary: Default ListDevices 480 response
                  x-microcks-default: true
                  value: example
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                ListDevices481Example:
                  summary: Default ListDevices 481 response
                  x-microcks-default: true
                  value: example
        '482':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
              examples:
                ListDevices482Example:
                  summary: Default ListDevices 482 response
                  x-microcks-default: true
                  value: example
        '483':
          description: InvalidUserPoolConfigurationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidUserPoolConfigurationException'
              examples:
                ListDevices483Example:
                  summary: Default ListDevices 483 response
                  x-microcks-default: true
                  value: example
        '484':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                ListDevices484Example:
                  summary: Default ListDevices 484 response
                  x-microcks-default: true
                  value: example
        '485':
          description: PasswordResetRequiredException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetRequiredException'
              examples:
                ListDevices485Example:
                  summary: Default ListDevices 485 response
                  x-microcks-default: true
                  value: example
        '486':
          description: UserNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotFoundException'
              examples:
                ListDevices486Example:
                  summary: Default ListDevices 486 response
                  x-microcks-default: true
                  value: example
        '487':
          description: UserNotConfirmedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserNotConfirmedException'
              examples:
                ListDevices487Example:
                  summary: Default ListDevices 487 response
                  x-microcks-default: true
                  value: example
        '488':
          description: InternalErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
              examples:
                ListDevices488Example:
                  summary: Default ListDevices 488 response
                  x-microcks-default: true
                  value: example
        '489':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
              examples:
                ListDevices489Example:
                  summary: Default ListDevices 489 response
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDevicesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.ListDevices
      summary: Amazon Cognito List Devices
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.ListDevices'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      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-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      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-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    AttributeType:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/AttributeNameType'
          - description: The name of the attribute.
        Value:
          allOf:
          - $ref: '#/components/schemas/AttributeValueType'
          - description: The value of the attribute.
      description: Specifies whether the attribute is standard or custom.
    SearchPaginationTokenType:
      type: string
      pattern: '[\S]+'
      minLength: 1
    InvalidUserPoolConfigurationException: {}
    DateType:
      type: string
      format: date-time
    AttributeValueType:
      type: string
      maxLength: 2048
      format: password
    PasswordResetRequiredException: {}
    DeviceListType:
      type: array
      items:
        $ref: '#/components/schemas/DeviceType'
    DeviceKeyType:
      type: string
      pattern: '[\w-]+_[0-9a-f-]+'
      minLength: 1
      maxLength: 55
    UserNotFoundException: {}
    ListDevicesResponse:
      type: object
      properties:
        Devices:
          allOf:
          - $ref: '#/components/schemas/DeviceListType'
          - description: The devices returned in the list devices response.
        PaginationToken:
          allOf:
          - $ref: '#/components/schemas/SearchPaginationTokenType'
          - description: The pagination token for the list device response.
      description: Represents the response to list devices.
    UserNotConfirmedException: {}
    DeviceType:
      type: object
      properties:
        DeviceKey:
          allOf:
          - $ref: '#/components/schemas/DeviceKeyType'
          - description: The device key.
        DeviceAttributes:
          allOf:
          - $ref: '#/components/schemas/AttributeListType'
          - description: The device attributes.
        DeviceCreateDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The creation date of the device.
        DeviceLastModifiedDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The date and time, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format, when the item was modified.
        DeviceLastAuthenticatedDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The date when the device was last authenticated.
      description: The device type.
    QueryLimitType:
      type: integer
      minimum: 0
      maximum: 60
    ResourceNotFoundException: {}
    NotAuthorizedException: {}
    TokenModelType:
      type: string
      pattern: '[A-Za-z0-9-_=.]+'
      format: password
    AttributeListType:
      type: array
      items:
        $ref: '#/components/schemas/AttributeType'
    AttributeNameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 32
    ForbiddenException: {}
    TooManyRequestsException: {}
    InternalErrorException: {}
    ListDevicesRequest:
      type: object
      required:
      - AccessToken
      title: ListDevicesRequest
      properties:
        AccessToken:
          allOf:
          - $ref: '#/components/schemas/TokenModelType'
          - description: A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
        Limit:
          allOf:
          - $ref: '#/components/schemas/QueryLimitType'
          - description: The limit of the device request.
        PaginationToken:
          allOf:
          - $ref: '#/components/schemas/SearchPaginationTokenType'
          - description: The pagination token for the list request.
      description: Represents the request to list the devices.
    InvalidParameterException: {}
  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/cognito-idp/
x-hasEquivalentPaths: true