ListStageDevices
Lists devices allocated to the stage, containing detailed device information and deployment status.
Request Syntax
{
"EdgeDeploymentPlanName": "string
",
"ExcludeDevicesDeployedInOtherStage": boolean
,
"MaxResults": number
,
"NextToken": "string
",
"StageName": "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.
- EdgeDeploymentPlanName
-
The name of the edge deployment plan.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
Required: Yes
- ExcludeDevicesDeployedInOtherStage
-
Toggle for excluding devices deployed in other stages.
Type: Boolean
Required: No
- MaxResults
-
The maximum number of requests to select.
Type: Integer
Valid Range: Maximum value of 100.
Required: No
- NextToken
-
The response from the last list when returning a list large enough to neeed tokening.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- StageName
-
The name of the stage in the deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
Required: Yes
Response Syntax
{
"DeviceDeploymentSummaries": [
{
"DeployedStageName": "string",
"DeploymentStartTime": number,
"Description": "string",
"DeviceArn": "string",
"DeviceDeploymentStatus": "string",
"DeviceDeploymentStatusMessage": "string",
"DeviceFleetName": "string",
"DeviceName": "string",
"EdgeDeploymentPlanArn": "string",
"EdgeDeploymentPlanName": "string",
"StageName": "string"
}
],
"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.
- DeviceDeploymentSummaries
-
List of summaries of devices allocated to the stage.
Type: Array of DeviceDeploymentSummary objects
- NextToken
-
The token to use when calling the next page of results.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: