AddWorkload
Adds a workload to a component. Each component can have at most five workloads.
Request Syntax
{
"ComponentName": "string",
"ResourceGroupName": "string",
"WorkloadConfiguration": {
"Configuration": "string",
"Tier": "string",
"WorkloadName": "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.
- 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
- 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
- WorkloadConfiguration
-
The configuration settings of the workload. The value is the escaped JSON of the configuration.
Type: WorkloadConfiguration object
Required: Yes
Response Syntax
{
"WorkloadConfiguration": {
"Configuration": "string",
"Tier": "string",
"WorkloadName": "string"
},
"WorkloadId": "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.
- WorkloadConfiguration
-
The configuration settings of the workload. The value is the escaped JSON of the configuration.
Type: WorkloadConfiguration object
- WorkloadId
-
The ID of the workload.
Type: String
Length Constraints: Fixed length of 38.
Pattern:
w-[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
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
- ResourceInUseException
-
The resource is already created or in use.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
