{ "version":"2.0", "metadata":{ "apiVersion":"2020-11-22", "endpointPrefix":"api.iotwireless", "protocol":"rest-json", "serviceFullName":"AWS IoT Wireless", "serviceId":"IoT Wireless", "signatureVersion":"v4", "signingName":"iotwireless", "uid":"iotwireless-2020-11-22" }, "operations":{ "AssociateAwsAccountWithPartnerAccount":{ "name":"AssociateAwsAccountWithPartnerAccount", "http":{ "method":"POST", "requestUri":"/partner-accounts" }, "input":{"shape":"AssociateAwsAccountWithPartnerAccountRequest"}, "output":{"shape":"AssociateAwsAccountWithPartnerAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Associates a partner account with your AWS account.

" }, "AssociateWirelessDeviceWithThing":{ "name":"AssociateWirelessDeviceWithThing", "http":{ "method":"PUT", "requestUri":"/wireless-devices/{Id}/thing", "responseCode":204 }, "input":{"shape":"AssociateWirelessDeviceWithThingRequest"}, "output":{"shape":"AssociateWirelessDeviceWithThingResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Associates a wireless device with a thing.

" }, "AssociateWirelessGatewayWithCertificate":{ "name":"AssociateWirelessGatewayWithCertificate", "http":{ "method":"PUT", "requestUri":"/wireless-gateways/{Id}/certificate" }, "input":{"shape":"AssociateWirelessGatewayWithCertificateRequest"}, "output":{"shape":"AssociateWirelessGatewayWithCertificateResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Associates a wireless gateway with a certificate.

" }, "AssociateWirelessGatewayWithThing":{ "name":"AssociateWirelessGatewayWithThing", "http":{ "method":"PUT", "requestUri":"/wireless-gateways/{Id}/thing", "responseCode":204 }, "input":{"shape":"AssociateWirelessGatewayWithThingRequest"}, "output":{"shape":"AssociateWirelessGatewayWithThingResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Associates a wireless gateway with a thing.

" }, "CreateDestination":{ "name":"CreateDestination", "http":{ "method":"POST", "requestUri":"/destinations", "responseCode":201 }, "input":{"shape":"CreateDestinationRequest"}, "output":{"shape":"CreateDestinationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a new destination that maps a device message to an AWS IoT rule.

" }, "CreateDeviceProfile":{ "name":"CreateDeviceProfile", "http":{ "method":"POST", "requestUri":"/device-profiles", "responseCode":201 }, "input":{"shape":"CreateDeviceProfileRequest"}, "output":{"shape":"CreateDeviceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a new device profile.

" }, "CreateServiceProfile":{ "name":"CreateServiceProfile", "http":{ "method":"POST", "requestUri":"/service-profiles", "responseCode":201 }, "input":{"shape":"CreateServiceProfileRequest"}, "output":{"shape":"CreateServiceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a new service profile.

" }, "CreateWirelessDevice":{ "name":"CreateWirelessDevice", "http":{ "method":"POST", "requestUri":"/wireless-devices", "responseCode":201 }, "input":{"shape":"CreateWirelessDeviceRequest"}, "output":{"shape":"CreateWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Provisions a wireless device.

" }, "CreateWirelessGateway":{ "name":"CreateWirelessGateway", "http":{ "method":"POST", "requestUri":"/wireless-gateways", "responseCode":201 }, "input":{"shape":"CreateWirelessGatewayRequest"}, "output":{"shape":"CreateWirelessGatewayResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Provisions a wireless gateway.

" }, "CreateWirelessGatewayTask":{ "name":"CreateWirelessGatewayTask", "http":{ "method":"POST", "requestUri":"/wireless-gateways/{Id}/tasks", "responseCode":201 }, "input":{"shape":"CreateWirelessGatewayTaskRequest"}, "output":{"shape":"CreateWirelessGatewayTaskResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a task for a wireless gateway.

" }, "CreateWirelessGatewayTaskDefinition":{ "name":"CreateWirelessGatewayTaskDefinition", "http":{ "method":"POST", "requestUri":"/wireless-gateway-task-definitions", "responseCode":201 }, "input":{"shape":"CreateWirelessGatewayTaskDefinitionRequest"}, "output":{"shape":"CreateWirelessGatewayTaskDefinitionResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates a gateway task definition.

" }, "DeleteDestination":{ "name":"DeleteDestination", "http":{ "method":"DELETE", "requestUri":"/destinations/{Name}", "responseCode":204 }, "input":{"shape":"DeleteDestinationRequest"}, "output":{"shape":"DeleteDestinationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a destination.

" }, "DeleteDeviceProfile":{ "name":"DeleteDeviceProfile", "http":{ "method":"DELETE", "requestUri":"/device-profiles/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDeviceProfileRequest"}, "output":{"shape":"DeleteDeviceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a device profile.

" }, "DeleteServiceProfile":{ "name":"DeleteServiceProfile", "http":{ "method":"DELETE", "requestUri":"/service-profiles/{Id}", "responseCode":204 }, "input":{"shape":"DeleteServiceProfileRequest"}, "output":{"shape":"DeleteServiceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a service profile.

" }, "DeleteWirelessDevice":{ "name":"DeleteWirelessDevice", "http":{ "method":"DELETE", "requestUri":"/wireless-devices/{Id}", "responseCode":204 }, "input":{"shape":"DeleteWirelessDeviceRequest"}, "output":{"shape":"DeleteWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a wireless device.

" }, "DeleteWirelessGateway":{ "name":"DeleteWirelessGateway", "http":{ "method":"DELETE", "requestUri":"/wireless-gateways/{Id}", "responseCode":204 }, "input":{"shape":"DeleteWirelessGatewayRequest"}, "output":{"shape":"DeleteWirelessGatewayResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a wireless gateway.

" }, "DeleteWirelessGatewayTask":{ "name":"DeleteWirelessGatewayTask", "http":{ "method":"DELETE", "requestUri":"/wireless-gateways/{Id}/tasks", "responseCode":204 }, "input":{"shape":"DeleteWirelessGatewayTaskRequest"}, "output":{"shape":"DeleteWirelessGatewayTaskResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a wireless gateway task.

" }, "DeleteWirelessGatewayTaskDefinition":{ "name":"DeleteWirelessGatewayTaskDefinition", "http":{ "method":"DELETE", "requestUri":"/wireless-gateway-task-definitions/{Id}", "responseCode":204 }, "input":{"shape":"DeleteWirelessGatewayTaskDefinitionRequest"}, "output":{"shape":"DeleteWirelessGatewayTaskDefinitionResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

" }, "DisassociateAwsAccountFromPartnerAccount":{ "name":"DisassociateAwsAccountFromPartnerAccount", "http":{ "method":"DELETE", "requestUri":"/partner-accounts/{PartnerAccountId}", "responseCode":204 }, "input":{"shape":"DisassociateAwsAccountFromPartnerAccountRequest"}, "output":{"shape":"DisassociateAwsAccountFromPartnerAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

" }, "DisassociateWirelessDeviceFromThing":{ "name":"DisassociateWirelessDeviceFromThing", "http":{ "method":"DELETE", "requestUri":"/wireless-devices/{Id}/thing", "responseCode":204 }, "input":{"shape":"DisassociateWirelessDeviceFromThingRequest"}, "output":{"shape":"DisassociateWirelessDeviceFromThingResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Disassociates a wireless device from its currently associated thing.

" }, "DisassociateWirelessGatewayFromCertificate":{ "name":"DisassociateWirelessGatewayFromCertificate", "http":{ "method":"DELETE", "requestUri":"/wireless-gateways/{Id}/certificate", "responseCode":204 }, "input":{"shape":"DisassociateWirelessGatewayFromCertificateRequest"}, "output":{"shape":"DisassociateWirelessGatewayFromCertificateResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Disassociates a wireless gateway from its currently associated certificate.

" }, "DisassociateWirelessGatewayFromThing":{ "name":"DisassociateWirelessGatewayFromThing", "http":{ "method":"DELETE", "requestUri":"/wireless-gateways/{Id}/thing", "responseCode":204 }, "input":{"shape":"DisassociateWirelessGatewayFromThingRequest"}, "output":{"shape":"DisassociateWirelessGatewayFromThingResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Disassociates a wireless gateway from its currently associated thing.

" }, "GetDestination":{ "name":"GetDestination", "http":{ "method":"GET", "requestUri":"/destinations/{Name}" }, "input":{"shape":"GetDestinationRequest"}, "output":{"shape":"GetDestinationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a destination.

" }, "GetDeviceProfile":{ "name":"GetDeviceProfile", "http":{ "method":"GET", "requestUri":"/device-profiles/{Id}" }, "input":{"shape":"GetDeviceProfileRequest"}, "output":{"shape":"GetDeviceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a device profile.

" }, "GetPartnerAccount":{ "name":"GetPartnerAccount", "http":{ "method":"GET", "requestUri":"/partner-accounts/{PartnerAccountId}" }, "input":{"shape":"GetPartnerAccountRequest"}, "output":{"shape":"GetPartnerAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

" }, "GetServiceEndpoint":{ "name":"GetServiceEndpoint", "http":{ "method":"GET", "requestUri":"/service-endpoint" }, "input":{"shape":"GetServiceEndpointRequest"}, "output":{"shape":"GetServiceEndpointResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

" }, "GetServiceProfile":{ "name":"GetServiceProfile", "http":{ "method":"GET", "requestUri":"/service-profiles/{Id}" }, "input":{"shape":"GetServiceProfileRequest"}, "output":{"shape":"GetServiceProfileResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a service profile.

" }, "GetWirelessDevice":{ "name":"GetWirelessDevice", "http":{ "method":"GET", "requestUri":"/wireless-devices/{Identifier}" }, "input":{"shape":"GetWirelessDeviceRequest"}, "output":{"shape":"GetWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a wireless device.

" }, "GetWirelessDeviceStatistics":{ "name":"GetWirelessDeviceStatistics", "http":{ "method":"GET", "requestUri":"/wireless-devices/{Id}/statistics", "responseCode":200 }, "input":{"shape":"GetWirelessDeviceStatisticsRequest"}, "output":{"shape":"GetWirelessDeviceStatisticsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets operating information about a wireless device.

" }, "GetWirelessGateway":{ "name":"GetWirelessGateway", "http":{ "method":"GET", "requestUri":"/wireless-gateways/{Identifier}" }, "input":{"shape":"GetWirelessGatewayRequest"}, "output":{"shape":"GetWirelessGatewayResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a wireless gateway.

" }, "GetWirelessGatewayCertificate":{ "name":"GetWirelessGatewayCertificate", "http":{ "method":"GET", "requestUri":"/wireless-gateways/{Id}/certificate" }, "input":{"shape":"GetWirelessGatewayCertificateRequest"}, "output":{"shape":"GetWirelessGatewayCertificateResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets the ID of the certificate that is currently associated with a wireless gateway.

" }, "GetWirelessGatewayFirmwareInformation":{ "name":"GetWirelessGatewayFirmwareInformation", "http":{ "method":"GET", "requestUri":"/wireless-gateways/{Id}/firmware-information" }, "input":{"shape":"GetWirelessGatewayFirmwareInformationRequest"}, "output":{"shape":"GetWirelessGatewayFirmwareInformationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets the firmware version and other information about a wireless gateway.

" }, "GetWirelessGatewayStatistics":{ "name":"GetWirelessGatewayStatistics", "http":{ "method":"GET", "requestUri":"/wireless-gateways/{Id}/statistics", "responseCode":200 }, "input":{"shape":"GetWirelessGatewayStatisticsRequest"}, "output":{"shape":"GetWirelessGatewayStatisticsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets operating information about a wireless gateway.

" }, "GetWirelessGatewayTask":{ "name":"GetWirelessGatewayTask", "http":{ "method":"GET", "requestUri":"/wireless-gateways/{Id}/tasks" }, "input":{"shape":"GetWirelessGatewayTaskRequest"}, "output":{"shape":"GetWirelessGatewayTaskResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a wireless gateway task.

" }, "GetWirelessGatewayTaskDefinition":{ "name":"GetWirelessGatewayTaskDefinition", "http":{ "method":"GET", "requestUri":"/wireless-gateway-task-definitions/{Id}" }, "input":{"shape":"GetWirelessGatewayTaskDefinitionRequest"}, "output":{"shape":"GetWirelessGatewayTaskDefinitionResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Gets information about a wireless gateway task definition.

" }, "ListDestinations":{ "name":"ListDestinations", "http":{ "method":"GET", "requestUri":"/destinations" }, "input":{"shape":"ListDestinationsRequest"}, "output":{"shape":"ListDestinationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the destinations registered to your AWS account.

" }, "ListDeviceProfiles":{ "name":"ListDeviceProfiles", "http":{ "method":"GET", "requestUri":"/device-profiles" }, "input":{"shape":"ListDeviceProfilesRequest"}, "output":{"shape":"ListDeviceProfilesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the device profiles registered to your AWS account.

" }, "ListPartnerAccounts":{ "name":"ListPartnerAccounts", "http":{ "method":"GET", "requestUri":"/partner-accounts" }, "input":{"shape":"ListPartnerAccountsRequest"}, "output":{"shape":"ListPartnerAccountsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the partner accounts associated with your AWS account.

" }, "ListServiceProfiles":{ "name":"ListServiceProfiles", "http":{ "method":"GET", "requestUri":"/service-profiles" }, "input":{"shape":"ListServiceProfilesRequest"}, "output":{"shape":"ListServiceProfilesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the service profiles registered to your AWS account.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists the tags (metadata) you have assigned to the resource.

" }, "ListWirelessDevices":{ "name":"ListWirelessDevices", "http":{ "method":"GET", "requestUri":"/wireless-devices" }, "input":{"shape":"ListWirelessDevicesRequest"}, "output":{"shape":"ListWirelessDevicesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the wireless devices registered to your AWS account.

" }, "ListWirelessGatewayTaskDefinitions":{ "name":"ListWirelessGatewayTaskDefinitions", "http":{ "method":"GET", "requestUri":"/wireless-gateway-task-definitions" }, "input":{"shape":"ListWirelessGatewayTaskDefinitionsRequest"}, "output":{"shape":"ListWirelessGatewayTaskDefinitionsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the wireless gateway tasks definitions registered to your AWS account.

" }, "ListWirelessGateways":{ "name":"ListWirelessGateways", "http":{ "method":"GET", "requestUri":"/wireless-gateways" }, "input":{"shape":"ListWirelessGatewaysRequest"}, "output":{"shape":"ListWirelessGatewaysResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the wireless gateways registered to your AWS account.

" }, "SendDataToWirelessDevice":{ "name":"SendDataToWirelessDevice", "http":{ "method":"POST", "requestUri":"/wireless-devices/{Id}/data", "responseCode":202 }, "input":{"shape":"SendDataToWirelessDeviceRequest"}, "output":{"shape":"SendDataToWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Sends a decrypted application data frame to a device.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"TooManyTagsException"} ], "documentation":"

Adds a tag to a resource.

" }, "TestWirelessDevice":{ "name":"TestWirelessDevice", "http":{ "method":"POST", "requestUri":"/wireless-devices/{Id}/test", "responseCode":200 }, "input":{"shape":"TestWirelessDeviceRequest"}, "output":{"shape":"TestWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"

Simulates a provisioned device by sending an uplink data payload of Hello.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Removes one or more tags from a resource.

" }, "UpdateDestination":{ "name":"UpdateDestination", "http":{ "method":"PATCH", "requestUri":"/destinations/{Name}", "responseCode":204 }, "input":{"shape":"UpdateDestinationRequest"}, "output":{"shape":"UpdateDestinationResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates properties of a destination.

" }, "UpdatePartnerAccount":{ "name":"UpdatePartnerAccount", "http":{ "method":"PATCH", "requestUri":"/partner-accounts/{PartnerAccountId}", "responseCode":204 }, "input":{"shape":"UpdatePartnerAccountRequest"}, "output":{"shape":"UpdatePartnerAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates properties of a partner account.

" }, "UpdateWirelessDevice":{ "name":"UpdateWirelessDevice", "http":{ "method":"PATCH", "requestUri":"/wireless-devices/{Id}", "responseCode":204 }, "input":{"shape":"UpdateWirelessDeviceRequest"}, "output":{"shape":"UpdateWirelessDeviceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates properties of a wireless device.

" }, "UpdateWirelessGateway":{ "name":"UpdateWirelessGateway", "http":{ "method":"PATCH", "requestUri":"/wireless-gateways/{Id}", "responseCode":204 }, "input":{"shape":"UpdateWirelessGatewayRequest"}, "output":{"shape":"UpdateWirelessGatewayResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates properties of a wireless gateway.

" } }, "shapes":{ "AbpV1_0_x":{ "type":"structure", "members":{ "DevAddr":{ "shape":"DevAddr", "documentation":"

The DevAddr value.

" }, "SessionKeys":{ "shape":"SessionKeysAbpV1_0_x", "documentation":"

Session keys for ABP v1.0.x

" } }, "documentation":"

ABP device object for LoRaWAN specification v1.0.x

" }, "AbpV1_1":{ "type":"structure", "members":{ "DevAddr":{ "shape":"DevAddr", "documentation":"

The DevAddr value.

" }, "SessionKeys":{ "shape":"SessionKeysAbpV1_1", "documentation":"

Session keys for ABP v1.1

" } }, "documentation":"

ABP device object for LoRaWAN specification v1.1

" }, "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

User does not have permission to perform this action.

", "error":{"httpStatusCode":403}, "exception":true }, "AccountLinked":{"type":"boolean"}, "AddGwMetadata":{"type":"boolean"}, "AmazonId":{ "type":"string", "max":2048 }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "AppEui":{ "type":"string", "pattern":"[a-fA-F0-9]{16}" }, "AppKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "AppSKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "AppServerPrivateKey":{ "type":"string", "max":4096, "min":1, "pattern":"[a-fA-F0-9]{64}", "sensitive":true }, "AssociateAwsAccountWithPartnerAccountRequest":{ "type":"structure", "required":["Sidewalk"], "members":{ "Sidewalk":{ "shape":"SidewalkAccountInfo", "documentation":"

The Sidewalk account credentials.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

The tags attached to the specified resource. Tags are metadata that can be used to manage a resource

" } } }, "AssociateAwsAccountWithPartnerAccountResponse":{ "type":"structure", "members":{ "Sidewalk":{ "shape":"SidewalkAccountInfo", "documentation":"

The Sidewalk account credentials.

" }, "Arn":{ "shape":"PartnerAccountArn", "documentation":"

The Amazon Resource Name of the resource.

" } } }, "AssociateWirelessDeviceWithThingRequest":{ "type":"structure", "required":[ "Id", "ThingArn" ], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "ThingArn":{ "shape":"ThingArn", "documentation":"

The ARN of the thing to associate with the wireless device.

" } } }, "AssociateWirelessDeviceWithThingResponse":{ "type":"structure", "members":{ } }, "AssociateWirelessGatewayWithCertificateRequest":{ "type":"structure", "required":[ "Id", "IotCertificateId" ], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "IotCertificateId":{ "shape":"IotCertificateId", "documentation":"

The ID of the certificate to associate with the wireless gateway.

" } } }, "AssociateWirelessGatewayWithCertificateResponse":{ "type":"structure", "members":{ "IotCertificateId":{ "shape":"IotCertificateId", "documentation":"

The ID of the certificate associated with the wireless gateway.

" } } }, "AssociateWirelessGatewayWithThingRequest":{ "type":"structure", "required":[ "Id", "ThingArn" ], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "ThingArn":{ "shape":"ThingArn", "documentation":"

The ARN of the thing to associate with the wireless gateway.

" } } }, "AssociateWirelessGatewayWithThingResponse":{ "type":"structure", "members":{ } }, "AutoCreateTasks":{"type":"boolean"}, "CertificatePEM":{ "type":"string", "max":4096, "min":1, "pattern":"[^-A-Za-z0-9+/=]|=[^=]|={3,}${1,4096}" }, "ChannelMask":{ "type":"string", "max":2048 }, "ClassBTimeout":{ "type":"integer", "max":1000, "min":0 }, "ClassCTimeout":{ "type":"integer", "max":1000, "min":0 }, "ClientRequestToken":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9-_]+$" }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"Message"}, "ResourceId":{"shape":"ResourceId"}, "ResourceType":{"shape":"ResourceType"} }, "documentation":"

