create-members¶

Description¶

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account IDs. This step is a prerequisite for managing the associated member accounts either by invitation or through an organization.

When using Create Members as an organizations delegated administrator this action will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account, which must enable GuardDuty prior to being added as a member.

If you are adding accounts by invitation use this action after GuardDuty has been enabled in potential member accounts and before using ` Invite Members https://docs.aws.amazon.com/guardduty/latest/APIReference/API_InviteMembers.html`__ .

Synopsis¶

  create-members
--detector-id <value>
--account-details <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--detector-id (string)

The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

--account-details (list)

A list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.

(structure)

Contains information about the account.

AccountId -> (string)

The member account ID.

Email -> (string)

The email address of the member account.

Shorthand Syntax:

AccountId=string,Email=string ...

JSON Syntax:

[
  {
    "AccountId": "string",
    "Email": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To associate a new member with your GuardDuty master account in the current region.

This example shows how to associate member accounts to be managed by the current account as the GuardDuty master.

aws guardduty create-members
    --detector-id b6b992d6d2f48e64bc59180bfexample \
    --account-details AccountId=111122223333,Email=first+member@example.com AccountId=111111111111 ,Email=another+member@example.com

Output:

{
   "UnprocessedAccounts": []
}

For more information, see Managing multiple accounts in the GuardDuty User Guide.

Output¶

UnprocessedAccounts -> (list)

A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

(structure)

Contains information about the accounts that weren’t processed.

AccountId -> (string)

The Amazon Web Services account ID.

Result -> (string)

A reason why the account hasn’t been processed.

Table of Contents

Feedback

User Guide