rePostPrivate / Client / list_spaces

list_spaces#

rePostPrivate.Client.list_spaces(**kwargs)#

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

Request Syntax

response = client.list_spaces(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of private re:Posts to include in the results.

  • nextToken (string) – The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'spaces': [
        {
            'arn': 'string',
            'configurationStatus': 'CONFIGURED'|'UNCONFIGURED',
            'contentSize': 123,
            'createDateTime': datetime(2015, 1, 1),
            'deleteDateTime': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'randomDomain': 'string',
            'spaceId': 'string',
            'status': 'string',
            'storageLimit': 123,
            'tier': 'BASIC'|'STANDARD',
            'userCount': 123,
            'userKMSKey': 'string',
            'vanityDomain': 'string',
            'vanityDomainStatus': 'PENDING'|'APPROVED'|'UNAPPROVED'
        },
    ]
}

Response Structure

  • (dict) –

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

      • (dict) –

        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 (integer) –

          The content size of the private re:Post.

        • createDateTime (datetime) –

          The date when the private re:Post was created.

        • deleteDateTime (datetime) –

          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 (integer) –

          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.

Exceptions