Adding, updating, or deleting the resource can cause an inconsistent state.

", "error":{"httpStatusCode":409}, "exception":true }, "Crc":{ "type":"long", "max":4294967295, "min":1 }, "CreateDestinationRequest":{ "type":"structure", "required":[ "Name", "ExpressionType", "Expression", "RoleArn" ], "members":{ "Name":{ "shape":"DestinationName", "documentation":"

The name of the new resource.

" }, "ExpressionType":{ "shape":"ExpressionType", "documentation":"

The type of value in Expression.

" }, "Expression":{ "shape":"Expression", "documentation":"

The rule name or topic rule to send messages to.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the new resource.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM Role that authorizes the destination.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to attach to the new destination. Tags are metadata that can be used to manage a resource.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true } } }, "CreateDestinationResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"DestinationArn", "documentation":"

The Amazon Resource Name of the new resource.

" }, "Name":{ "shape":"DestinationName", "documentation":"

The name of the new resource.

" } } }, "CreateDeviceProfileRequest":{ "type":"structure", "members":{ "Name":{ "shape":"DeviceProfileName", "documentation":"

The name of the new resource.

" }, "LoRaWAN":{ "shape":"LoRaWANDeviceProfile", "documentation":"

The device profile information to use to create the device profile.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to attach to the new device profile Tags are metadata that can be used to manage a resource.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true } } }, "CreateDeviceProfileResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"DeviceProfileArn", "documentation":"

