Class: AWS.Repostspace

var params = {
  spaceId: 'STRING_VALUE' /* required */
};
repostspace.deleteSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceId — (String)

    The unique ID of the private re:Post.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  adminId: 'STRING_VALUE', /* required */
  spaceId: 'STRING_VALUE' /* required */
};
repostspace.deregisterAdmin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • adminId — (String)

    The ID of the admin to remove.

  • spaceId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  spaceId: 'STRING_VALUE' /* required */
};
repostspace.getSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • spaceId — (String)

    The ID of the private re:Post.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "CONFIGURED"
      • "UNCONFIGURED"
    • contentSize — (Integer)

      The content size of the private re:Post.

    • createDateTime — (Date)

      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 — (Date)

      The date when the private re:Post was deleted.

    • description — (String)

      The description of the private re:Post.

    • groupAdmins — (Array<String>)

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

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

      Possible values include:
      • "BASIC"
      • "STANDARD"
    • userAdmins — (Array<String>)

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

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

      Possible values include:
      • "PENDING"
      • "APPROVED"
      • "UNAPPROVED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
repostspace.listSpaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The token that you use when you request the next set of private re:Posts.

    • spaces — (Array<map>)

      An array of structures that contain some information about the private re:Posts in the account.

      • arn — required — (String)

        The ARN of the private re:Post.

      • configurationStatus — required — (String)

        The configuration status of the private re:Post.

        Possible values include:
        • "CONFIGURED"
        • "UNCONFIGURED"
      • contentSize — (Integer)

        The content size of the private re:Post.

      • createDateTime — required — (Date)

        The date when the private re:Post was created.

      • deleteDateTime — (Date)

        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 — required — (String)

        The name for the private re:Post.

      • randomDomain — required — (String)

        The AWS generated subdomain of the private re:Post.

      • spaceId — required — (String)

        The unique ID of the private re:Post.

      • status — required — (String)

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

      • storageLimit — required — (Integer)

        The storage limit of the private re:Post.

      • tier — required — (String)

        The pricing tier of the private re:Post.

        Possible values include:
        • "BASIC"
        • "STANDARD"
      • 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 — required — (String)

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

      • vanityDomainStatus — required — (String)

        This approval status of the custom subdomain.

        Possible values include:
        • "PENDING"
        • "APPROVED"
        • "UNAPPROVED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
repostspace.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The list of tags that are associated with the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  adminId: 'STRING_VALUE', /* required */
  spaceId: 'STRING_VALUE' /* required */
};
repostspace.registerAdmin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • adminId — (String)

    The ID of the administrator.

  • spaceId — (String)

    The ID of the private re:Post.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  accessorIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  body: 'STRING_VALUE', /* required */
  spaceId: 'STRING_VALUE', /* required */
  title: 'STRING_VALUE' /* required */
};
repostspace.sendInvites(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • accessorIds — (Array<String>)

    The array of identifiers for the users and groups.

  • body — (String)

    The body of the invite.

  • spaceId — (String)

    The ID of the private re:Post.

  • title — (String)

    The title of the invite.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
repostspace.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

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

  • tags — (map<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
repostspace.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource.

  • tagKeys — (Array<String>)

    The key values of the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  spaceId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  tier: BASIC | STANDARD
};
repostspace.updateSpace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

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

  • roleArn — (String)

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

  • spaceId — (String)

    The unique ID of this private re:Post.

  • tier — (String)

    The pricing tier of this private re:Post.

    Possible values include:
    • "BASIC"
    • "STANDARD"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.