WorkSpaces / Client / deploy_workspace_applications

deploy_workspace_applications#

WorkSpaces.Client.deploy_workspace_applications(**kwargs)#

Deploys associated applications to the specified WorkSpace

See also: AWS API Documentation

Request Syntax

response = client.deploy_workspace_applications(
    WorkspaceId='string',
    Force=True|False
)
Parameters:

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the WorkSpace.

  • Force (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Deployment': {
        'Associations': [
            {
                'AssociatedResourceId': 'string',
                'AssociatedResourceType': 'APPLICATION',
                'Created': datetime(2015, 1, 1),
                'LastUpdatedTime': datetime(2015, 1, 1),
                'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
                'StateReason': {
                    'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
                    'ErrorMessage': 'string'
                },
                'WorkspaceId': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Deployment (dict) –

      The list of deployed associations and information about them.

      • Associations (list) –

        The associations between the applications and the associated resources.

        • (dict) –

          Describes the association between an application and a WorkSpace resource.

          • AssociatedResourceId (string) –

            The identifier of the associated resource.

          • AssociatedResourceType (string) –

            The resource types of the associated resource.

          • Created (datetime) –

            The time the association is created.

          • LastUpdatedTime (datetime) –

            The time the association status was last updated.

          • State (string) –

            The status of the WorkSpace resource association.

          • StateReason (dict) –

            The reason the association deployment failed.

            • ErrorCode (string) –

              The error code of the association deployment failure.

            • ErrorMessage (string) –

              The error message of the association deployment failure.

          • WorkspaceId (string) –

            The identifier of the WorkSpace.

Exceptions