AWS API Changes

2023/11/27 - AWS re:Post Private - 11 new api methods

Changes Initial release of AWS re:Post Private

RegisterAdmin (new)

Adds a user or group to the list of administrators of the private re:Post.

Request Syntax

client.register_admin(
    adminId='string',
    spaceId='string'
)

type adminId

string

param adminId

[REQUIRED]

The ID of the administrator.

type spaceId

string

param spaceId

[REQUIRED]

The ID of the private re:Post.

returns

None

ListSpaces (new)

Link ¶

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

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

type maxResults

integer

param maxResults

The maximum number of private re:Posts to include in the results.

type nextToken

string

param nextToken

The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.

rtype

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.

DeleteSpace (new)

Link ¶

Deletes an AWS re:Post Private private re:Post.

See also: AWS API Documentation

Request Syntax

client.delete_space(
    spaceId='string'
)

type spaceId

string

param spaceId

[REQUIRED]

The unique ID of the private re:Post.

returns

None

ListTagsForResource (new)

Link ¶

Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn. The only resource that can be tagged is a private re:Post.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn

string

param resourceArn

[REQUIRED]

The ARN of the resource that the tags are associated with.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  The list of tags that are associated with the resource.
  - (string) --
    - (string) --

GetSpace (new)

Link ¶

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',
    '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.

DeregisterAdmin (new)

Link ¶

Removes the user or group from the list of administrators of the private re:Post.

See also: AWS API Documentation

Request Syntax

client.deregister_admin(
    adminId='string',
    spaceId='string'
)

type adminId

string

param adminId

[REQUIRED]

The ID of the admin to remove.

type spaceId

string

param spaceId

[REQUIRED]

The ID of the private re:Post to remove the admin from.

returns

None

CreateSpace (new)

Link ¶

Creates an AWS re:Post Private private re:Post.

See also: AWS API Documentation

Request Syntax

client.create_space(
    description='string',
    name='string',
    roleArn='string',
    subdomain='string',
    tags={
        'string': 'string'
    },
    tier='BASIC'|'STANDARD',
    userKMSKey='string'
)

type description

string

param description

A description for the private re:Post. This is used only to help you identify this private re:Post.

type name

string

param name

[REQUIRED]

The name for the private re:Post. This must be unique in your account.

type roleArn

string

param roleArn

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

type subdomain

string

param subdomain

[REQUIRED]

The subdomain that you use to access your AWS re:Post Private private re:Post. All custom subdomains must be approved by AWS before use. In addition to your custom subdomain, all private re:Posts are issued an AWS generated subdomain for immediate use.

type tags

dict

param tags

The list of tags associated with the private re:Post.

(string) --
- (string) --

type tier

string

param tier

[REQUIRED]

The pricing tier for the private re:Post.

type userKMSKey

string

param userKMSKey

The AWS KMS key ARN that’s used for the AWS KMS encryption. If you don't provide a key, your data is encrypted by default with a key that AWS owns and manages for you.

rtype

dict

returns

Response Syntax

{
    'spaceId': 'string'
}

Response Structure

(dict) --
- spaceId (string) --
  
  The unique ID of the private re:Post.

UpdateSpace (new)

Link ¶

Modifies an existing AWS re:Post Private private re:Post.

See also: AWS API Documentation

Request Syntax

client.update_space(
    description='string',
    roleArn='string',
    spaceId='string',
    tier='BASIC'|'STANDARD'
)

type description

string

param description

A description for the private re:Post. This is used only to help you identify this private re:Post.

type roleArn

string

param roleArn

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

type spaceId

string

param spaceId

[REQUIRED]

The unique ID of this private re:Post.

type tier

string

param tier

The pricing tier of this private re:Post.

returns

None

SendInvites (new)

Link ¶

Sends an invitation email to selected users and groups.

See also: AWS API Documentation

Request Syntax

client.send_invites(
    accessorIds=[
        'string',
    ],
    body='string',
    spaceId='string',
    title='string'
)

type accessorIds

list

param accessorIds

[REQUIRED]

The array of identifiers for the users and groups.

(string) --

type body

string

param body

[REQUIRED]

The body of the invite.

type spaceId

string

param spaceId

[REQUIRED]

The ID of the private re:Post.

type title

string

param title

[REQUIRED]

The title of the invite.

returns

None

UntagResource (new)

Link ¶

Removes the association of the tag with the AWS re:Post Private resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn

string

param resourceArn

[REQUIRED]

The ARN of the resource.

type tagKeys

list

param tagKeys

[REQUIRED]

The key values of the tag.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

TagResource (new)

Link ¶

Associates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are associated with the resource. If you specify a tag key that’s already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn

string

param resourceArn

[REQUIRED]

The ARN of the resource that the tag is associated with.

type tags

dict

param tags

[REQUIRED]

The list of tag keys and values that must be associated with the resource. You can associate tag keys only, tags (key and values) only, or a combination of tag keys and tags.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --