ListServiceProfiles
Lists the service profiles registered to your AWS account.
Request Syntax
GET /service-profiles?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 159)
The maximum number of results to return in this operation.
Valid Range: Minimum value of 0. Maximum value of 250.
NextToken (p. 159)
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Length Constraints: Maximum length of 4096.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "NextToken": "string", "ServiceProfileList": [ {
"Arn": "string", "Id": "string", "Name": "string"
} ]}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 159)
The token to use to get the next set of results, or null if there are no additional results.
Errors
Type: String
Length Constraints: Maximum length of 4096.
ServiceProfileList (p. 159) The list of service profiles.
Type: Array of ServiceProfile (p. 273) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListTagsForResource
ListTagsForResource
Lists the tags (metadata) you have assigned to the resource.
Request Syntax
GET /tags?resourceArn=ResourceArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
ResourceArn (p. 161)
The ARN of the resource for which you want to list tags.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"Tags": [ {
"Key": "string", "Value": "string"
} ]}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Tags (p. 161)
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
Type: Array of Tag (p. 284) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
ConflictException
Adding, updating, or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ResourceNotFoundException
Resource does not exist.
HTTP Status Code: 404 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListWirelessDevices
ListWirelessDevices
Lists the wireless devices registered to your AWS account.
Request Syntax
GET /wireless-devices?
destinationName=DestinationName&deviceProfileId=DeviceProfileId&fuotaTaskId=FuotaTaskId&maxResults=MaxResults&multicastGroupId=MulticastGroupId&nextToken=NextToken&serviceProfileId=ServiceProfileId&wirelessDeviceType=WirelessDeviceType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
DestinationName (p. 163)
A filter to list only the wireless devices that use this destination.
Length Constraints: Maximum length of 128.
Pattern: [a-zA-Z0-9-_]+
DeviceProfileId (p. 163)
A filter to list only the wireless devices that use this device profile.
Length Constraints: Maximum length of 256.
FuotaTaskId (p. 163) The ID of a FUOTA task.
Length Constraints: Maximum length of 256.
MaxResults (p. 163)
The maximum number of results to return in this operation.
Valid Range: Minimum value of 0. Maximum value of 250.
MulticastGroupId (p. 163) The ID of the multicast group.
Length Constraints: Maximum length of 256.
NextToken (p. 163)
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Length Constraints: Maximum length of 4096.
ServiceProfileId (p. 163)
A filter to list only the wireless devices that use this service profile.
Length Constraints: Maximum length of 256.
WirelessDeviceType (p. 163)
A filter to list only the wireless devices that use this wireless device type.
Request Body
Valid Values: Sidewalk | LoRaWAN
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"NextToken": "string", "WirelessDeviceList": [ {
"Arn": "string",
"DestinationName": "string", "FuotaDeviceStatus": "string", "Id": "string",
"LastUplinkReceivedAt": "string", "LoRaWAN": {
"DevEui": "string"
},
"McGroupId": number,
"MulticastDeviceStatus": "string", "Name": "string",
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 164)
The token to use to get the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Maximum length of 4096.
WirelessDeviceList (p. 164) The ID of the wireless device.
Errors
Type: Array of WirelessDeviceStatistics (p. 290) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListWirelessGateways
ListWirelessGateways
Lists the wireless gateways registered to your AWS account.
Request Syntax
GET /wireless-gateways?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 166)
The maximum number of results to return in this operation.
Valid Range: Minimum value of 0. Maximum value of 250.
NextToken (p. 166)
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Length Constraints: Maximum length of 4096.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"NextToken": "string", "WirelessGatewayList": [ {
"Arn": "string",
"Description": "string", "Id": "string",
"LastUplinkReceivedAt": "string", "LoRaWAN": {
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
NextToken (p. 166)
The token to use to get the next set of results, or null if there are no additional results.
Type: String
Length Constraints: Maximum length of 4096.
WirelessGatewayList (p. 166) The ID of the wireless gateway.
Type: Array of WirelessGatewayStatistics (p. 294) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 299).
AccessDeniedException
User does not have permission to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing a request.
HTTP Status Code: 500 ThrottlingException
The request was denied because it exceeded the allowed API request rate.
HTTP Status Code: 429 ValidationException
The input did not meet the specified constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3