Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . identitystore ]

is-member-in-groups

Description

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

Note

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide .

See also: AWS API Documentation

Synopsis

  is-member-in-groups
--identity-store-id <value>
--member-id <value>
--group-ids <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--identity-store-id (string)

The globally unique identifier for the identity store.

--member-id (tagged union structure)

An object containing the identifier of a group member.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: UserId.

UserId -> (string)

An object containing the identifiers of resources that can be members.

Shorthand Syntax:

UserId=string

JSON Syntax:

{
  "UserId": "string"
}

--group-ids (list)

A list of identifiers for groups in the identity store.

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Results -> (list)

A list containing the results of membership existence checks.

(structure)

Indicates whether a resource is a member of a group in the identity store.

GroupId -> (string)

The identifier for a group in the identity store.

MemberId -> (tagged union structure)

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: UserId.

UserId -> (string)

An object containing the identifiers of resources that can be members.

MembershipExists -> (boolean)

Indicates whether a membership relation exists or not.