CreateMembersCommand

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new organization accounts.

  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations don't receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

  • For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Example Syntax

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

import { SecurityHubClient, CreateMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, CreateMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // CreateMembersRequest
  AccountDetails: [ // AccountDetailsList // required
    { // AccountDetails
      AccountId: "STRING_VALUE", // required
      Email: "STRING_VALUE",
    },
  ],
};
const command = new CreateMembersCommand(input);
const response = await client.send(command);
// { // CreateMembersResponse
//   UnprocessedAccounts: [ // ResultList
//     { // Result
//       AccountId: "STRING_VALUE",
//       ProcessingResult: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

 There was an error loading the code editor. Retry

CreateMembersCommand Input

See CreateMembersCommandInput for more details

Parameter
Type
Description
AccountDetails
Required
AccountDetails[] | undefined

The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

CreateMembersCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
UnprocessedAccounts
Result[] | undefined

The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permission to perform the action specified in the request.

InternalException
server

Internal server error.

InvalidAccessException
client

The account doesn't have permission to perform this action.

InvalidInputException
client

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException
client

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

ResourceConflictException
client

The resource specified in the request conflicts with an existing resource.

SecurityHubServiceException
Base exception class for all service exceptions from SecurityHub service.