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 . security-ir ]

update-membership

Description

Updates membership configuration.

See also: AWS API Documentation

Synopsis

  update-membership
--membership-id <value>
[--membership-name <value>]
[--incident-response-team <value>]
[--opt-in-features <value>]
[--membership-accounts-configurations-update <value>]
[--undo-membership-cancellation | --no-undo-membership-cancellation]
[--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

--membership-id (string)

Required element for UpdateMembership to identify the membership to update.

--membership-name (string)

Optional element for UpdateMembership to update the membership name.

--incident-response-team (list)

Optional element for UpdateMembership to update the membership name.

(structure)

name -> (string)

jobTitle -> (string)

email -> (string)

Shorthand Syntax:

name=string,jobTitle=string,email=string ...

JSON Syntax:

[
  {
    "name": "string",
    "jobTitle": "string",
    "email": "string"
  }
  ...
]

--opt-in-features (list)

Optional element for UpdateMembership to enable or disable opt-in features for the service.

(structure)

featureName -> (string)

isEnabled -> (boolean)

Shorthand Syntax:

featureName=string,isEnabled=boolean ...

JSON Syntax:

[
  {
    "featureName": "Triage",
    "isEnabled": true|false
  }
  ...
]

--membership-accounts-configurations-update (structure)

The membershipAccountsConfigurationsUpdate field in the UpdateMembershipRequest structure allows you to update the configuration settings for accounts within a membership.

This field is optional and contains a structure of type MembershipAccountsConfigurationsUpdate that specifies the updated account configurations for the membership.

coverEntireOrganization -> (boolean)

The coverEntireOrganization field is a boolean value that determines whether the membership configuration should be applied across the entire Amazon Web Services Organization.

When set to true , the configuration will be applied to all accounts within the organization. When set to false , the configuration will only apply to specifically designated accounts.

organizationalUnitsToAdd -> (list)

A list of organizational unit IDs to add to the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32} .

The list must contain between 1 and 5 organizational unit IDs.

(string)

organizationalUnitsToRemove -> (list)

A list of organizational unit IDs to remove from the membership configuration. Each organizational unit ID must match the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32} .

The list must contain between 1 and 5 organizational unit IDs per invocation of the API request.

(string)

Shorthand Syntax:

coverEntireOrganization=boolean,organizationalUnitsToAdd=string,string,organizationalUnitsToRemove=string,string

JSON Syntax:

{
  "coverEntireOrganization": true|false,
  "organizationalUnitsToAdd": ["string", ...],
  "organizationalUnitsToRemove": ["string", ...]
}

--undo-membership-cancellation | --no-undo-membership-cancellation (boolean)

The undoMembershipCancellation parameter is a boolean flag that indicates whether to reverse a previously requested membership cancellation. When set to true, this will revoke the cancellation request and maintain the membership status.

This parameter is optional and can be used in scenarios where you need to restore a membership that was marked for cancellation but hasn’t been fully terminated yet.

• If set to true , the cancellation request will be revoked
• If set to false the service will throw a ValidationException.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

None