ListNetworkProfiles
Returns the list of available network profiles.
Request Syntax
{
"arn": "string
",
"nextToken": "string
",
"type": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- arn
-
The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern:
^arn:.+
Required: Yes
- nextToken
-
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Required: No
- type
-
The type of network profile to return information about. Valid values are listed here.
Type: String
Valid Values:
CURATED | PRIVATE
Required: No
Response Syntax
{
"networkProfiles": [
{
"arn": "string",
"description": "string",
"downlinkBandwidthBits": number,
"downlinkDelayMs": number,
"downlinkJitterMs": number,
"downlinkLossPercent": number,
"name": "string",
"type": "string",
"uplinkBandwidthBits": number,
"uplinkDelayMs": number,
"uplinkJitterMs": number,
"uplinkLossPercent": number
}
],
"nextToken": "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.
- networkProfiles
-
A list of the available network profiles.
Type: Array of NetworkProfile objects
- nextToken
-
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ArgumentException
-
An invalid argument was specified.
HTTP Status Code: 400
- LimitExceededException
-
A limit was exceeded.
HTTP Status Code: 400
- NotFoundException
-
The specified entity was not found.
HTTP Status Code: 400
- ServiceAccountException
-
There was a problem with the service account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: