Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeployWorkspaceApplications

Deploys associated applications to the specified WorkSpace

Request Syntax


{
   "Force": boolean,
   "WorkspaceId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Force

Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.

Type: Boolean

Required: No

WorkspaceId

The identifier of the WorkSpace.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: Yes

Response Syntax


{
   "Deployment": { 
      "Associations": [ 
         { 
            "AssociatedResourceId": "string",
            "AssociatedResourceType": "string",
            "Created": number,
            "LastUpdatedTime": number,
            "State": "string",
            "StateReason": { 
               "ErrorCode": "string",
               "ErrorMessage": "string"
            },
            "WorkspaceId": "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.

Deployment

The list of deployed associations and information about them.

Type: WorkSpaceApplicationDeployment object

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

IncompatibleApplicationsException

The specified application is not compatible with the resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

message: The exception error message.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

message: The exception error message.
reason: The exception error reason.

HTTP Status Code: 400

ResourceInUseException

The specified resource is currently in use.

ResourceId: The ID of the resource that is in use.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

message: The resource could not be found.
ResourceId: The ID of the resource that could not be found.

HTTP Status Code: 400