SendInvitesCommand

Sends an invitation email to selected users and groups.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RepostspaceClient, SendInvitesCommand } from "@aws-sdk/client-repostspace"; // ES Modules import
// const { RepostspaceClient, SendInvitesCommand } = require("@aws-sdk/client-repostspace"); // CommonJS import
const client = new RepostspaceClient(config);
const input = { // SendInvitesInput
  spaceId: "STRING_VALUE", // required
  accessorIds: [ // AccessorIdList // required
    "STRING_VALUE",
  ],
  title: "STRING_VALUE", // required
  body: "STRING_VALUE", // required
};
const command = new SendInvitesCommand(input);
const response = await client.send(command);
// {};

SendInvitesCommand Input

See SendInvitesCommandInput for more details

Parameter
Type
Description
accessorIds
Required
string[] | undefined

The array of identifiers for the users and groups.

body
Required
string | undefined

The body of the invite.

spaceId
Required
string | undefined

The ID of the private re:Post.

title
Required
string | undefined

The title of the invite.

SendInvitesCommand Output

See SendInvitesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have sufficient access to perform this action.

InternalServerException
server

Unexpected error during processing of request.

ResourceNotFoundException
client

Request references a resource which does not exist.

ThrottlingException
client

Request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an AWS service.

RepostspaceServiceException
Base exception class for all service exceptions from Repostspace service.