'2.0', 'metadata' => [ 'apiVersion' => '2015-05-28', 'endpointPrefix' => 'data-ats.iot', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'AWS IoT Data Plane', 'serviceId' => 'IoT Data Plane', 'signatureVersion' => 'v4', 'signingName' => 'iotdata', 'uid' => 'iot-data-2015-05-28', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'DeleteConnection' => [ 'name' => 'DeleteConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/connections/{clientId}', ], 'input' => [ 'shape' => 'DeleteConnectionRequest', ], 'errors' => [ [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'DeleteThingShadow' => [ 'name' => 'DeleteThingShadow', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'DeleteThingShadowRequest', ], 'output' => [ 'shape' => 'DeleteThingShadowResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], [ 'shape' => 'UnsupportedDocumentEncodingException', ], ], ], 'GetConnection' => [ 'name' => 'GetConnection', 'http' => [ 'method' => 'GET', 'requestUri' => '/connections/{clientId}', ], 'input' => [ 'shape' => 'GetConnectionRequest', ], 'output' => [ 'shape' => 'GetConnectionResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'GetRetainedMessage' => [ 'name' => 'GetRetainedMessage', 'http' => [ 'method' => 'GET', 'requestUri' => '/retainedMessage/{topic}', ], 'input' => [ 'shape' => 'GetRetainedMessageRequest', ], 'output' => [ 'shape' => 'GetRetainedMessageResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], ], ], 'GetThingShadow' => [ 'name' => 'GetThingShadow', 'http' => [ 'method' => 'GET', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'GetThingShadowRequest', ], 'output' => [ 'shape' => 'GetThingShadowResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], [ 'shape' => 'UnsupportedDocumentEncodingException', ], ], ], 'ListNamedShadowsForThing' => [ 'name' => 'ListNamedShadowsForThing', 'http' => [ 'method' => 'GET', 'requestUri' => '/api/things/shadow/ListNamedShadowsForThing/{thingName}', ], 'input' => [ 'shape' => 'ListNamedShadowsForThingRequest', ], 'output' => [ 'shape' => 'ListNamedShadowsForThingResponse', ], 'errors' => [ [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], ], ], 'ListRetainedMessages' => [ 'name' => 'ListRetainedMessages', 'http' => [ 'method' => 'GET', 'requestUri' => '/retainedMessage', ], 'input' => [ 'shape' => 'ListRetainedMessagesRequest', ], 'output' => [ 'shape' => 'ListRetainedMessagesResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], ], ], 'ListSubscriptions' => [ 'name' => 'ListSubscriptions', 'http' => [ 'method' => 'GET', 'requestUri' => '/connections/{clientId}/subscriptions', ], 'input' => [ 'shape' => 'ListSubscriptionsRequest', ], 'output' => [ 'shape' => 'ListSubscriptionsResponse', ], 'errors' => [ [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalFailureException', ], ], ], 'Publish' => [ 'name' => 'Publish', 'http' => [ 'method' => 'POST', 'requestUri' => '/topics/{topic}', ], 'input' => [ 'shape' => 'PublishRequest', ], 'errors' => [ [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'MethodNotAllowedException', ], [ 'shape' => 'ThrottlingException', ], ], ], 'SendDirectMessage' => [ 'name' => 'SendDirectMessage', 'http' => [ 'method' => 'POST', 'requestUri' => '/connections/{clientId}/messages', ], 'input' => [ 'shape' => 'SendDirectMessageRequest', ], 'output' => [ 'shape' => 'SendDirectMessageResponse', ], 'errors' => [ [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ForbiddenException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'RequestEntityTooLargeException', ], [ 'shape' => 'GatewayTimeoutException', ], ], ], 'UpdateThingShadow' => [ 'name' => 'UpdateThingShadow', 'http' => [ 'method' => 'POST', 'requestUri' => '/things/{thingName}/shadow', ], 'input' => [ 'shape' => 'UpdateThingShadowRequest', ], 'output' => [ 'shape' => 'UpdateThingShadowResponse', ], 'errors' => [ [ 'shape' => 'ConflictException', ], [ 'shape' => 'RequestEntityTooLargeException', ], [ 'shape' => 'InvalidRequestException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'UnauthorizedException', ], [ 'shape' => 'ServiceUnavailableException', ], [ 'shape' => 'InternalFailureException', ], [ 'shape' => 'MethodNotAllowedException', ], [ 'shape' => 'UnsupportedDocumentEncodingException', ], ], ], ], 'shapes' => [ 'CleanSession' => [ 'type' => 'boolean', ], 'ClientId' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^[^$].*', ], 'Confirmation' => [ 'type' => 'boolean', ], 'ConflictException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'Connected' => [ 'type' => 'boolean', ], 'ContentType' => [ 'type' => 'string', ], 'CorrelationData' => [ 'type' => 'string', ], 'DeleteConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'clientId', ], 'members' => [ 'clientId' => [ 'shape' => 'ClientId', 'location' => 'uri', 'locationName' => 'clientId', ], 'cleanSession' => [ 'shape' => 'CleanSession', 'location' => 'querystring', 'locationName' => 'cleanSession', ], 'preventWillMessage' => [ 'shape' => 'PreventWillMessage', 'location' => 'querystring', 'locationName' => 'preventWillMessage', ], ], ], 'DeleteThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'shadowName' => [ 'shape' => 'ShadowName', 'location' => 'querystring', 'locationName' => 'name', ], ], ], 'DeleteThingShadowResponse' => [ 'type' => 'structure', 'required' => [ 'payload', ], 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'DisconnectReason' => [ 'type' => 'string', ], 'ForbiddenException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'GatewayTimeoutException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 504, ], 'exception' => true, ], 'GetConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'clientId', ], 'members' => [ 'clientId' => [ 'shape' => 'ClientId', 'location' => 'uri', 'locationName' => 'clientId', ], 'includeSocketInformation' => [ 'shape' => 'IncludeSocketInformation', 'location' => 'querystring', 'locationName' => 'includeSocketInformation', ], ], ], 'GetConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'connected' => [ 'shape' => 'Connected', ], 'thingName' => [ 'shape' => 'ThingName', ], 'cleanSession' => [ 'shape' => 'CleanSession', ], 'sourceIp' => [ 'shape' => 'SourceIp', ], 'sourcePort' => [ 'shape' => 'SourcePort', ], 'targetIp' => [ 'shape' => 'TargetIp', ], 'targetPort' => [ 'shape' => 'TargetPort', ], 'keepAliveDuration' => [ 'shape' => 'KeepAliveDuration', ], 'connectedSince' => [ 'shape' => 'Timestamp', ], 'disconnectedSince' => [ 'shape' => 'Timestamp', ], 'disconnectReason' => [ 'shape' => 'DisconnectReason', ], 'sessionExpiry' => [ 'shape' => 'SessionExpiry', ], 'clientId' => [ 'shape' => 'ClientId', ], 'vpcEndpointId' => [ 'shape' => 'VpcEndpointId', ], ], ], 'GetRetainedMessageRequest' => [ 'type' => 'structure', 'required' => [ 'topic', ], 'members' => [ 'topic' => [ 'shape' => 'Topic', 'location' => 'uri', 'locationName' => 'topic', ], ], ], 'GetRetainedMessageResponse' => [ 'type' => 'structure', 'members' => [ 'topic' => [ 'shape' => 'Topic', ], 'payload' => [ 'shape' => 'Payload', ], 'qos' => [ 'shape' => 'Qos', ], 'lastModifiedTime' => [ 'shape' => 'Timestamp', ], 'userProperties' => [ 'shape' => 'UserPropertiesBlob', ], ], ], 'GetThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'shadowName' => [ 'shape' => 'ShadowName', 'location' => 'querystring', 'locationName' => 'name', ], ], ], 'GetThingShadowResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'IncludeSocketInformation' => [ 'type' => 'boolean', ], 'InternalFailureException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'InvalidRequestException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'JsonDocument' => [ 'type' => 'blob', ], 'KeepAliveDuration' => [ 'type' => 'integer', ], 'ListNamedShadowsForThingRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'pageSize' => [ 'shape' => 'PageSize', 'location' => 'querystring', 'locationName' => 'pageSize', ], ], ], 'ListNamedShadowsForThingResponse' => [ 'type' => 'structure', 'members' => [ 'results' => [ 'shape' => 'NamedShadowList', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'ListRetainedMessagesRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListRetainedMessagesResponse' => [ 'type' => 'structure', 'members' => [ 'retainedTopics' => [ 'shape' => 'RetainedMessageList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListSubscriptionsRequest' => [ 'type' => 'structure', 'required' => [ 'clientId', ], 'members' => [ 'clientId' => [ 'shape' => 'ClientId', 'location' => 'uri', 'locationName' => 'clientId', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'maxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], ], ], 'ListSubscriptionsResponse' => [ 'type' => 'structure', 'members' => [ 'subscriptions' => [ 'shape' => 'SubscriptionList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'MaxResults' => [ 'type' => 'integer', 'max' => 200, 'min' => 1, ], 'MessageExpiry' => [ 'type' => 'long', ], 'MethodNotAllowedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 405, ], 'exception' => true, ], 'NamedShadowList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ShadowName', ], ], 'NextToken' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'max' => 100, 'min' => 1, ], 'Payload' => [ 'type' => 'blob', ], 'PayloadFormatIndicator' => [ 'type' => 'string', 'enum' => [ 'UNSPECIFIED_BYTES', 'UTF8_DATA', ], ], 'PayloadSize' => [ 'type' => 'long', ], 'PreventWillMessage' => [ 'type' => 'boolean', ], 'PublishRequest' => [ 'type' => 'structure', 'required' => [ 'topic', ], 'members' => [ 'topic' => [ 'shape' => 'Topic', 'location' => 'uri', 'locationName' => 'topic', ], 'qos' => [ 'shape' => 'Qos', 'location' => 'querystring', 'locationName' => 'qos', ], 'retain' => [ 'shape' => 'Retain', 'location' => 'querystring', 'locationName' => 'retain', ], 'payload' => [ 'shape' => 'Payload', ], 'userProperties' => [ 'shape' => 'UserProperties', 'jsonvalue' => true, 'location' => 'header', 'locationName' => 'x-amz-mqtt5-user-properties', ], 'payloadFormatIndicator' => [ 'shape' => 'PayloadFormatIndicator', 'location' => 'header', 'locationName' => 'x-amz-mqtt5-payload-format-indicator', ], 'contentType' => [ 'shape' => 'ContentType', 'location' => 'querystring', 'locationName' => 'contentType', ], 'responseTopic' => [ 'shape' => 'ResponseTopic', 'location' => 'querystring', 'locationName' => 'responseTopic', ], 'correlationData' => [ 'shape' => 'CorrelationData', 'location' => 'header', 'locationName' => 'x-amz-mqtt5-correlation-data', ], 'messageExpiry' => [ 'shape' => 'MessageExpiry', 'location' => 'querystring', 'locationName' => 'messageExpiry', ], ], 'payload' => 'payload', ], 'Qos' => [ 'type' => 'integer', 'max' => 1, 'min' => 0, ], 'RequestEntityTooLargeException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 413, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResponseMessage' => [ 'type' => 'string', ], 'ResponseTopic' => [ 'type' => 'string', ], 'Retain' => [ 'type' => 'boolean', ], 'RetainedMessageList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RetainedMessageSummary', ], ], 'RetainedMessageSummary' => [ 'type' => 'structure', 'members' => [ 'topic' => [ 'shape' => 'Topic', ], 'payloadSize' => [ 'shape' => 'PayloadSize', ], 'qos' => [ 'shape' => 'Qos', ], 'lastModifiedTime' => [ 'shape' => 'Timestamp', ], ], ], 'SendDirectMessageRequest' => [ 'type' => 'structure', 'required' => [ 'clientId', 'topic', ], 'members' => [ 'clientId' => [ 'shape' => 'ClientId', 'location' => 'uri', 'locationName' => 'clientId', ], 'topic' => [ 'shape' => 'Topic', 'location' => 'querystring', 'locationName' => 'topic', ], 'contentType' => [ 'shape' => 'ContentType', 'location' => 'querystring', 'locationName' => 'contentType', ], 'responseTopic' => [ 'shape' => 'ResponseTopic', 'location' => 'querystring', 'locationName' => 'responseTopic', ], 'confirmation' => [ 'shape' => 'Confirmation', 'location' => 'querystring', 'locationName' => 'confirmation', ], 'timeout' => [ 'shape' => 'TimeoutInSeconds', 'location' => 'querystring', 'locationName' => 'timeout', ], 'payload' => [ 'shape' => 'Payload', ], 'userProperties' => [ 'shape' => 'UserProperties', 'jsonvalue' => true, 'location' => 'header', 'locationName' => 'x-amz-mqtt5-user-properties', ], 'payloadFormatIndicator' => [ 'shape' => 'PayloadFormatIndicator', 'location' => 'header', 'locationName' => 'x-amz-mqtt5-payload-format-indicator', ], 'correlationData' => [ 'shape' => 'CorrelationData', 'location' => 'header', 'locationName' => 'x-amz-mqtt5-correlation-data', ], ], 'payload' => 'payload', ], 'SendDirectMessageResponse' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ResponseMessage', ], 'traceId' => [ 'shape' => 'TraceId', ], ], ], 'ServiceUnavailableException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 503, ], 'exception' => true, 'fault' => true, ], 'SessionExpiry' => [ 'type' => 'long', ], 'ShadowName' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '[$a-zA-Z0-9:_-]+', ], 'SourceIp' => [ 'type' => 'string', ], 'SourcePort' => [ 'type' => 'integer', ], 'SubscriptionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubscriptionSummary', ], ], 'SubscriptionSummary' => [ 'type' => 'structure', 'required' => [ 'topicFilter', 'qos', ], 'members' => [ 'topicFilter' => [ 'shape' => 'TopicFilter', ], 'qos' => [ 'shape' => 'Qos', ], ], ], 'TargetIp' => [ 'type' => 'string', ], 'TargetPort' => [ 'type' => 'integer', ], 'ThingName' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '[a-zA-Z0-9:_-]+', ], 'ThrottlingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TimeoutInSeconds' => [ 'type' => 'integer', ], 'Timestamp' => [ 'type' => 'long', ], 'Topic' => [ 'type' => 'string', ], 'TopicFilter' => [ 'type' => 'string', ], 'TraceId' => [ 'type' => 'string', ], 'UnauthorizedException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 401, ], 'exception' => true, ], 'UnsupportedDocumentEncodingException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'errorMessage', ], ], 'error' => [ 'httpStatusCode' => 415, ], 'exception' => true, ], 'UpdateThingShadowRequest' => [ 'type' => 'structure', 'required' => [ 'thingName', 'payload', ], 'members' => [ 'thingName' => [ 'shape' => 'ThingName', 'location' => 'uri', 'locationName' => 'thingName', ], 'shadowName' => [ 'shape' => 'ShadowName', 'location' => 'querystring', 'locationName' => 'name', ], 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'UpdateThingShadowResponse' => [ 'type' => 'structure', 'members' => [ 'payload' => [ 'shape' => 'JsonDocument', ], ], 'payload' => 'payload', ], 'UserProperties' => [ 'type' => 'string', ], 'UserPropertiesBlob' => [ 'type' => 'blob', ], 'VpcEndpointId' => [ 'type' => 'string', ], 'errorMessage' => [ 'type' => 'string', ], ],];