- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeclineInvitationsCommand
Declines Amazon Macie membership invitations that were received from specific accounts.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { Macie2Client, DeclineInvitationsCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, DeclineInvitationsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // DeclineInvitationsRequest
accountIds: [ // __listOf__string // required
"STRING_VALUE",
],
};
const command = new DeclineInvitationsCommand(input);
const response = await client.send(command);
// { // DeclineInvitationsResponse
// unprocessedAccounts: [ // __listOfUnprocessedAccount
// { // UnprocessedAccount
// accountId: "STRING_VALUE",
// errorCode: "ClientError" || "InternalError",
// errorMessage: "STRING_VALUE",
// },
// ],
// };
DeclineInvitationsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
accountIdsRequired | string[] | undefined | An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline. |
DeclineInvitationsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
unprocessedAccounts | UnprocessedAccount[] | undefined | An array of objects, one for each account whose invitation hasn't been declined. Each object identifies the account and explains why the request hasn't been processed for that account. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Provides information about an error that occurred due to insufficient access to a specified resource. |
| ConflictException | client | Provides information about an error that occurred due to a versioning conflict for a specified resource. |
| InternalServerException | server | Provides information about an error that occurred due to an unknown internal server error, exception, or failure. |
| ResourceNotFoundException | client | Provides information about an error that occurred because a specified resource wasn't found. |
| ServiceQuotaExceededException | client | Provides information about an error that occurred due to one or more service quotas for an account. |
| ThrottlingException | client | Provides information about an error that occurred because too many requests were sent during a certain amount of time. |
| ValidationException | client | Provides information about an error that occurred due to a syntax error in a request. |
| Macie2ServiceException | Base exception class for all service exceptions from Macie2 service. |