AWS re:Post Private

Remove role from multiple users or groups in a private re:Post.

See also: AWS API Documentation

Request Syntax

client.batch_remove_role(
    accessorIds=[
        'string',
    ],
    role='EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR',
    spaceId='string'
)

type accessorIds:

list

param accessorIds:

[REQUIRED]

The user or group accessor identifiers to remove the role from.

• (string) --

type role:

string

param role:

[REQUIRED]

The role to remove from the users or groups.

type spaceId:

string

param spaceId:

[REQUIRED]

The unique ID of the private re:Post.

rtype:

dict

returns:

Response Syntax

{
    'errors': [
        {
            'accessorId': 'string',
            'error': 123,
            'message': 'string'
        },
    ],
    'removedAccessorIds': [
        'string',
    ]
}

Response Structure

• (dict) --

  • errors (list) --

    An array of errors that occurred when roles were removed.

    • (dict) --

      An error that occurred during a batch operation.

      • accessorId (string) --

        The accessor identifier that's related to the error.

      • error (integer) --

        The error code.

      • message (string) --

        Description of the error.

  • removedAccessorIds (list) --

    An array of successfully updated accessor identifiers.

    • (string) --

Add role to multiple users or groups in a private re:Post.

See also: AWS API Documentation

Request Syntax

client.batch_add_role(
    accessorIds=[
        'string',
    ],
    role='EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR',
    spaceId='string'
)

type accessorIds:

list

param accessorIds:

[REQUIRED]

The user or group accessor identifiers to add the role to.

• (string) --

type role:

string

param role:

[REQUIRED]

The role to add to the users or groups.

type spaceId:

string

param spaceId:

[REQUIRED]

The unique ID of the private re:Post.

rtype:

dict

returns:

Response Syntax

{
    'addedAccessorIds': [
        'string',
    ],
    'errors': [
        {
            'accessorId': 'string',
            'error': 123,
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • addedAccessorIds (list) --

    An array of successfully updated accessor identifiers.

    • (string) --

  • errors (list) --

    An array of errors that occurred when roles were added.

    • (dict) --

      An error that occurred during a batch operation.

      • accessorId (string) --

        The accessor identifier that's related to the error.

      • error (integer) --

        The error code.

      • message (string) --

        Description of the error.

{'roles': {'string': ['EXPERT | MODERATOR | ADMINISTRATOR | SUPPORTREQUESTOR']}}

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

See also: AWS API Documentation

Request Syntax

client.get_space(
    spaceId='string'
)

type spaceId:

string

param spaceId:

[REQUIRED]

The ID of the private re:Post.

rtype:

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',
    'roles': {
        'string': [
            'EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR',
        ]
    },
    '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

  • roles (dict) --

    A map of accessor identifiers and their roles.

    • (string) --

      • (list) --

        • (string) --

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