rePostPrivate / Client / get_space

get_space#

rePostPrivate.Client.get_space(**kwargs)#

Displays information about the AWS re:Post Private private re:Post.

See also: AWS API Documentation

Request Syntax

response = client.get_space(
    spaceId='string'
)
Parameters:

spaceId (string) –

[REQUIRED]

The ID of the private re:Post.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the private re:Post.

    • clientId (string) –

      The Identity Center identifier for the Application Instance.

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

    • customerRoleArn (string) –

      The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.

    • deleteDateTime (datetime) –

      The date when the private re:Post was deleted.

    • description (string) –

      The description of the private re:Post.

    • groupAdmins (list) –

      The list of groups that are administrators of the private re:Post.

      • (string) –

    • name (string) –

      The name of 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 or 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.

    • userAdmins (list) –

      The list of users that are administrators of the private re:Post.

      • (string) –

    • userCount (integer) –

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

    • userKMSKey (string) –

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

    • vanityDomain (string) –

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

    • vanityDomainStatus (string) –

      The approval status of the custom subdomain.

Exceptions

  • rePostPrivate.Client.exceptions.AccessDeniedException

  • rePostPrivate.Client.exceptions.ValidationException

  • rePostPrivate.Client.exceptions.ResourceNotFoundException

  • rePostPrivate.Client.exceptions.ThrottlingException

  • rePostPrivate.Client.exceptions.InternalServerException