DeclineInvitations
Note
We recommend using AWS Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the AWS Security Hub User Guide.
Declines invitations to become a Security Hub member account.
A prospective member account uses this operation to decline an invitation to become a member.
Only member accounts that aren't part of an AWS organization should use this operation. Organization accounts don't receive invitations.
Request Syntax
POST /invitations/decline HTTP/1.1
Content-type: application/json
{
"AccountIds": [ "string
" ]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- AccountIds
-
The list of prospective member account IDs for which to decline an invitation.
Type: Array of strings
Pattern:
.*\S.*
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"UnprocessedAccounts": [
{
"AccountId": "string",
"ProcessingResult": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UnprocessedAccounts
-
The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.
Type: Array of Result objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- ResourceNotFoundException
-
The request was rejected because we can't find the specified resource.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: