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

get-subject

Description

Gets a subject , which associates a certificate identity with authentication attempts. The subject stores auditing information such as the status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject .

See also: AWS API Documentation

Synopsis

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

--subject-id (string)

The unique identifier of the subject.

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

subject -> (structure)

The state of the subject after a read or write operation.

createdAt -> (timestamp)

The ISO-8601 timestamp when the subject was created.

credentials -> (list)

The temporary session credentials vended at the last authenticating call with this subject.

(structure)

A record of a presented X509 credential from a temporary credential request.

enabled -> (boolean)

Indicates whether the credential is enabled.

failed -> (boolean)

Indicates whether the temporary credential request was successful.

issuer -> (string)

The fully qualified domain name of the issuing certificate for the presented end-entity certificate.

seenAt -> (timestamp)

The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.

serialNumber -> (string)

The serial number of the certificate.

x509CertificateData -> (string)

The PEM-encoded data of the certificate.

enabled -> (boolean)

The enabled status of the subject.

instanceProperties -> (list)

The specified instance properties associated with the request.

(structure)

A key-value pair you set that identifies a property of the authenticating instance.

failed -> (boolean)

Indicates whether the temporary credential request was successful.

properties -> (map)

A list of instanceProperty objects.

key -> (string)

value -> (string)

seenAt -> (timestamp)

The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.

lastSeenAt -> (timestamp)

The ISO-8601 timestamp of the last time this subject requested temporary session credentials.

subjectArn -> (string)

The ARN of the resource.

subjectId -> (string)

The id of the resource

updatedAt -> (timestamp)

The ISO-8601 timestamp when the subject was last updated.

x509Subject -> (string)

The x509 principal identifier of the authenticating certificate.