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

{
    'spaceId': 'string',
    'arn': 'string',
    'name': 'string',
    'status': 'string',
    'configurationStatus': 'CONFIGURED'|'UNCONFIGURED',
    'clientId': 'string',
    'identityStoreId': 'string',
    'applicationArn': 'string',
    'description': 'string',
    'vanityDomainStatus': 'PENDING'|'APPROVED'|'UNAPPROVED',
    'vanityDomain': 'string',
    'randomDomain': 'string',
    'customerRoleArn': 'string',
    'createDateTime': datetime(2015, 1, 1),
    'deleteDateTime': datetime(2015, 1, 1),
    'tier': 'BASIC'|'STANDARD',
    'storageLimit': 123,
    'userAdmins': [
        'string',
    ],
    'groupAdmins': [
        'string',
    ],
    'roles': {
        'string': [
            'EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR',
        ]
    },
    'userKMSKey': 'string',
    'userCount': 123,
    'contentSize': 123,
    'supportedEmailDomains': {
        'enabled': 'ENABLED'|'DISABLED'|'NOT_ALLOWED',
        'allowedDomains': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • spaceId (string) –

    The unique ID of the private re:Post.

  • arn (string) –

    The ARN of the private re:Post.

  • name (string) –

    The name of the private re:Post.

  • status (string) –

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

  • configurationStatus (string) –

    The configuration status of the private re:Post.

  • clientId (string) –

    The Identity Center identifier for the Application Instance.

  • identityStoreId (string) –

  • applicationArn (string) –

  • description (string) –

    The description of the private re:Post.

  • vanityDomainStatus (string) –

    The approval status of the custom subdomain.

  • vanityDomain (string) –

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

  • randomDomain (string) –

    The AWS generated subdomain of the private re:Post

  • customerRoleArn (string) –

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

  • createDateTime (datetime) –

    The date when the private re:Post was created.

  • deleteDateTime (datetime) –

    The date when the private re:Post was deleted.

  • tier (string) –

    The pricing tier of the private re:Post.

  • storageLimit (integer) –

    The storage limit of the private re:Post.

  • userAdmins (list) –

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

    • (string) –

  • groupAdmins (list) –

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

    • (string) –

  • roles (dict) –

    A map of accessor identifiers and their roles.

    • (string) –

      • (list) –

        • (string) –

  • userKMSKey (string) –

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

  • userCount (integer) –

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

  • contentSize (integer) –

    The content size of the private re:Post.

  • supportedEmailDomains (dict) –

    • enabled (string) –

    • allowedDomains (list) –

      • (string) –

Exceptions

• rePostPrivate.Client.exceptions.ValidationException

• rePostPrivate.Client.exceptions.AccessDeniedException

• rePostPrivate.Client.exceptions.ResourceNotFoundException

• rePostPrivate.Client.exceptions.ThrottlingException

• rePostPrivate.Client.exceptions.InternalServerException