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

describe-workspace-authentication

Description

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

See also: AWS API Documentation

Synopsis

  describe-workspace-authentication
--workspace-id <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

--workspace-id (string)

The ID of the workspace to return authentication information about.

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

authentication -> (structure)

A structure containing information about the authentication methods used in the workspace.

awsSso -> (structure)

A structure containing information about how this workspace works with IAM Identity Center.

ssoClientId -> (string)

The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.

providers -> (list)

Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.

(string)

saml -> (structure)

A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.

configuration -> (structure)

A structure containing details about how this workspace works with SAML.

allowedOrganizations -> (list)

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

(string)

assertionAttributes -> (structure)

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

email -> (string)

The name of the attribute within the SAML assertion to use as the email names for SAML users.

groups -> (string)

The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.

login -> (string)

The name of the attribute within the SAML assertion to use as the login names for SAML users.

name -> (string)

The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.

org -> (string)

The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.

role -> (string)

The name of the attribute within the SAML assertion to use as the user roles.

idpMetadata -> (tagged union structure)

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

Note

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

url -> (string)

The URL of the location containing the IdP metadata.

xml -> (string)

The full IdP metadata, in XML format.

loginValidityDuration -> (integer)

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

roleValues -> (structure)

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

admin -> (list)

A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.

(string)

editor -> (list)

A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.

(string)

status -> (string)

Specifies whether the workspace's SAML configuration is complete.