Skip to content

AwsIamAccessKeyDetails

Source code in docs_src/capo_securityhub/types/aws_iam_access_key_details.py
class AwsIamAccessKeyDetails(TypedDict, closed=True):
    user_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The user associated with the IAM access key related to a finding.</p> <p>The <code>UserName</code> parameter has been replaced with the <code>PrincipalName</code> parameter because access keys can also be assigned to principals that are not IAM users.</p>"""
    status: NotRequired[
        "capo_securityhub.types.aws_iam_access_key_status.AwsIamAccessKeyStatus"
    ]
    """<p>The status of the IAM access key related to a finding.</p>"""
    created_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the IAM access key was created.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    principal_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ID of the principal associated with an access key.</p>"""
    principal_type: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The type of principal associated with an access key.</p>"""
    principal_name: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The name of the principal.</p>"""
    account_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The Amazon Web Services account ID of the account for the key.</p>"""
    access_key_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the access key.</p>"""
    session_context: NotRequired[
        "capo_securityhub.types.aws_iam_access_key_session_context.AwsIamAccessKeySessionContext"
    ]
    """<p>Information about the session that the key was used for.</p>"""

access_key_id instance-attribute

access_key_id: NotRequired[NonEmptyString]

The identifier of the access key.

account_id instance-attribute

account_id: NotRequired[NonEmptyString]

The Amazon Web Services account ID of the account for the key.

created_at instance-attribute

created_at: NotRequired[NonEmptyString]

Indicates when the IAM access key was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

principal_id instance-attribute

principal_id: NotRequired[NonEmptyString]

The ID of the principal associated with an access key.

principal_name instance-attribute

principal_name: NotRequired[NonEmptyString]

The name of the principal.

principal_type instance-attribute

principal_type: NotRequired[NonEmptyString]

The type of principal associated with an access key.

session_context instance-attribute

session_context: NotRequired[AwsIamAccessKeySessionContext]

Information about the session that the key was used for.

status instance-attribute

status: NotRequired[AwsIamAccessKeyStatus]

The status of the IAM access key related to a finding.

user_name instance-attribute

user_name: NotRequired[NonEmptyString]

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.