# 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. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListSpaces) `list-spaces` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `spaces` ## Synopsis ``` list-spaces [--starting-token ] [--page-size ] [--max-items ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . > Constraints: > * min: `1` > * max: `100` `--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* . `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`. `--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## 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 * yaml * yaml-stream * off `--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. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Output 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. > > spaceId -> (string) [required] > > > The unique ID of the private re:Post. > > arn -> (string) [required] > > > The ARN of the private re:Post. > > > Constraints: > > > * min: `20` > > > * max: `2048` > > name -> (string) [required] > > > The name for the private re:Post. > > > Constraints: > > > * min: `1` > > > * max: `30` > > description -> (string) > > > The description for the private re:Post. This is used only to help you identify this private re:Post. > > > Constraints: > > > * min: `1` > > > * max: `255` > > status -> (string) [required] > > > The creation/deletion status of the private re:Post. > > > Constraints: > > > * min: `1` > > > * max: `30` > > configurationStatus -> (string) [required] > > > The configuration status of the private re:Post. > > > Possible values: > > > * `CONFIGURED` > > > * `UNCONFIGURED` > > vanityDomainStatus -> (string) [required] > > > This approval status of the custom subdomain. > > > Possible values: > > > * `PENDING` > > > * `APPROVED` > > > * `UNAPPROVED` > > vanityDomain -> (string) [required] > > > This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use. > > randomDomain -> (string) [required] > > > The AWS generated subdomain of the private re:Post. > > tier -> (string) [required] > > > The pricing tier of the private re:Post. > > > Possible values: > > > * `BASIC` > > > * `STANDARD` > > storageLimit -> (long) [required] > > > The storage limit of the private re:Post. > > createDateTime -> (timestamp) [required] > > > The date when the private re:Post was created. > > deleteDateTime -> (timestamp) > > > The date when the private re:Post was deleted. > > userKMSKey -> (string) > > > The custom AWS KMS key ARN that’s used for the AWS KMS encryption. > > userCount -> (integer) > > > The number of onboarded users to the private re:Post. > > contentSize -> (long) > > > The content size of the private re:Post. > > supportedEmailDomains -> (structure) > > > enabled -> (string) > > > > Possible values: > > > > * `ENABLED` > > > > * `DISABLED` > > > > * `NOT_ALLOWED` > > > allowedDomains -> (list) > > > > Constraints: > > > > * min: `1` > > > > * max: `10` > > > > (string) > > > > > Constraints: > > > > > * min: `1` > > > > > * max: `255` nextToken -> (string) > The token that you use when you request the next set of private re:Posts.