WorkSpaces / Client / create_standby_workspaces

create_standby_workspaces#

WorkSpaces.Client.create_standby_workspaces(**kwargs)#

Creates a standby WorkSpace in a secondary Region.

Request Syntax

response = client.create_standby_workspaces(
    PrimaryRegion='string',
    StandbyWorkspaces=[
        {
            'PrimaryWorkspaceId': 'string',
            'VolumeEncryptionKey': 'string',
            'DirectoryId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

PrimaryRegion (string) –
[REQUIRED]

The Region of the primary WorkSpace.
StandbyWorkspaces (list) –
[REQUIRED]

Information about the standby WorkSpace to be created.
- (dict) –
  
  Describes a standby WorkSpace.
  - PrimaryWorkspaceId (string) – [REQUIRED]
    
    The identifier of the standby WorkSpace.
  - VolumeEncryptionKey (string) –
    
    The volume encryption key of the standby WorkSpace.
  - DirectoryId (string) – [REQUIRED]
    
    The identifier of the directory for the standby WorkSpace.
  - Tags (list) –
    
    The tags associated with the standby WorkSpace.
    - (dict) –
      
      Describes a tag.
      - Key (string) – [REQUIRED]
        
        The key of the tag.
      - Value (string) –
        
        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'FailedStandbyRequests': [
        {
            'StandbyWorkspaceRequest': {
                'PrimaryWorkspaceId': 'string',
                'VolumeEncryptionKey': 'string',
                'DirectoryId': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'PendingStandbyRequests': [
        {
            'UserName': 'string',
            'DirectoryId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'WorkspaceId': 'string'
        },
    ]
}

Response Structure

(dict) –
- FailedStandbyRequests (list) –
  
  Information about the standby WorkSpace that could not be created.
  - (dict) –
    
    Describes the standby WorkSpace that could not be created.
    - StandbyWorkspaceRequest (dict) –
      
      Information about the standby WorkSpace that could not be created.
      - PrimaryWorkspaceId (string) –
        
        The identifier of the standby WorkSpace.
      - VolumeEncryptionKey (string) –
        
        The volume encryption key of the standby WorkSpace.
      - DirectoryId (string) –
        
        The identifier of the directory for the standby WorkSpace.
      - Tags (list) –
        
        The tags associated with the standby WorkSpace.
        
        (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Value (string) –
        
        The value of the tag.
    - ErrorCode (string) –
      
      The error code that is returned if the standby WorkSpace could not be created.
    - ErrorMessage (string) –
      
      The text of the error message that is returned if the standby WorkSpace could not be created.
- PendingStandbyRequests (list) –
  
  Information about the standby WorkSpace that was created.
  - (dict) –
    
    Information about the standby WorkSpace.
    - UserName (string) –
      
      Describes the standby WorkSpace that was created.
      
      Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
    - DirectoryId (string) –
      
      The identifier of the directory for the standby WorkSpace.
    - State (string) –
      
      The operational state of the standby WorkSpace.
    - WorkspaceId (string) –
      
      The identifier of the standby WorkSpace.

Exceptions

WorkSpaces.Client.exceptions.AccessDeniedException
WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.OperationNotSupportedException
WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.ResourceLimitExceededException