[ aws . rolesanywhere ]
get-subject¶
Description¶
Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--subject-id (string)
The unique identifier of the subject.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
yaml
yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
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 to CreateSession .
enabled -> (boolean)
Indicates whether the credential is enabled.
failed -> (boolean)
Indicates whether the CreateSession operation 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 CreateSession operation.
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 CreateSession operation 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 CreateSession operation.
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.