get_subject¶

IAMRolesAnywhere.Client.get_subject(**kwargs)¶

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.

Request Syntax

response = client.get_subject(
    subjectId='string'
)

Parameters:

subjectId (string) –

[REQUIRED]

The unique identifier of the subject.

Return type:

dict

Returns:

Response Syntax

{
    'subject': {
        'subjectArn': 'string',
        'subjectId': 'string',
        'enabled': True|False,
        'x509Subject': 'string',
        'lastSeenAt': datetime(2015, 1, 1),
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'credentials': [
            {
                'seenAt': datetime(2015, 1, 1),
                'serialNumber': 'string',
                'issuer': 'string',
                'enabled': True|False,
                'x509CertificateData': 'string',
                'failed': True|False
            },
        ],
        'instanceProperties': [
            {
                'seenAt': datetime(2015, 1, 1),
                'properties': {
                    'string': 'string'
                },
                'failed': True|False
            },
        ]
    }
}

Response Structure

(dict) –
- subject (dict) –
  
  The state of the subject after a read or write operation.
  - subjectArn (string) –
    
    The ARN of the resource.
  - subjectId (string) –
    
    The id of the resource
  - enabled (boolean) –
    
    The enabled status of the subject.
  - x509Subject (string) –
    
    The x509 principal identifier of the authenticating certificate.
  - lastSeenAt (datetime) –
    
    The ISO-8601 timestamp of the last time this subject requested temporary session credentials.
  - createdAt (datetime) –
    
    The ISO-8601 timestamp when the subject was created.
  - updatedAt (datetime) –
    
    The ISO-8601 timestamp when the subject was last updated.
  - credentials (list) –
    
    The temporary session credentials vended at the last authenticating call with this subject.
    - (dict) –
      
      A record of a presented X509 credential from a temporary credential request.
      - seenAt (datetime) –
        
        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.
      - issuer (string) –
        
        The fully qualified domain name of the issuing certificate for the presented end-entity certificate.
      - enabled (boolean) –
        
        Indicates whether the credential is enabled.
      - x509CertificateData (string) –
        
        The PEM-encoded data of the certificate.
      - failed (boolean) –
        
        Indicates whether the temporary credential request was successful.
  - instanceProperties (list) –
    
    The specified instance properties associated with the request.
    - (dict) –
      
      A key-value pair you set that identifies a property of the authenticating instance.
      - seenAt (datetime) –
        
        The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.
      - properties (dict) –
        
        A list of instanceProperty objects.
        
        (string) –
        
        (string) –
      - failed (boolean) –
        
        Indicates whether the temporary credential request was successful.

Exceptions

IAMRolesAnywhere.Client.exceptions.ResourceNotFoundException
IAMRolesAnywhere.Client.exceptions.AccessDeniedException