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 . repostspace ]

list-spaces¶

Description¶

Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

Synopsis¶

  list-spaces
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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¶

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

--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¶

nextToken -> (string)

The token that you use when you request the next set of private re:Posts.

spaces -> (list)

An array of structures that contain some information about the private re:Posts in the account.

(structure)

A structure that contains some information about a private re:Post in the account.

arn -> (string)

The ARN of the private re:Post.

configurationStatus -> (string)

The configuration status of the private re:Post.

contentSize -> (long)

The content size of the private re:Post.

createDateTime -> (timestamp)

The date when the private re:Post was created.

deleteDateTime -> (timestamp)

The date when the private re:Post was deleted.

description -> (string)

The description for the private re:Post. This is used only to help you identify this private re:Post.

name -> (string)

The name for the private re:Post.

randomDomain -> (string)

The AWS generated subdomain of the private re:Post.

spaceId -> (string)

The unique ID of the private re:Post.

status -> (string)

The creation/deletion status of the private re:Post.

storageLimit -> (long)

The storage limit of the private re:Post.

tier -> (string)

The pricing tier of the private re:Post.

userCount -> (integer)

The number of onboarded users to the private re:Post.

userKMSKey -> (string)

The custom AWS KMS key ARN that’s used for the AWS KMS encryption.

vanityDomain -> (string)

This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.

vanityDomainStatus -> (string)

This approval status of the custom subdomain.

Table Of Contents

Feedback

User Guide