The Amazon Resource Name of the new resource.

" }, "Id":{ "shape":"DeviceProfileId", "documentation":"

The ID of the new device profile.

" } } }, "CreateServiceProfileRequest":{ "type":"structure", "members":{ "Name":{ "shape":"ServiceProfileName", "documentation":"

The name of the new resource.

" }, "LoRaWAN":{ "shape":"LoRaWANServiceProfile", "documentation":"

The service profile information to use to create the service profile.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to attach to the new service profile. Tags are metadata that can be used to manage a resource.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true } } }, "CreateServiceProfileResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"ServiceProfileArn", "documentation":"

The Amazon Resource Name of the new resource.

" }, "Id":{ "shape":"ServiceProfileId", "documentation":"

The ID of the new service profile.

" } } }, "CreateWirelessDeviceRequest":{ "type":"structure", "required":[ "Type", "DestinationName" ], "members":{ "Type":{ "shape":"WirelessDeviceType", "documentation":"

The wireless device type.

" }, "Name":{ "shape":"WirelessDeviceName", "documentation":"

The name of the new resource.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the new resource.

" }, "DestinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination to assign to the new wireless device.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true }, "LoRaWAN":{ "shape":"LoRaWANDevice", "documentation":"

The device configuration information to use to create the wireless device.

" } } }, "CreateWirelessDeviceResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"WirelessDeviceArn", "documentation":"

The Amazon Resource Name of the new resource.

" }, "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the new wireless device.

" } } }, "CreateWirelessGatewayRequest":{ "type":"structure", "required":["LoRaWAN"], "members":{ "Name":{ "shape":"WirelessGatewayName", "documentation":"

The name of the new resource.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the new resource.

" }, "LoRaWAN":{ "shape":"LoRaWANGateway", "documentation":"

The gateway configuration information to use to create the wireless gateway.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to attach to the new wireless gateway. Tags are metadata that can be used to manage a resource.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true } } }, "CreateWirelessGatewayResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"WirelessGatewayArn", "documentation":"

The Amazon Resource Name of the new resource.

" }, "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the new wireless gateway.

" } } }, "CreateWirelessGatewayTaskDefinitionRequest":{ "type":"structure", "required":["AutoCreateTasks"], "members":{ "AutoCreateTasks":{ "shape":"AutoCreateTasks", "documentation":"

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

" }, "Name":{ "shape":"WirelessGatewayTaskName", "documentation":"

The name of the new resource.

" }, "Update":{ "shape":"UpdateWirelessGatewayTaskCreate", "documentation":"

