Amazon Web Services Devices API

The Devices API from Amazon Web Services — 10 operation(s) for devices.

OpenAPI Specification

amazon-web-services-devices-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Devices API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Devices
paths:
  /devices:
    POST:
      summary: Amazon Web Services Searchdevices
      description: Searches for devices using the specified filters.
      operationId: amazonWebServicesSearchDevices
      tags:
      - Devices
    GET:
      summary: Amazon Web Services Listdevices
      description: Lists the 1-Click compatible devices associated with your AWS account.
      operationId: amazonWebServicesListDevices
      tags:
      - Devices
  /devices/{deviceId}:
    GET:
      summary: Amazon Web Services Describedevice
      description: Given a device ID, returns a DescribeDeviceResponse object describing the<br> details of the device.
      operationId: amazonWebServicesDescribeDevice
      tags:
      - Devices
  /devices/{deviceId}/finalize-claim:
    PUT:
      summary: Amazon Web Services Finalizedeviceclaim
      description: 'Given a device ID, finalizes the claim request for the associated device.<br> Claiming a device consists of initiating a claim, then publishing a device event,<br> and finalizing the claim. For a device of type button, a device event can<br> be published by simply clicking the device.<br> '
      operationId: amazonWebServicesFinalizeDeviceClaim
      tags:
      - Devices
  /devices/{deviceId}/methods:
    POST:
      summary: Amazon Web Services Invokedevicemethod
      description: Given a device ID, issues a request to invoke a named device method (with possible<br> parameters). See the "Example POST" code snippet below.
      operationId: amazonWebServicesInvokeDeviceMethod
      tags:
      - Devices
  /devices/{deviceId}/initiate-claim:
    PUT:
      summary: Amazon Web Services Initiatedeviceclaim
      description: 'Given a device ID, initiates a claim request for the associated device.<br> Claiming a device consists of initiating a claim, then publishing a device event,<br> and finalizing the claim. For a device of type button, a device event can<br> be published by simply clicking the device.<br> '
      operationId: amazonWebServicesInitiateDeviceClaim
      tags:
      - Devices
  /devices/{deviceId}/events:
    GET:
      summary: Amazon Web Services Listdeviceevents
      description: Using a device ID, returns a DeviceEventsResponse object containing an<br> array of events for the device.
      operationId: amazonWebServicesListDeviceEvents
      tags:
      - Devices
  /devices/{deviceId}/unclaim:
    PUT:
      summary: Amazon Web Services Unclaimdevice
      description: Disassociates a device from your AWS account using its device ID.
      operationId: amazonWebServicesUnclaimDevice
      tags:
      - Devices
  /devices/{deviceId}/state:
    PUT:
      summary: Amazon Web Services Updatedevicestate
      description: Using a Boolean value (true or false), this operation<br> enables or disables the device given a device ID.
      operationId: amazonWebServicesUpdateDeviceState
      tags:
      - Devices
  /devices/{DeviceId}:
    PUT:
      summary: Amazon Web Services Updatedevicemetadata
      description: Updates a device's metadata.
      operationId: amazonWebServicesUpdateDeviceMetadata
      tags:
      - Devices
  /devices/{id}:
    PATCH:
      summary: Amazon Web Services Updatedevice
      description: Updates a thin client device.
      operationId: amazonWebServicesUpdateDevice
      tags:
      - Devices