spaces

Creates, updates, deletes, gets or lists a spaces resource.

Overview

Name	spaces
Type	Resource
Id	aws.repostspace.spaces

Fields

The following fields are returned by SELECT queries:

get_space

Name	Datatype	Description
name	string	The name of the private re:Post.
application_arn	string
arn	string	The ARN of the private re:Post.
client_id	string	The Identity Center identifier for the Application Instance.
configuration_status	string	The configuration status of the private re:Post. (CONFIGURED, UNCONFIGURED)
content_size	integer (int64)	The content size of the private re:Post.
create_date_time	string (date-time)	The date when the private re:Post was created.
customer_role_arn	string	The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
delete_date_time	string (date-time)	The date when the private re:Post was deleted.
description	string	The description of the private re:Post.
group_admins	array	The list of groups that are administrators of the private re:Post.
identity_store_id	string
random_domain	string	The AWS generated subdomain of the private re:Post
roles	object	A map of accessor identifiers and their roles.
space_id	string	The unique ID of the private re:Post.
status	string	The creation or deletion status of the private re:Post.
storage_limit	integer (int64)	The storage limit of the private re:Post.
supported_email_domains	object
tier	string	The pricing tier of the private re:Post. (BASIC, STANDARD)
user_admins	array	The list of users that are administrators of the private re:Post.
user_count	integer	The number of users that have onboarded to the private re:Post.
user_kms_key	string	The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
vanity_domain	string	The custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
vanity_domain_status	string	The approval status of the custom subdomain. (PENDING, APPROVED, UNAPPROVED)

list_spaces

Name	Datatype	Description
name	string	The name for the private re:Post.
arn	string	The ARN of the private re:Post.
configuration_status	string	The configuration status of the private re:Post. (CONFIGURED, UNCONFIGURED)
content_size	integer (int64)	The content size of the private re:Post.
create_date_time	string (date-time)	The date when the private re:Post was created.
delete_date_time	string (date-time)	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.
random_domain	string	The AWS generated subdomain of the private re:Post.
space_id	string	The unique ID of the private re:Post.
status	string	The creation/deletion status of the private re:Post.
storage_limit	integer (int64)	The storage limit of the private re:Post.
supported_email_domains	object
tier	string	The pricing tier of the private re:Post. (BASIC, STANDARD)
user_count	integer	The number of onboarded users to the private re:Post.
user_kms_key	string	The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
vanity_domain	string	This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
vanity_domain_status	string	This approval status of the custom subdomain. (PENDING, APPROVED, UNAPPROVED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_space	select	space_id, region		Displays information about the AWS re:Post Private private re:Post.
list_spaces	select	region	nextToken, maxResults	Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
create_space	insert	region, name, subdomain, tier		Creates an AWS re:Post Private private re:Post.
register_admin	insert	space_id, admin_id, region		Adds a user or group to the list of administrators of the private re:Post.
update_space	update	space_id, region		Modifies an existing AWS re:Post Private private re:Post.
deregister_admin	delete	space_id, admin_id, region		Removes the user or group from the list of administrators of the private re:Post.
delete_space	delete	space_id, region		Deletes an AWS re:Post Private private re:Post.
batch_add_role	exec	space_id, region, accessorIds, role		Add a role to multiple users or groups in a private re:Post.
batch_remove_role	exec	space_id, region, accessorIds, role		Remove a role from multiple users or groups in a private re:Post.
send_invites	exec	space_id, region, accessorIds, title, body		Sends an invitation email to selected users and groups.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
admin_id	string	The ID of the admin to remove.
region	string	AWS region (default: us-east-1)
space_id	string	The ID of the private re:Post.
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.

SELECT examples

get_space

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

SELECT
name,
application_arn,
arn,
client_id,
configuration_status,
content_size,
create_date_time,
customer_role_arn,
delete_date_time,
description,
group_admins,
identity_store_id,
random_domain,
roles,
space_id,
status,
storage_limit,
supported_email_domains,
tier,
user_admins,
user_count,
user_kms_key,
vanity_domain,
vanity_domain_status
FROM aws.repostspace.spaces
WHERE space_id = '{{ space_id }}' -- required
AND region = '{{ region }}' -- required
;

list_spaces

Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

SELECT
name,
arn,
configuration_status,
content_size,
create_date_time,
delete_date_time,
description,
random_domain,
space_id,
status,
storage_limit,
supported_email_domains,
tier,
user_count,
user_kms_key,
vanity_domain,
vanity_domain_status
FROM aws.repostspace.spaces
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_space

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

INSERT INTO aws.repostspace.spaces (
name,
subdomain,
tier,
description,
userKMSKey,
tags,
roleArn,
supportedEmailDomains,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ subdomain }}' /* required */,
'{{ tier }}' /* required */,
'{{ description }}',
'{{ userKMSKey }}',
'{{ tags }}',
'{{ roleArn }}',
'{{ supportedEmailDomains }}',
'{{ region }}'
RETURNING
space_id
;

register_admin

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

INSERT INTO aws.repostspace.spaces (
space_id,
admin_id,
region
)
SELECT 
'{{ space_id }}',
'{{ admin_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: spaces
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the spaces resource.
  - name: space_id
    value: "{{ space_id }}"
    description: Required parameter for the spaces resource.
  - name: admin_id
    value: "{{ admin_id }}"
    description: Required parameter for the spaces resource.
  - name: name
    value: "{{ name }}"
  - name: subdomain
    value: "{{ subdomain }}"
  - name: tier
    value: "{{ tier }}"
    valid_values: ['BASIC', 'STANDARD']
  - name: description
    value: "{{ description }}"
  - name: userKMSKey
    value: "{{ userKMSKey }}"
  - name: tags
    value: "{{ tags }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: supportedEmailDomains
    value:
      enabled: "{{ enabled }}"
      allowedDomains:
        - "{{ allowedDomains }}"

UPDATE examples

update_space

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

UPDATE aws.repostspace.spaces
SET 
description = '{{ description }}',
tier = '{{ tier }}',
roleArn = '{{ roleArn }}',
supportedEmailDomains = '{{ supportedEmailDomains }}'
WHERE 
space_id = '{{ space_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

deregister_admin

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

DELETE FROM aws.repostspace.spaces
WHERE space_id = '{{ space_id }}' --required
AND admin_id = '{{ admin_id }}' --required
AND region = '{{ region }}' --required
;

delete_space

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

DELETE FROM aws.repostspace.spaces
WHERE space_id = '{{ space_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_add_role

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

EXEC aws.repostspace.spaces.batch_add_role 
@space_id='{{ space_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"accessorIds": "{{ accessorIds }}", 
"role": "{{ role }}"
}'
;

batch_remove_role

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

EXEC aws.repostspace.spaces.batch_remove_role 
@space_id='{{ space_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"accessorIds": "{{ accessorIds }}", 
"role": "{{ role }}"
}'
;

send_invites

Sends an invitation email to selected users and groups.

EXEC aws.repostspace.spaces.send_invites 
@space_id='{{ space_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"accessorIds": "{{ accessorIds }}", 
"title": "{{ title }}", 
"body": "{{ body }}"
}'
;