Information about the gateways to update.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "idempotencyToken":true }, "Tags":{ "shape":"TagList", "documentation":"

The tags attached to the specified resource. Tags are metadata that can be used to manage a resource

" } } }, "CreateWirelessGatewayTaskDefinitionResponse":{ "type":"structure", "members":{ "Id":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the new wireless gateway task definition.

" }, "Arn":{ "shape":"WirelessGatewayTaskDefinitionArn", "documentation":"

The Amazon Resource Name of the resource.

" } } }, "CreateWirelessGatewayTaskRequest":{ "type":"structure", "required":[ "Id", "WirelessGatewayTaskDefinitionId" ], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "WirelessGatewayTaskDefinitionId":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the WirelessGatewayTaskDefinition.

" } } }, "CreateWirelessGatewayTaskResponse":{ "type":"structure", "members":{ "WirelessGatewayTaskDefinitionId":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the WirelessGatewayTaskDefinition.

" }, "Status":{ "shape":"WirelessGatewayTaskStatus", "documentation":"

The status of the request.

" } } }, "DeleteDestinationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DestinationName", "documentation":"

The name of the resource to delete.

", "location":"uri", "locationName":"Name" } } }, "DeleteDestinationResponse":{ "type":"structure", "members":{ } }, "DeleteDeviceProfileRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"DeviceProfileId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteDeviceProfileResponse":{ "type":"structure", "members":{ } }, "DeleteServiceProfileRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ServiceProfileId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteServiceProfileResponse":{ "type":"structure", "members":{ } }, "DeleteWirelessDeviceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteWirelessDeviceResponse":{ "type":"structure", "members":{ } }, "DeleteWirelessGatewayRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteWirelessGatewayResponse":{ "type":"structure", "members":{ } }, "DeleteWirelessGatewayTaskDefinitionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteWirelessGatewayTaskDefinitionResponse":{ "type":"structure", "members":{ } }, "DeleteWirelessGatewayTaskRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to delete.

", "location":"uri", "locationName":"Id" } } }, "DeleteWirelessGatewayTaskResponse":{ "type":"structure", "members":{ } }, "Description":{ "type":"string", "max":2048 }, "DestinationArn":{"type":"string"}, "DestinationList":{ "type":"list", "member":{"shape":"Destinations"} }, "DestinationName":{ "type":"string", "max":128, "pattern":"[a-zA-Z0-9-_]+" }, "Destinations":{ "type":"structure", "members":{ "Arn":{ "shape":"DestinationArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"DestinationName", "documentation":"

The name of the resource.

" }, "ExpressionType":{ "shape":"ExpressionType", "documentation":"

The type of value in Expression.

" }, "Expression":{ "shape":"Expression", "documentation":"

The rule name or topic rule to send messages to.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the resource.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM Role that authorizes the destination.

" } }, "documentation":"

Describes a destination.

" }, "DevAddr":{ "type":"string", "pattern":"[a-fA-F0-9]{8}" }, "DevEui":{ "type":"string", "pattern":"[a-fA-F0-9]{16}" }, "DevStatusReqFreq":{ "type":"integer", "max":2147483647, "min":0 }, "DeviceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"DeviceProfileArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"DeviceProfileName", "documentation":"

The name of the resource.

" }, "Id":{ "shape":"DeviceProfileId", "documentation":"

The ID of the device profile.

" } }, "documentation":"

Describes a device profile.

" }, "DeviceProfileArn":{"type":"string"}, "DeviceProfileId":{ "type":"string", "max":256 }, "DeviceProfileList":{ "type":"list", "member":{"shape":"DeviceProfile"} }, "DeviceProfileName":{ "type":"string", "max":256 }, "DisassociateAwsAccountFromPartnerAccountRequest":{ "type":"structure", "required":[ "PartnerAccountId", "PartnerType" ], "members":{ "PartnerAccountId":{ "shape":"PartnerAccountId", "documentation":"

The partner account ID to disassociate from the AWS account.

", "location":"uri", "locationName":"PartnerAccountId" }, "PartnerType":{ "shape":"PartnerType", "documentation":"

The partner type.

", "location":"querystring", "locationName":"partnerType" } } }, "DisassociateAwsAccountFromPartnerAccountResponse":{ "type":"structure", "members":{ } }, "DisassociateWirelessDeviceFromThingRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" } } }, "DisassociateWirelessDeviceFromThingResponse":{ "type":"structure", "members":{ } }, "DisassociateWirelessGatewayFromCertificateRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" } } }, "DisassociateWirelessGatewayFromCertificateResponse":{ "type":"structure", "members":{ } }, "DisassociateWirelessGatewayFromThingRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" } } }, "DisassociateWirelessGatewayFromThingResponse":{ "type":"structure", "members":{ } }, "DlBucketSize":{ "type":"integer", "max":2147483647, "min":0 }, "DlRate":{ "type":"integer", "max":2147483647, "min":0 }, "DlRatePolicy":{ "type":"string", "max":256 }, "Double":{"type":"double"}, "DrMax":{ "type":"integer", "max":15, "min":0 }, "DrMin":{ "type":"integer", "max":15, "min":0 }, "EndPoint":{ "type":"string", "max":256, "min":1 }, "Expression":{ "type":"string", "max":2048 }, "ExpressionType":{ "type":"string", "enum":[ "RuleName", "MqttTopic" ] }, "FNwkSIntKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "FPort":{ "type":"integer", "max":223, "min":1 }, "FactoryPresetFreqsList":{ "type":"list", "member":{"shape":"PresetFreq"}, "max":20, "min":0 }, "Fingerprint":{ "type":"string", "max":64, "min":64, "pattern":"[a-fA-F0-9]{64}", "sensitive":true }, "GatewayEui":{ "type":"string", "pattern":"^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$" }, "GetDestinationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DestinationName", "documentation":"

The name of the resource to get.

", "location":"uri", "locationName":"Name" } } }, "GetDestinationResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"DestinationArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"DestinationName", "documentation":"

The name of the resource.

" }, "Expression":{ "shape":"Expression", "documentation":"

The rule name or topic rule to send messages to.

" }, "ExpressionType":{ "shape":"ExpressionType", "documentation":"

The type of value in Expression.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the resource.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM Role that authorizes the destination.

" } } }, "GetDeviceProfileRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"DeviceProfileId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetDeviceProfileResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"DeviceProfileArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"DeviceProfileName", "documentation":"

The name of the resource.

" }, "Id":{ "shape":"DeviceProfileId", "documentation":"

The ID of the device profile.

" }, "LoRaWAN":{ "shape":"LoRaWANDeviceProfile", "documentation":"

Information about the device profile.

" } } }, "GetPartnerAccountRequest":{ "type":"structure", "required":[ "PartnerAccountId", "PartnerType" ], "members":{ "PartnerAccountId":{ "shape":"PartnerAccountId", "documentation":"

The partner account ID to disassociate from the AWS account.

", "location":"uri", "locationName":"PartnerAccountId" }, "PartnerType":{ "shape":"PartnerType", "documentation":"

The partner type.

", "location":"querystring", "locationName":"partnerType" } } }, "GetPartnerAccountResponse":{ "type":"structure", "members":{ "Sidewalk":{ "shape":"SidewalkAccountInfoWithFingerprint", "documentation":"

The Sidewalk account credentials.

" }, "AccountLinked":{ "shape":"AccountLinked", "documentation":"

Whether the partner account is linked to the AWS account.

" } } }, "GetServiceEndpointRequest":{ "type":"structure", "members":{ "ServiceType":{ "shape":"WirelessGatewayServiceType", "documentation":"

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint.

", "location":"querystring", "locationName":"serviceType" } } }, "GetServiceEndpointResponse":{ "type":"structure", "members":{ "ServiceType":{ "shape":"WirelessGatewayServiceType", "documentation":"

The endpoint's service type.

" }, "ServiceEndpoint":{ "shape":"EndPoint", "documentation":"

The service endpoint value.

" }, "ServerTrust":{ "shape":"CertificatePEM", "documentation":"

The Root CA of the server trust certificate.

" } } }, "GetServiceProfileRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ServiceProfileId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetServiceProfileResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"ServiceProfileArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"ServiceProfileName", "documentation":"

The name of the resource.

" }, "Id":{ "shape":"ServiceProfileId", "documentation":"

The ID of the service profile.

" }, "LoRaWAN":{ "shape":"LoRaWANGetServiceProfileInfo", "documentation":"

Information about the service profile.

" } } }, "GetWirelessDeviceRequest":{ "type":"structure", "required":[ "Identifier", "IdentifierType" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"

The identifier of the wireless device to get.

", "location":"uri", "locationName":"Identifier" }, "IdentifierType":{ "shape":"WirelessDeviceIdType", "documentation":"

The type of identifier used in identifier.

", "location":"querystring", "locationName":"identifierType" } } }, "GetWirelessDeviceResponse":{ "type":"structure", "members":{ "Type":{ "shape":"WirelessDeviceType", "documentation":"

The wireless device type.

" }, "Name":{ "shape":"WirelessDeviceName", "documentation":"

The name of the resource.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the resource.

" }, "DestinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination to which the device is assigned.

" }, "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device.

" }, "Arn":{ "shape":"WirelessDeviceArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "ThingName":{ "shape":"ThingName", "documentation":"

The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.

" }, "ThingArn":{ "shape":"ThingArn", "documentation":"

The ARN of the thing associated with the wireless device.

" }, "LoRaWAN":{ "shape":"LoRaWANDevice", "documentation":"

Information about the wireless device.

" } } }, "GetWirelessDeviceStatisticsRequest":{ "type":"structure", "required":["WirelessDeviceId"], "members":{ "WirelessDeviceId":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device for which to get the data.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessDeviceStatisticsResponse":{ "type":"structure", "members":{ "WirelessDeviceId":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device.

" }, "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the most recent uplink was received.

" }, "LoRaWAN":{ "shape":"LoRaWANDeviceMetadata", "documentation":"

Information about the wireless device's operations.

" } } }, "GetWirelessGatewayCertificateRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessGatewayCertificateResponse":{ "type":"structure", "members":{ "IotCertificateId":{ "shape":"IotCertificateId", "documentation":"

The ID of the certificate associated with the wireless gateway.

" }, "LoRaWANNetworkServerCertificateId":{ "shape":"IotCertificateId", "documentation":"

The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.

" } } }, "GetWirelessGatewayFirmwareInformationRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessGatewayFirmwareInformationResponse":{ "type":"structure", "members":{ "LoRaWAN":{ "shape":"LoRaWANGatewayCurrentVersion", "documentation":"

Information about the wireless gateway's firmware.

" } } }, "GetWirelessGatewayRequest":{ "type":"structure", "required":[ "Identifier", "IdentifierType" ], "members":{ "Identifier":{ "shape":"Identifier", "documentation":"

The identifier of the wireless gateway to get.

", "location":"uri", "locationName":"Identifier" }, "IdentifierType":{ "shape":"WirelessGatewayIdType", "documentation":"

The type of identifier used in identifier.

", "location":"querystring", "locationName":"identifierType" } } }, "GetWirelessGatewayResponse":{ "type":"structure", "members":{ "Name":{ "shape":"WirelessGatewayName", "documentation":"

The name of the resource.

" }, "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the wireless gateway.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the resource.

" }, "LoRaWAN":{ "shape":"LoRaWANGateway", "documentation":"

Information about the wireless gateway.

" }, "Arn":{ "shape":"WirelessGatewayArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "ThingName":{ "shape":"ThingName", "documentation":"

The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.

" }, "ThingArn":{ "shape":"ThingArn", "documentation":"

The ARN of the thing associated with the wireless gateway.

" } } }, "GetWirelessGatewayStatisticsRequest":{ "type":"structure", "required":["WirelessGatewayId"], "members":{ "WirelessGatewayId":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the wireless gateway for which to get the data.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessGatewayStatisticsResponse":{ "type":"structure", "members":{ "WirelessGatewayId":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the wireless gateway.

" }, "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the most recent uplink was received.

" } } }, "GetWirelessGatewayTaskDefinitionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessGatewayTaskDefinitionResponse":{ "type":"structure", "members":{ "AutoCreateTasks":{ "shape":"AutoCreateTasks", "documentation":"

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

" }, "Name":{ "shape":"WirelessGatewayTaskName", "documentation":"

The name of the resource.

" }, "Update":{ "shape":"UpdateWirelessGatewayTaskCreate", "documentation":"

Information about the gateways to update.

" }, "Arn":{ "shape":"WirelessGatewayTaskDefinitionArn", "documentation":"

The Amazon Resource Name of the resource.

" } } }, "GetWirelessGatewayTaskRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to get.

", "location":"uri", "locationName":"Id" } } }, "GetWirelessGatewayTaskResponse":{ "type":"structure", "members":{ "WirelessGatewayId":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the wireless gateway.

" }, "WirelessGatewayTaskDefinitionId":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the WirelessGatewayTask.

" }, "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the most recent uplink was received.

" }, "TaskCreatedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the task was created.

" }, "Status":{ "shape":"WirelessGatewayTaskStatus", "documentation":"

The status of the request.

" } } }, "HrAllowed":{"type":"boolean"}, "ISODateTimeString":{ "type":"string", "pattern":"^([\\+-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d+(?!:))?)?(\\17[0-5]\\d([\\.,]\\d+)?)?([zZ]|([\\+-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" }, "Identifier":{ "type":"string", "max":256 }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

An unexpected error occurred while processing a request.

", "error":{"httpStatusCode":500}, "exception":true }, "IotCertificateId":{ "type":"string", "max":4096, "min":1 }, "JoinEui":{ "type":"string", "pattern":"[a-fA-F0-9]{16}" }, "ListDestinationsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" } } }, "ListDestinationsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "DestinationList":{ "shape":"DestinationList", "documentation":"

The list of destinations.

" } } }, "ListDeviceProfilesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" } } }, "ListDeviceProfilesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "DeviceProfileList":{ "shape":"DeviceProfileList", "documentation":"

The list of device profiles.

" } } }, "ListPartnerAccountsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" } } }, "ListPartnerAccountsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "Sidewalk":{ "shape":"SidewalkAccountList", "documentation":"

The Sidewalk account credentials.

" } } }, "ListServiceProfilesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" } } }, "ListServiceProfilesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "ServiceProfileList":{ "shape":"ServiceProfileList", "documentation":"

The list of service profiles.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the resource for which to list tags.

", "location":"querystring", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The tags attached to the specified resource. Tags are metadata that can be used to manage a resource

" } } }, "ListWirelessDevicesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "DestinationName":{ "shape":"DestinationName", "documentation":"

A filter to list only the wireless devices that use this destination.

", "location":"querystring", "locationName":"destinationName" }, "DeviceProfileId":{ "shape":"DeviceProfileId", "documentation":"

A filter to list only the wireless devices that use this device profile.

", "location":"querystring", "locationName":"deviceProfileId" }, "ServiceProfileId":{ "shape":"ServiceProfileId", "documentation":"

A filter to list only the wireless devices that use this service profile.

", "location":"querystring", "locationName":"serviceProfileId" }, "WirelessDeviceType":{ "shape":"WirelessDeviceType", "documentation":"

A filter to list only the wireless devices that use this wireless device type.

", "location":"querystring", "locationName":"wirelessDeviceType" } } }, "ListWirelessDevicesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "WirelessDeviceList":{ "shape":"WirelessDeviceStatisticsList", "documentation":"

The ID of the wireless device.

" } } }, "ListWirelessGatewayTaskDefinitionsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "TaskDefinitionType":{ "shape":"WirelessGatewayTaskDefinitionType", "documentation":"

A filter to list only the wireless gateway task definitions that use this task definition type.

", "location":"querystring", "locationName":"taskDefinitionType" } } }, "ListWirelessGatewayTaskDefinitionsResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "TaskDefinitions":{ "shape":"WirelessGatewayTaskDefinitionList", "documentation":"

The list of task definitions.

" } } }, "ListWirelessGatewaysRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "location":"querystring", "locationName":"nextToken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return in this operation.

", "location":"querystring", "locationName":"maxResults" } } }, "ListWirelessGatewaysResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next set of results, or null if there are no additional results.

" }, "WirelessGatewayList":{ "shape":"WirelessGatewayStatisticsList", "documentation":"

The ID of the wireless gateway.

" } } }, "LoRaWANDevice":{ "type":"structure", "members":{ "DevEui":{ "shape":"DevEui", "documentation":"

The DevEUI value.

" }, "DeviceProfileId":{ "shape":"DeviceProfileId", "documentation":"

The ID of the device profile for the new wireless device.

" }, "ServiceProfileId":{ "shape":"ServiceProfileId", "documentation":"

The ID of the service profile.

" }, "OtaaV1_1":{ "shape":"OtaaV1_1", "documentation":"

OTAA device object for v1.1 for create APIs

" }, "OtaaV1_0_x":{ "shape":"OtaaV1_0_x", "documentation":"

OTAA device object for create APIs for v1.0.x

" }, "AbpV1_1":{ "shape":"AbpV1_1", "documentation":"

ABP device object for create APIs for v1.1

" }, "AbpV1_0_x":{ "shape":"AbpV1_0_x", "documentation":"

LoRaWAN object for create APIs

" } }, "documentation":"

LoRaWAN object for create functions.

" }, "LoRaWANDeviceMetadata":{ "type":"structure", "members":{ "DevEui":{ "shape":"DevEui", "documentation":"

The DevEUI value.

" }, "FPort":{ "shape":"Integer", "documentation":"

The FPort value.

" }, "DataRate":{ "shape":"Integer", "documentation":"

The DataRate value.

" }, "Frequency":{ "shape":"Integer", "documentation":"

The device's channel frequency in Hz.

" }, "Timestamp":{ "shape":"ISODateTimeString", "documentation":"

The date and time of the metadata.

" }, "Gateways":{ "shape":"LoRaWANGatewayMetadataList", "documentation":"

Information about the gateways accessed by the device.

" } }, "documentation":"

LoRaWAN device metatdata.

" }, "LoRaWANDeviceProfile":{ "type":"structure", "members":{ "SupportsClassB":{ "shape":"SupportsClassB", "documentation":"

The SupportsClassB value.

" }, "ClassBTimeout":{ "shape":"ClassBTimeout", "documentation":"

The ClassBTimeout value.

" }, "PingSlotPeriod":{ "shape":"PingSlotPeriod", "documentation":"

The PingSlotPeriod value.

" }, "PingSlotDr":{ "shape":"PingSlotDr", "documentation":"

The PingSlotDR value.

" }, "PingSlotFreq":{ "shape":"PingSlotFreq", "documentation":"

The PingSlotFreq value.

" }, "SupportsClassC":{ "shape":"SupportsClassC", "documentation":"

The SupportsClassC value.

" }, "ClassCTimeout":{ "shape":"ClassCTimeout", "documentation":"

The ClassCTimeout value.

" }, "MacVersion":{ "shape":"MacVersion", "documentation":"

The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

" }, "RegParamsRevision":{ "shape":"RegParamsRevision", "documentation":"

The version of regional parameters.

" }, "RxDelay1":{ "shape":"RxDelay1", "documentation":"

The RXDelay1 value.

" }, "RxDrOffset1":{ "shape":"RxDrOffset1", "documentation":"

The RXDROffset1 value.

" }, "RxDataRate2":{ "shape":"RxDataRate2", "documentation":"

The RXDataRate2 value.

" }, "RxFreq2":{ "shape":"RxFreq2", "documentation":"

The RXFreq2 value.

" }, "FactoryPresetFreqsList":{ "shape":"FactoryPresetFreqsList", "documentation":"

The list of values that make up the FactoryPresetFreqs value.

" }, "MaxEirp":{ "shape":"MaxEirp", "documentation":"

The MaxEIRP value.

" }, "MaxDutyCycle":{ "shape":"MaxDutyCycle", "documentation":"

The MaxDutyCycle value.

" }, "RfRegion":{ "shape":"RfRegion", "documentation":"

The frequency band (RFRegion) value.

" }, "SupportsJoin":{ "shape":"SupportsJoin", "documentation":"

The SupportsJoin value.

" }, "Supports32BitFCnt":{ "shape":"Supports32BitFCnt", "documentation":"

The Supports32BitFCnt value.

" } }, "documentation":"

LoRaWANDeviceProfile object.

" }, "LoRaWANGateway":{ "type":"structure", "members":{ "GatewayEui":{ "shape":"GatewayEui", "documentation":"

The gateway's EUI value.

" }, "RfRegion":{ "shape":"RfRegion", "documentation":"

The frequency band (RFRegion) value.

" } }, "documentation":"

LoRaWANGateway object.

" }, "LoRaWANGatewayCurrentVersion":{ "type":"structure", "members":{ "CurrentVersion":{ "shape":"LoRaWANGatewayVersion", "documentation":"

The version of the gateways that should receive the update.

" } }, "documentation":"

LoRaWANGatewayCurrentVersion object.

" }, "LoRaWANGatewayMetadata":{ "type":"structure", "members":{ "GatewayEui":{ "shape":"GatewayEui", "documentation":"

The gateway's EUI value.

" }, "Snr":{ "shape":"Double", "documentation":"

The SNR value.

" }, "Rssi":{ "shape":"Double", "documentation":"

The RSSI value.

" } }, "documentation":"

LoRaWAN gateway metatdata.

" }, "LoRaWANGatewayMetadataList":{ "type":"list", "member":{"shape":"LoRaWANGatewayMetadata"} }, "LoRaWANGatewayVersion":{ "type":"structure", "members":{ "PackageVersion":{ "shape":"PackageVersion", "documentation":"

The version of the wireless gateway firmware.

" }, "Model":{ "shape":"Model", "documentation":"

The model number of the wireless gateway.

" }, "Station":{ "shape":"Station", "documentation":"

The basic station version of the wireless gateway.

" } }, "documentation":"

LoRaWANGatewayVersion object.

" }, "LoRaWANGetServiceProfileInfo":{ "type":"structure", "members":{ "UlRate":{ "shape":"UlRate", "documentation":"

The ULRate value.

" }, "UlBucketSize":{ "shape":"UlBucketSize", "documentation":"

The ULBucketSize value.

" }, "UlRatePolicy":{ "shape":"UlRatePolicy", "documentation":"

The ULRatePolicy value.

" }, "DlRate":{ "shape":"DlRate", "documentation":"

The DLRate value.

" }, "DlBucketSize":{ "shape":"DlBucketSize", "documentation":"

The DLBucketSize value.

" }, "DlRatePolicy":{ "shape":"DlRatePolicy", "documentation":"

The DLRatePolicy value.

" }, "AddGwMetadata":{ "shape":"AddGwMetadata", "documentation":"

The AddGWMetaData value.

" }, "DevStatusReqFreq":{ "shape":"DevStatusReqFreq", "documentation":"

The DevStatusReqFreq value.

" }, "ReportDevStatusBattery":{ "shape":"ReportDevStatusBattery", "documentation":"

The ReportDevStatusBattery value.

" }, "ReportDevStatusMargin":{ "shape":"ReportDevStatusMargin", "documentation":"

The ReportDevStatusMargin value.

" }, "DrMin":{ "shape":"DrMin", "documentation":"

The DRMin value.

" }, "DrMax":{ "shape":"DrMax", "documentation":"

The DRMax value.

" }, "ChannelMask":{ "shape":"ChannelMask", "documentation":"

The ChannelMask value.

" }, "PrAllowed":{ "shape":"PrAllowed", "documentation":"

The PRAllowed value that describes whether passive roaming is allowed.

" }, "HrAllowed":{ "shape":"HrAllowed", "documentation":"

The HRAllowed value that describes whether handover roaming is allowed.

" }, "RaAllowed":{ "shape":"RaAllowed", "documentation":"

The RAAllowed value that describes whether roaming activation is allowed.

" }, "NwkGeoLoc":{ "shape":"NwkGeoLoc", "documentation":"

The NwkGeoLoc value.

" }, "TargetPer":{ "shape":"TargetPer", "documentation":"

The TargetPER value.

" }, "MinGwDiversity":{ "shape":"MinGwDiversity", "documentation":"

The MinGwDiversity value.

" } }, "documentation":"

LoRaWANGetServiceProfileInfo object.

" }, "LoRaWANListDevice":{ "type":"structure", "members":{ "DevEui":{ "shape":"DevEui", "documentation":"

The DevEUI value.

" } }, "documentation":"

LoRaWAN object for list functions.

" }, "LoRaWANSendDataToDevice":{ "type":"structure", "members":{ "FPort":{ "shape":"FPort", "documentation":"

The Fport value.

" } }, "documentation":"

LoRaWAN router info.

" }, "LoRaWANServiceProfile":{ "type":"structure", "members":{ "AddGwMetadata":{ "shape":"AddGwMetadata", "documentation":"

The AddGWMetaData value.

" } }, "documentation":"

LoRaWANServiceProfile object.

" }, "LoRaWANUpdateDevice":{ "type":"structure", "members":{ "DeviceProfileId":{ "shape":"DeviceProfileId", "documentation":"

The ID of the device profile for the wireless device.

" }, "ServiceProfileId":{ "shape":"ServiceProfileId", "documentation":"

The ID of the service profile.

" } }, "documentation":"

LoRaWAN object for update functions.

" }, "LoRaWANUpdateGatewayTaskCreate":{ "type":"structure", "members":{ "UpdateSignature":{ "shape":"UpdateSignature", "documentation":"

The signature used to verify the update firmware.

" }, "SigKeyCrc":{ "shape":"Crc", "documentation":"

The CRC of the signature private key to check.

" }, "CurrentVersion":{ "shape":"LoRaWANGatewayVersion", "documentation":"

The version of the gateways that should receive the update.

" }, "UpdateVersion":{ "shape":"LoRaWANGatewayVersion", "documentation":"

The firmware version to update the gateway to.

" } }, "documentation":"

LoRaWANUpdateGatewayTaskCreate object.

" }, "LoRaWANUpdateGatewayTaskEntry":{ "type":"structure", "members":{ "CurrentVersion":{ "shape":"LoRaWANGatewayVersion", "documentation":"

The version of the gateways that should receive the update.

" }, "UpdateVersion":{ "shape":"LoRaWANGatewayVersion", "documentation":"

The firmware version to update the gateway to.

" } }, "documentation":"

LoRaWANUpdateGatewayTaskEntry object.

" }, "MacVersion":{ "type":"string", "max":64 }, "MaxDutyCycle":{ "type":"integer", "max":100, "min":0 }, "MaxEirp":{ "type":"integer", "max":15, "min":0 }, "MaxResults":{ "type":"integer", "max":250, "min":0 }, "Message":{ "type":"string", "max":2048 }, "MessageId":{"type":"string"}, "MinGwDiversity":{ "type":"integer", "max":100, "min":1 }, "Model":{ "type":"string", "max":4096, "min":1 }, "NextToken":{ "type":"string", "max":4096 }, "NwkGeoLoc":{"type":"boolean"}, "NwkKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "NwkSEncKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "NwkSKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "OtaaV1_0_x":{ "type":"structure", "members":{ "AppKey":{ "shape":"AppKey", "documentation":"

The AppKey value.

" }, "AppEui":{ "shape":"AppEui", "documentation":"

The AppEUI value.

" } }, "documentation":"

OTAA device object for v1.0.x

" }, "OtaaV1_1":{ "type":"structure", "members":{ "AppKey":{ "shape":"AppKey", "documentation":"

The AppKey value.

" }, "NwkKey":{ "shape":"NwkKey", "documentation":"

The NwkKey value.

" }, "JoinEui":{ "shape":"JoinEui", "documentation":"

The JoinEUI value.

" } }, "documentation":"

OTAA device object for v1.1

" }, "PackageVersion":{ "type":"string", "max":32, "min":1 }, "PartnerAccountArn":{"type":"string"}, "PartnerAccountId":{ "type":"string", "max":256 }, "PartnerType":{ "type":"string", "enum":["Sidewalk"] }, "PayloadData":{ "type":"string", "max":2048, "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" }, "PingSlotDr":{ "type":"integer", "max":15, "min":0 }, "PingSlotFreq":{ "type":"integer", "max":16700000, "min":1000000 }, "PingSlotPeriod":{ "type":"integer", "max":4096, "min":128 }, "PrAllowed":{"type":"boolean"}, "PresetFreq":{ "type":"integer", "max":16700000, "min":1000000 }, "RaAllowed":{"type":"boolean"}, "RegParamsRevision":{ "type":"string", "max":64 }, "ReportDevStatusBattery":{"type":"boolean"}, "ReportDevStatusMargin":{"type":"boolean"}, "ResourceId":{"type":"string"}, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"Message"}, "ResourceId":{"shape":"ResourceId"}, "ResourceType":{"shape":"ResourceType"} }, "documentation":"

Resource does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "ResourceType":{"type":"string"}, "Result":{ "type":"string", "max":2048 }, "RfRegion":{ "type":"string", "max":64 }, "RoleArn":{ "type":"string", "max":2048, "min":20 }, "RxDataRate2":{ "type":"integer", "max":15, "min":0 }, "RxDelay1":{ "type":"integer", "max":15, "min":0 }, "RxDrOffset1":{ "type":"integer", "max":7, "min":0 }, "RxFreq2":{ "type":"integer", "max":16700000, "min":1000000 }, "SNwkSIntKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" }, "SendDataToWirelessDeviceRequest":{ "type":"structure", "required":[ "Id", "TransmitMode", "PayloadData" ], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device to receive the data.

", "location":"uri", "locationName":"Id" }, "TransmitMode":{ "shape":"TransmitMode", "documentation":"

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

" }, "PayloadData":{ "shape":"PayloadData", "documentation":"

The message payload to send.

" }, "WirelessMetadata":{ "shape":"WirelessMetadata", "documentation":"

Metadata about the message request.

" } } }, "SendDataToWirelessDeviceResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"MessageId", "documentation":"

The ID of the message sent to the wireless device.

" } } }, "Seq":{ "type":"integer", "max":16383, "min":0 }, "ServiceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"ServiceProfileArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Name":{ "shape":"ServiceProfileName", "documentation":"

The name of the resource.

" }, "Id":{ "shape":"ServiceProfileId", "documentation":"

The ID of the service profile.

" } }, "documentation":"

Information about a service profile.

" }, "ServiceProfileArn":{"type":"string"}, "ServiceProfileId":{ "type":"string", "max":256 }, "ServiceProfileList":{ "type":"list", "member":{"shape":"ServiceProfile"} }, "ServiceProfileName":{ "type":"string", "max":256 }, "SessionKeysAbpV1_0_x":{ "type":"structure", "members":{ "NwkSKey":{ "shape":"NwkSKey", "documentation":"

The NwkSKey value.

" }, "AppSKey":{ "shape":"AppSKey", "documentation":"

The AppSKey value.

" } }, "documentation":"

Session keys for ABP v1.1

" }, "SessionKeysAbpV1_1":{ "type":"structure", "members":{ "FNwkSIntKey":{ "shape":"FNwkSIntKey", "documentation":"

The FNwkSIntKey value.

" }, "SNwkSIntKey":{ "shape":"SNwkSIntKey", "documentation":"

The SNwkSIntKey value.

" }, "NwkSEncKey":{ "shape":"NwkSEncKey", "documentation":"

The NwkSEncKey value.

" }, "AppSKey":{ "shape":"AppSKey", "documentation":"

The AppSKey value.

" } }, "documentation":"

Session keys for ABP v1.1

" }, "SidewalkAccountInfo":{ "type":"structure", "members":{ "AmazonId":{ "shape":"AmazonId", "documentation":"

The Sidewalk Amazon ID.

" }, "AppServerPrivateKey":{ "shape":"AppServerPrivateKey", "documentation":"

The Sidewalk application server private key.

" } }, "documentation":"

Information about a Sidewalk account.

" }, "SidewalkAccountInfoWithFingerprint":{ "type":"structure", "members":{ "AmazonId":{ "shape":"AmazonId", "documentation":"

The Sidewalk Amazon ID.

" }, "Fingerprint":{ "shape":"Fingerprint", "documentation":"

The fingerprint of the Sidewalk application server private key.

" }, "Arn":{ "shape":"PartnerAccountArn", "documentation":"

The Amazon Resource Name of the resource.

" } }, "documentation":"

Information about a Sidewalk account.

" }, "SidewalkAccountList":{ "type":"list", "member":{"shape":"SidewalkAccountInfoWithFingerprint"} }, "SidewalkListDevice":{ "type":"structure", "members":{ "AmazonId":{ "shape":"AmazonId", "documentation":"

The Sidewalk Amazon ID.

" } }, "documentation":"

Sidewalk object used by list functions.

" }, "SidewalkSendDataToDevice":{ "type":"structure", "members":{ "Seq":{ "shape":"Seq", "documentation":"

The sequence number.

" } }, "documentation":"

Information about a Sidewalk router.

" }, "SidewalkUpdateAccount":{ "type":"structure", "members":{ "AppServerPrivateKey":{ "shape":"AppServerPrivateKey", "documentation":"

The new Sidewalk application server private key.

" } }, "documentation":"

Sidewalk update.

" }, "Station":{ "type":"string", "max":4096, "min":1 }, "Supports32BitFCnt":{"type":"boolean"}, "SupportsClassB":{"type":"boolean"}, "SupportsClassC":{"type":"boolean"}, "SupportsJoin":{"type":"boolean"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The tag's key value.

" }, "Value":{ "shape":"TagValue", "documentation":"

The tag's value.

" } }, "documentation":"

A simple label consisting of a customer-defined key-value pair

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the resource to add tags to.

", "location":"querystring", "locationName":"resourceArn" }, "Tags":{ "shape":"TagList", "documentation":"

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TargetPer":{ "type":"integer", "max":100, "min":0 }, "TestWirelessDeviceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device to test.

", "location":"uri", "locationName":"Id" } } }, "TestWirelessDeviceResponse":{ "type":"structure", "members":{ "Result":{ "shape":"Result", "documentation":"

The result returned by the test.

" } } }, "ThingArn":{"type":"string"}, "ThingName":{"type":"string"}, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The request was denied because it exceeded the allowed API request rate.

", "error":{"httpStatusCode":429}, "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ "Message":{"shape":"Message"}, "ResourceName":{"shape":"AmazonResourceName"} }, "documentation":"

The request was denied because the resource can't have any more tags.

", "error":{"httpStatusCode":400}, "exception":true }, "TransmitMode":{ "type":"integer", "max":1, "min":0 }, "UlBucketSize":{ "type":"integer", "max":2147483647, "min":0 }, "UlRate":{ "type":"integer", "max":2147483647, "min":0 }, "UlRatePolicy":{ "type":"string", "max":256 }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the resource to remove tags from.

", "location":"querystring", "locationName":"resourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A list of the keys of the tags to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateDataSource":{ "type":"string", "max":4096, "min":1 }, "UpdateDestinationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DestinationName", "documentation":"

The new name of the resource.

", "location":"uri", "locationName":"Name" }, "ExpressionType":{ "shape":"ExpressionType", "documentation":"

The type of value in Expression.

" }, "Expression":{ "shape":"Expression", "documentation":"

The new rule name or topic rule to send messages to.

" }, "Description":{ "shape":"Description", "documentation":"

A new description of the resource.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM Role that authorizes the destination.

" } } }, "UpdateDestinationResponse":{ "type":"structure", "members":{ } }, "UpdatePartnerAccountRequest":{ "type":"structure", "required":[ "Sidewalk", "PartnerAccountId", "PartnerType" ], "members":{ "Sidewalk":{ "shape":"SidewalkUpdateAccount", "documentation":"

The Sidewalk account credentials.

" }, "PartnerAccountId":{ "shape":"PartnerAccountId", "documentation":"

The ID of the partner account to update.

", "location":"uri", "locationName":"PartnerAccountId" }, "PartnerType":{ "shape":"PartnerType", "documentation":"

The partner type.

", "location":"querystring", "locationName":"partnerType" } } }, "UpdatePartnerAccountResponse":{ "type":"structure", "members":{ } }, "UpdateSignature":{ "type":"string", "max":4096, "min":1 }, "UpdateWirelessDeviceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "DestinationName":{ "shape":"DestinationName", "documentation":"

The name of the new destination for the device.

" }, "Name":{ "shape":"WirelessDeviceName", "documentation":"

The new name of the resource.

" }, "Description":{ "shape":"Description", "documentation":"

A new description of the resource.

" }, "LoRaWAN":{ "shape":"LoRaWANUpdateDevice", "documentation":"

The updated wireless device's configuration.

" } } }, "UpdateWirelessDeviceResponse":{ "type":"structure", "members":{ } }, "UpdateWirelessGatewayRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the resource to update.

", "location":"uri", "locationName":"Id" }, "Name":{ "shape":"WirelessGatewayName", "documentation":"

The new name of the resource.

" }, "Description":{ "shape":"Description", "documentation":"

A new description of the resource.

" } } }, "UpdateWirelessGatewayResponse":{ "type":"structure", "members":{ } }, "UpdateWirelessGatewayTaskCreate":{ "type":"structure", "members":{ "UpdateDataSource":{ "shape":"UpdateDataSource", "documentation":"

The link to the S3 bucket.

" }, "UpdateDataRole":{ "shape":"UpdateDataSource", "documentation":"

The IAM role used to read data from the S3 bucket.

" }, "LoRaWAN":{ "shape":"LoRaWANUpdateGatewayTaskCreate", "documentation":"

The properties that relate to the LoRaWAN wireless gateway.

" } }, "documentation":"

UpdateWirelessGatewayTaskCreate object.

" }, "UpdateWirelessGatewayTaskEntry":{ "type":"structure", "members":{ "Id":{ "shape":"WirelessGatewayTaskDefinitionId", "documentation":"

The ID of the new wireless gateway task entry.

" }, "LoRaWAN":{ "shape":"LoRaWANUpdateGatewayTaskEntry", "documentation":"

The properties that relate to the LoRaWAN wireless gateway.

" }, "Arn":{ "shape":"WirelessGatewayTaskDefinitionArn", "documentation":"

The Amazon Resource Name of the resource.

" } }, "documentation":"

UpdateWirelessGatewayTaskEntry object.

" }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"Message"} }, "documentation":"

The input did not meet the specified constraints.

", "error":{"httpStatusCode":400}, "exception":true }, "WirelessDeviceArn":{"type":"string"}, "WirelessDeviceId":{ "type":"string", "max":256 }, "WirelessDeviceIdType":{ "type":"string", "enum":[ "WirelessDeviceId", "DevEui", "ThingName" ] }, "WirelessDeviceName":{ "type":"string", "max":256 }, "WirelessDeviceStatistics":{ "type":"structure", "members":{ "Arn":{ "shape":"WirelessDeviceArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Id":{ "shape":"WirelessDeviceId", "documentation":"

The ID of the wireless device reporting the data.

" }, "Type":{ "shape":"WirelessDeviceType", "documentation":"

The wireless device type.

" }, "Name":{ "shape":"WirelessDeviceName", "documentation":"

The name of the resource.

" }, "DestinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination to which the device is assigned.

" }, "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the most recent uplink was received.

" }, "LoRaWAN":{ "shape":"LoRaWANListDevice", "documentation":"

LoRaWAN device info.

" }, "Sidewalk":{ "shape":"SidewalkListDevice", "documentation":"

The Sidewalk account credentials.

" } }, "documentation":"

Information about a wireless device's operation.

" }, "WirelessDeviceStatisticsList":{ "type":"list", "member":{"shape":"WirelessDeviceStatistics"} }, "WirelessDeviceType":{ "type":"string", "enum":[ "Sidewalk", "LoRaWAN" ] }, "WirelessGatewayArn":{"type":"string"}, "WirelessGatewayId":{ "type":"string", "max":256 }, "WirelessGatewayIdType":{ "type":"string", "enum":[ "GatewayEui", "WirelessGatewayId", "ThingName" ] }, "WirelessGatewayName":{ "type":"string", "max":256 }, "WirelessGatewayServiceType":{ "type":"string", "enum":[ "CUPS", "LNS" ] }, "WirelessGatewayStatistics":{ "type":"structure", "members":{ "Arn":{ "shape":"WirelessGatewayArn", "documentation":"

The Amazon Resource Name of the resource.

" }, "Id":{ "shape":"WirelessGatewayId", "documentation":"

The ID of the wireless gateway reporting the data.

" }, "Name":{ "shape":"WirelessGatewayName", "documentation":"

The name of the resource.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the resource.

" }, "LoRaWAN":{ "shape":"LoRaWANGateway", "documentation":"

LoRaWAN gateway info.

" }, "LastUplinkReceivedAt":{ "shape":"ISODateTimeString", "documentation":"

The date and time when the most recent uplink was received.

" } }, "documentation":"

Information about a wireless gateway's operation.

" }, "WirelessGatewayStatisticsList":{ "type":"list", "member":{"shape":"WirelessGatewayStatistics"} }, "WirelessGatewayTaskDefinitionArn":{"type":"string"}, "WirelessGatewayTaskDefinitionId":{ "type":"string", "max":36, "pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" }, "WirelessGatewayTaskDefinitionList":{ "type":"list", "member":{"shape":"UpdateWirelessGatewayTaskEntry"} }, "WirelessGatewayTaskDefinitionType":{ "type":"string", "enum":["UPDATE"] }, "WirelessGatewayTaskName":{ "type":"string", "max":2048, "min":1 }, "WirelessGatewayTaskStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "FIRST_RETRY", "SECOND_RETRY", "COMPLETED", "FAILED" ] }, "WirelessMetadata":{ "type":"structure", "members":{ "LoRaWAN":{ "shape":"LoRaWANSendDataToDevice", "documentation":"

LoRaWAN device info.

" }, "Sidewalk":{ "shape":"SidewalkSendDataToDevice", "documentation":"

The Sidewalk account credentials.

" } }, "documentation":"

WirelessMetadata object.

" } }, "documentation":"

AWS IoT Wireless API documentation

" }