openapi: 3.2.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT V2Logging Level API
description: 'IoT
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
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: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.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://iot.{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 multi-region endpoint
- url: https://iot.{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 multi-region endpoint
- url: http://iot.{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 endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{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 endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: V2 Logging Level
paths:
/v2LoggingLevel#targetType&targetName:
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: DeleteV2LoggingLevel
description: 'Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.'
responses:
'200':
description: Success
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
parameters:
- name: targetType
in: query
required: true
description: The type of resource for which you are configuring logging. Must be THING_Group.
schema:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
- name: targetName
in: query
required: true
description: The name of the resource for which you are configuring logging.
schema:
type: string
summary: Amazon IoT Device Management Delete V2 Logging Level
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- V2 Logging Level
/v2LoggingLevel:
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: ListV2LoggingLevels
description: 'Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListV2LoggingLevelsResponse'
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: NotConfiguredException
content:
application/json:
schema:
$ref: '#/components/schemas/NotConfiguredException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
parameters:
- name: targetType
in: query
required: false
description: The type of resource for which you are configuring logging. Must be THING_Group.
schema:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
- name: nextToken
in: query
required: false
description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
summary: Amazon IoT Device Management List V2 Logging Levels
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- V2 Logging Level
post:
operationId: SetV2LoggingLevel
description: 'Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.'
responses:
'200':
description: Success
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: NotConfiguredException
content:
application/json:
schema:
$ref: '#/components/schemas/NotConfiguredException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- logTarget
- logLevel
properties:
logTarget:
description: A log target.
type: object
properties:
targetType:
allOf:
- $ref: '#/components/schemas/LogTargetType'
- description: The target type.
targetName:
allOf:
- $ref: '#/components/schemas/LogTargetName'
- description: The target name.
logLevel:
description: The log level.
type: string
enum:
- DEBUG
- INFO
- ERROR
- WARN
- DISABLED
summary: Amazon IoT Device Management Set V2 Logging Level
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- V2 Logging Level
components:
schemas:
LogTargetConfiguration:
type: object
properties:
logTarget:
allOf:
- $ref: '#/components/schemas/LogTarget'
- description: A log target
logLevel:
allOf:
- $ref: '#/components/schemas/LogLevel'
- description: The logging level.
description: The target configuration.
LogTargetName:
type: string
LogTarget:
type: object
required:
- targetType
properties:
targetType:
allOf:
- $ref: '#/components/schemas/LogTargetType'
- description: The target type.
targetName:
allOf:
- $ref: '#/components/schemas/LogTargetName'
- description: The target name.
description: A log target.
ListV2LoggingLevelsResponse:
type: object
properties:
logTargetConfigurations:
allOf:
- $ref: '#/components/schemas/LogTargetConfigurations'
- description: The logging configuration for a target.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to use to get the next set of results, or null if there are no additional results.
LimitExceededException: {}
InvalidRequestException: {}
LogTargetType:
type: string
enum:
- DEFAULT
- THING_GROUP
- CLIENT_ID
- SOURCE_IP
- PRINCIPAL_ID
ServiceUnavailableException: {}
LogTargetConfigurations:
type: array
items:
$ref: '#/components/schemas/LogTargetConfiguration'
NotConfiguredException: {}
NextToken:
type: string
LogLevel:
type: string
enum:
- DEBUG
- INFO
- ERROR
- WARN
- DISABLED
InternalException: {}
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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-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-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-Content-Sha256:
name: X-Amz-Content-Sha256
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/iot/
x-hasEquivalentPaths: true