Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListWorkloads

Lists the workloads that are configured on a given component.

Request Syntax


{
   "AccountId": "string",
   "ComponentName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceGroupName": "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.

AccountId

The AWS account ID of the owner of the workload.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

ComponentName

The name of the component.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: (?:^[\d\w\-_\.+]*$)|(?:^arn:aws(-\w+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$)

Required: Yes

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 40.

Required: No

NextToken

The token to request the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

ResourceGroupName

The name of the resource group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9\.\-_]*

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "WorkloadList": [ 
      { 
         "ComponentName": "string",
         "MissingWorkloadConfig": boolean,
         "Tier": "string",
         "WorkloadId": "string",
         "WorkloadName": "string",
         "WorkloadRemarks": "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

The token to request the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

WorkloadList

The list of workloads.

Type: Array of Workload objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 400

ResourceNotFoundException

The resource does not exist in the customer account.

HTTP Status Code: 400

ValidationException

The parameter is not valid.

HTTP Status Code: 400