openapi: 3.0.0 info: version: '2019-12-02' x-release: v4 title: AWS IoT SiteWise Access Policies Logging 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: Logging paths: /logging: 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: DescribeLoggingOptions description: Retrieves the current IoT SiteWise logging options. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeLoggingOptionsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] summary: Amazon IoT SiteWise Describe Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Logging put: operationId: PutLoggingOptions description: Sets logging options for IoT SiteWise. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PutLoggingOptionsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ConflictingOperationException content: application/json: schema: $ref: '#/components/schemas/ConflictingOperationException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - loggingOptions properties: loggingOptions: description: Contains logging options. type: object properties: level: allOf: - $ref: '#/components/schemas/LoggingLevel' - description: The IoT SiteWise logging verbosity level. summary: Amazon IoT SiteWise Put Logging Options x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Logging components: parameters: 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 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 schemas: DescribeLoggingOptionsResponse: type: object required: - loggingOptions properties: loggingOptions: allOf: - $ref: '#/components/schemas/LoggingOptions' - description: The current logging options. LoggingLevel: type: string enum: - ERROR - INFO - 'OFF' InternalFailureException: {} PutLoggingOptionsResponse: type: object properties: {} ThrottlingException: {} ConflictingOperationException: {} LoggingOptions: type: object required: - level properties: level: allOf: - $ref: '#/components/schemas/LoggingLevel' - description: The IoT SiteWise logging verbosity level. description: Contains logging options. ResourceNotFoundException: {} InvalidRequestException: {} 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