Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . workspaces ]
create-standby-workspaces¶
Synopsis¶
create-standby-workspaces
--primary-region <value>
--standby-workspaces <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--primary-region (string)
The Region of the primary WorkSpace.
--standby-workspaces (list)
Information about the standby WorkSpace to be created.
(structure)
Describes a standby WorkSpace.
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.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.Value -> (string)
The value of the tag.DataReplication -> (string)
Indicates whether data replication is enabled, and if enabled, the type of data replication.
Shorthand Syntax:
PrimaryWorkspaceId=string,VolumeEncryptionKey=string,DirectoryId=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}],DataReplication=string ...
JSON Syntax:
[
{
"PrimaryWorkspaceId": "string",
"VolumeEncryptionKey": "string",
"DirectoryId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
],
"DataReplication": "NO_REPLICATION"|"PRIMARY_AS_SOURCE"
}
...
]
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Output¶
FailedStandbyRequests -> (list)
Information about the standby WorkSpace that could not be created.
(structure)
Describes the standby WorkSpace that could not be created.
StandbyWorkspaceRequest -> (structure)
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.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.Value -> (string)
The value of the tag.DataReplication -> (string)
Indicates whether data replication is enabled, and if enabled, the type of data replication.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.
(structure)
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.