AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::AwsIamAccessKeyDetails

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AwsIamAccessKeyDetails as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_name: "NonEmptyString",
  status: "Active", # accepts Active, Inactive
  created_at: "NonEmptyString",
  principal_id: "NonEmptyString",
  principal_type: "NonEmptyString",
  principal_name: "NonEmptyString",
  account_id: "NonEmptyString",
  access_key_id: "NonEmptyString",
  session_context: {
    attributes: {
      mfa_authenticated: false,
      creation_date: "NonEmptyString",
    },
    session_issuer: {
      type: "NonEmptyString",
      principal_id: "NonEmptyString",
      arn: "NonEmptyString",
      account_id: "NonEmptyString",
      user_name: "NonEmptyString",
    },
  },
}

IAM access key details related to a finding.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#access_key_idString

The identifier of the access key.

Returns:

  • (String)

    The identifier of the access key.

#account_idString

The AWS account ID of the account for the key.

Returns:

  • (String)

    The AWS account ID of the account for the key.

#created_atString

Indicates when the IAM access key was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String)

    Indicates when the IAM access key was created.

#principal_idString

The ID of the principal associated with an access key.

Returns:

  • (String)

    The ID of the principal associated with an access key.

#principal_nameString

The name of the principal.

Returns:

  • (String)

    The name of the principal.

#principal_typeString

The type of principal associated with an access key.

Returns:

  • (String)

    The type of principal associated with an access key.

#session_contextTypes::AwsIamAccessKeySessionContext

Information about the session that the key was used for.

Returns:

#statusString

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

Possible values:

  • Active
  • Inactive

Returns:

  • (String)

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

#user_nameString

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.

Returns:

  • (String)

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