Repostspace
This page documents function available when using the Repostspace
module, created with @service Repostspace
.
Index
Main.Repostspace.create_space
Main.Repostspace.delete_space
Main.Repostspace.deregister_admin
Main.Repostspace.get_space
Main.Repostspace.list_spaces
Main.Repostspace.list_tags_for_resource
Main.Repostspace.register_admin
Main.Repostspace.send_invites
Main.Repostspace.tag_resource
Main.Repostspace.untag_resource
Main.Repostspace.update_space
Documentation
Main.Repostspace.create_space
— Methodcreate_space(name, subdomain, tier)
create_space(name, subdomain, tier, params::Dict{String,<:Any})
Creates an AWS re:Post Private private re:Post.
Arguments
name
: The name for the private re:Post. This must be unique in your account.subdomain
: 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.tier
: The pricing tier for the private re:Post.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description for the private re:Post. This is used only to help you identify this private re:Post."roleArn"
: The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets."tags"
: The list of tags associated with the private re:Post."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.
Main.Repostspace.delete_space
— Methoddelete_space(space_id)
delete_space(space_id, params::Dict{String,<:Any})
Deletes an AWS re:Post Private private re:Post.
Arguments
space_id
: The unique ID of the private re:Post.
Main.Repostspace.deregister_admin
— Methodderegister_admin(admin_id, space_id)
deregister_admin(admin_id, space_id, params::Dict{String,<:Any})
Removes the user or group from the list of administrators of the private re:Post.
Arguments
admin_id
: The ID of the admin to remove.space_id
: The ID of the private re:Post to remove the admin from.
Main.Repostspace.get_space
— Methodget_space(space_id)
get_space(space_id, params::Dict{String,<:Any})
Displays information about the AWS re:Post Private private re:Post.
Arguments
space_id
: The ID of the private re:Post.
Main.Repostspace.list_spaces
— Methodlist_spaces()
list_spaces(params::Dict{String,<:Any})
Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of private re:Posts to include in the results."nextToken"
: The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.
Main.Repostspace.list_tags_for_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
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.
Arguments
resource_arn
: The ARN of the resource that the tags are associated with.
Main.Repostspace.register_admin
— Methodregister_admin(admin_id, space_id)
register_admin(admin_id, space_id, params::Dict{String,<:Any})
Adds a user or group to the list of administrators of the private re:Post.
Arguments
admin_id
: The ID of the administrator.space_id
: The ID of the private re:Post.
Main.Repostspace.send_invites
— Methodsend_invites(accessor_ids, body, space_id, title)
send_invites(accessor_ids, body, space_id, title, params::Dict{String,<:Any})
Sends an invitation email to selected users and groups.
Arguments
accessor_ids
: The array of identifiers for the users and groups.body
: The body of the invite.space_id
: The ID of the private re:Post.title
: The title of the invite.
Main.Repostspace.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
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.
Arguments
resource_arn
: The ARN of the resource that the tag is associated with.tags
: 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.
Main.Repostspace.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes the association of the tag with the AWS re:Post Private resource.
Arguments
resource_arn
: The ARN of the resource.tag_keys
: The key values of the tag.
Main.Repostspace.update_space
— Methodupdate_space(space_id)
update_space(space_id, params::Dict{String,<:Any})
Modifies an existing AWS re:Post Private private re:Post.
Arguments
space_id
: The unique ID of this private re:Post.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description for the private re:Post. This is used only to help you identify this private re:Post."roleArn"
: The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets."tier"
: The pricing tier of this private re:Post.