AWS CLI Command Reference

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 . opensearchserverless ]

update-security-config

Description

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless .

See also: AWS API Documentation

Synopsis

  update-security-config
[--client-token <value>]
--config-version <value>
[--description <value>]
[--iam-identity-center-options-updates <value>]
--id <value>
[--saml-options <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

--client-token (string)

Unique, case-sensitive identifier to ensure idempotency of the request.

--config-version (string)

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

--description (string)

A description of the security configuration.

--iam-identity-center-options-updates (structure)

Describes IAM Identity Center options in the form of a key-value map.

groupAttribute -> (string)

The group attribute for this IAM Identity Center integration. Defaults to GroupId .

userAttribute -> (string)

The user attribute for this IAM Identity Center integration. Defaults to UserId .

Shorthand Syntax:

groupAttribute=string,userAttribute=string

JSON Syntax:

{
  "groupAttribute": "GroupId"|"GroupName",
  "userAttribute": "UserId"|"UserName"|"Email"
}

--id (string)

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName> . For example, saml/123456789123/OKTADev .

--saml-options (structure)

SAML options in in the form of a key-value map.

groupAttribute -> (string)

The group attribute for this SAML integration.

metadata -> (string)

The XML IdP metadata file generated from your identity provider.

sessionTimeout -> (integer)

The session timeout, in minutes. Default is 60 minutes (12 hours).

userAttribute -> (string)

A user attribute for this SAML integration.

Shorthand Syntax:

groupAttribute=string,metadata=string,sessionTimeout=integer,userAttribute=string

JSON Syntax:

{
  "groupAttribute": "string",
  "metadata": "string",
  "sessionTimeout": integer,
  "userAttribute": "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. 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

securityConfigDetail -> (structure)

Details about the updated security configuration.

configVersion -> (string)

The version of the security configuration.

createdDate -> (long)

The date the configuration was created.

description -> (string)

The description of the security configuration.

iamIdentityCenterOptions -> (structure)

Describes IAM Identity Center options in the form of a key-value map.

applicationArn -> (string)

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

applicationDescription -> (string)

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

applicationName -> (string)

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

groupAttribute -> (string)

The group attribute for this IAM Identity Center integration. Defaults to GroupId .

instanceArn -> (string)

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

userAttribute -> (string)

The user attribute for this IAM Identity Center integration. Defaults to UserId

id -> (string)

The unique identifier of the security configuration.

lastModifiedDate -> (long)

The timestamp of when the configuration was last modified.

samlOptions -> (structure)

SAML options for the security configuration in the form of a key-value map.

groupAttribute -> (string)

The group attribute for this SAML integration.

metadata -> (string)

The XML IdP metadata file generated from your identity provider.

sessionTimeout -> (integer)

The session timeout, in minutes. Default is 60 minutes (12 hours).

userAttribute -> (string)

A user attribute for this SAML integration.

type -> (string)

The type of security configuration.