The Projects API from Amazon IoT SiteWise — 5 operation(s) for projects.
openapi: 3.0.0
info:
version: '2019-12-02'
x-release: v4
title: AWS IoT SiteWise Access Policies Projects API
description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.
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: Projects
paths:
/projects/{projectId}/assets/associate:
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: BatchAssociateProjectAssets
description: Associates a group (batch) of assets with an IoT SiteWise Monitor project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchAssociateProjectAssetsResponse'
'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:
- name: projectId
in: path
required: true
description: The ID of the project to which to associate the assets.
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:
- assetIds
properties:
assetIds:
description: The IDs of the assets to be associated to the project.
type: array
items:
$ref: '#/components/schemas/ID'
minItems: 1
maxItems: 100
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 Batch Associate Project Assets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
/projects/{projectId}/assets/disassociate:
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: BatchDisassociateProjectAssets
description: Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDisassociateProjectAssetsResponse'
'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: projectId
in: path
required: true
description: The ID of the project from which to disassociate the assets.
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:
- assetIds
properties:
assetIds:
description: The IDs of the assets to be disassociated from the project.
type: array
items:
$ref: '#/components/schemas/ID'
minItems: 1
maxItems: 100
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 Batch Disassociate Project Assets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
/projects:
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: CreateProject
description: <p>Creates a project in the specified portal.</p> <note> <p>Make sure that the project name and description don't contain confidential information.</p> </note>
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectResponse'
'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:
- portalId
- projectName
properties:
portalId:
description: The ID of the portal in which to create the project.
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
projectName:
description: A friendly name for the project.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
projectDescription:
description: A description for the project.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
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 project. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon IoT SiteWise Create Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
/projects/{projectId}:
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: DeleteProject
description: Deletes a project from IoT SiteWise Monitor.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProjectResponse'
'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: projectId
in: path
required: true
description: The ID of the project.
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 Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
get:
operationId: DescribeProject
description: Retrieves information about a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProjectResponse'
'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: projectId
in: path
required: true
description: The ID of the project.
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 Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
put:
operationId: UpdateProject
description: Updates an IoT SiteWise Monitor project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectResponse'
'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: projectId
in: path
required: true
description: The ID of the project to update.
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:
- projectName
properties:
projectName:
description: A new friendly name for the project.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
projectDescription:
description: A new description for the project.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
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 Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
/projects/{projectId}/assets:
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'
get:
operationId: ListProjectAssets
description: Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProjectAssetsResponse'
'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: projectId
in: path
required: true
description: The ID of the project.
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: 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: '<p>The maximum number of results to return for each paginated request.</p> <p>Default: 50</p>'
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT SiteWise List Project Assets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Projects
components:
schemas:
ListProjectAssetsResponse:
type: object
required:
- assetIds
properties:
assetIds:
allOf:
- $ref: '#/components/schemas/AssetIDs'
- description: A list that contains the IDs of each asset associated with the project.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
CreateProjectResponse:
type: object
required:
- projectId
- projectArn
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the project.
projectArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}</code> </p>
InternalFailureException: {}
AssetErrorMessage:
type: string
Timestamp:
type: string
format: date-time
UpdateProjectResponse:
type: object
properties: {}
BatchDisassociateProjectAssetsResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/BatchDisassociateProjectAssetsErrors'
- description: A list of associated error information, if any.
BatchAssociateProjectAssetsErrors:
type: array
items:
$ref: '#/components/schemas/AssetErrorDetails'
DeleteProjectResponse:
type: object
properties: {}
TagValue:
type: string
minLength: 0
maxLength: 256
InvalidRequestException: {}
LimitExceededException: {}
DescribeProjectResponse:
type: object
required:
- projectId
- projectArn
- projectName
- portalId
- projectCreationDate
- projectLastUpdateDate
properties:
projectId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the project.
projectArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}</code> </p>
projectName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the project.
portalId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the portal that the project is in.
projectDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: The project's description.
projectCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the project was created, in Unix epoch time.
projectLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the project was last updated, in Unix epoch time.
BatchDisassociateProjectAssetsErrors:
type: array
items:
$ref: '#/components/schemas/AssetErrorDetails'
AssetIDs:
type: array
items:
$ref: '#/components/schemas/ID'
AssetErrorCode:
type: string
enum:
- INTERNAL_FAILURE
Description:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
Name:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
BatchAssociateProjectAssetsResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/BatchAssociateProjectAssetsErrors'
- description: A list of associated error information, if any.
ID:
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
ThrottlingException: {}
AssetErrorDetails:
type: object
required:
- assetId
- code
- message
properties:
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset.
code:
allOf:
- $ref: '#/components/schemas/AssetErrorCode'
- description: The error code.
message:
allOf:
- $ref: '#/components/schemas/AssetErrorMessage'
- description: The error message.
description: Contains error details for the requested associate project asset action.
ResourceNotFoundException: {}
NextToken:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
ARN:
type: string
pattern: .*
minLength: 1
maxLength: 1600
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
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-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
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/iotsitewise/
x-hasEquivalentPaths: true