Amazon Web Services Properties API

The Properties API from Amazon Web Services — 8 operation(s) for properties.

OpenAPI Specification

amazon-web-services-properties-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Properties 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: Properties
paths:
  /properties/batch/aggregates:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyaggregates
      description: Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyAggregates
      tags:
      - Properties
  /properties/batch/latest:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyvalue
      description: Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyValue
      tags:
      - Properties
  /properties/batch/history:
    POST:
      summary: Amazon Web Services Batchgetassetpropertyvaluehistory
      description: Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
      operationId: amazonWebServicesBatchGetAssetPropertyValueHistory
      tags:
      - Properties
  /properties:
    POST:
      summary: Amazon Web Services Batchputassetpropertyvalue
      description: 'Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following:   The assetId and propertyId of an asset property.   A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.    With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.  IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.'
      operationId: amazonWebServicesBatchPutAssetPropertyValue
      tags:
      - Properties
  /properties/aggregates:
    GET:
      summary: Amazon Web Services Getassetpropertyaggregates
      description: 'Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following:   The assetId and propertyId of an asset property.   A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.  '
      operationId: amazonWebServicesGetAssetPropertyAggregates
      tags:
      - Properties
  /properties/latest:
    GET:
      summary: Amazon Web Services Getassetpropertyvalue
      description: 'Gets an asset property''s current value. For more information, see Querying current values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following:   The assetId and propertyId of an asset property.   A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.  '
      operationId: amazonWebServicesGetAssetPropertyValue
      tags:
      - Properties
  /properties/history:
    GET:
      summary: Amazon Web Services Getassetpropertyvaluehistory
      description: 'Gets the history of an asset property''s values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following:   The assetId and propertyId of an asset property.   A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.  '
      operationId: amazonWebServicesGetAssetPropertyValueHistory
      tags:
      - Properties
  /properties/interpolated:
    GET:
      summary: Amazon Web Services Getinterpolatedassetpropertyvalues
      description: 'Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. To identify an asset property, you must specify one of the following:   The assetId and propertyId of an asset property.   A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property''s alias, see UpdateAssetProperty.  '
      operationId: amazonWebServicesGetInterpolatedAssetPropertyValues
      tags:
      - Properties