openapi: 3.0.0 info: version: '2019-12-02' x-release: v4 title: AWS IoT SiteWise Access Policies API description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide. 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: iotsitewise x-aws-signingName: iotsitewise x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotsitewise-2019-12-02.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://iotsitewise.{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 IoT SiteWise multi-region endpoint - url: https://iotsitewise.{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 IoT SiteWise multi-region endpoint - url: http://iotsitewise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia) - url: https://iotsitewise.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS IoT SiteWise endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Access Policies paths: /access-policies: 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: CreateAccessPolicy description: Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAccessPolicyResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - accessPolicyIdentity - accessPolicyResource - accessPolicyPermission properties: accessPolicyIdentity: description:
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
ADMINISTRATOR is also known as a project owner.
type: string
enum:
- ADMINISTRATOR
- VIEWER
clientToken:
description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
type: string
pattern: \S{36,64}
minLength: 36
maxLength: 64
tags:
description: A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon IoT SiteWise Create Access Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Access Policies
get:
operationId: ListAccessPolicies
description: Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessPoliciesResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: identityType
in: query
required: false
description: The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.
schema:
type: string
enum:
- USER
- GROUP
- IAM
- name: identityId
in: query
required: false
description: The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.
schema:
type: string
pattern: \S+
minLength: 1
maxLength: 256
- name: resourceType
in: query
required: false
description: The type of resource (portal or project). This parameter is required if you specify resourceId.
schema:
type: string
enum:
- PORTAL
- PROJECT
- name: resourceId
in: query
required: false
description: The ID of the resource. This parameter is required if you specify resourceType.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
- name: iamArn
in: query
required: false
description: The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
schema:
type: string
pattern: .*
minLength: 1
maxLength: 1600
- name: nextToken
in: query
required: false
description: The token to be used for the next set of paginated results.
schema:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
- name: maxResults
in: query
required: false
description: 'The maximum number of results to return for each paginated request.
Default: 50
' schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT SiteWise List Access Policies x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Access Policies /access-policies/{accessPolicyId}: 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' delete: operationId: DeleteAccessPolicy description: Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. responses: '204': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteAccessPolicyResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: accessPolicyId in: path required: true description: The ID of the access policy to be deleted. schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 - name: clientToken in: query required: false description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required. schema: type: string pattern: \S{36,64} minLength: 36 maxLength: 64 summary: Amazon IoT SiteWise Delete Access Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Access Policies get: operationId: DescribeAccessPolicy description: Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAccessPolicyResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: accessPolicyId in: path required: true description: The ID of the access policy. schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 summary: Amazon IoT SiteWise Describe Access Policy x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Access Policies put: operationId: UpdateAccessPolicy description: Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAccessPolicyResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: accessPolicyId in: path required: true description: The ID of the access policy. schema: type: string pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ minLength: 36 maxLength: 36 requestBody: required: true content: application/json: schema: type: object required: - accessPolicyIdentity - accessPolicyResource - accessPolicyPermission properties: accessPolicyIdentity: description:Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
ADMINISTRATOR is also known as a project owner.
type: string
enum:
- ADMINISTRATOR
- VIEWER
clientToken:
description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
type: string
pattern: \S{36,64}
minLength: 36
maxLength: 64
summary: Amazon IoT SiteWise Update Access Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Access Policies
components:
schemas:
CreateAccessPolicyResponse:
type: object
required:
- accessPolicyId
- accessPolicyArn
properties:
accessPolicyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the access policy.
accessPolicyArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
ADMINISTRATOR is also known as a project owner.
creationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the access policy was created, in Unix epoch time.
lastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the access policy was last updated, in Unix epoch time.
description: Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
IAMRoleIdentity:
type: object
required:
- arn
properties:
arn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide.
description: Contains information about an Identity and Access Management role. For more information, see IAM roles in the IAM User Guide.
IdentityId:
type: string
pattern: \S+
minLength: 1
maxLength: 256
TagValue:
type: string
minLength: 0
maxLength: 256
Identity:
type: object
properties:
user:
allOf:
- $ref: '#/components/schemas/UserIdentity'
- description: An IAM Identity Center user identity.
group:
allOf:
- $ref: '#/components/schemas/GroupIdentity'
- description: An IAM Identity Center group identity.
iamUser:
allOf:
- $ref: '#/components/schemas/IAMUserIdentity'
- description: An IAM user identity.
iamRole:
allOf:
- $ref: '#/components/schemas/IAMRoleIdentity'
- description: An IAM role identity.
description: Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
ADMINISTRATOR is also known as a project owner.
accessPolicyCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the access policy was created, in Unix epoch time.
accessPolicyLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the access policy was last updated, in Unix epoch time.
IAMUserIdentity:
type: object
required:
- arn
properties:
arn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.