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

Class: Aws::IAM::Types::AccessKey

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

Instance Attribute Summary collapse

Instance Attribute Details

#access_key_idString

The ID for this access key.

Returns:

  • (String)


46
47
48
49
50
51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 46

class AccessKey < Struct.new(
  :user_name,
  :access_key_id,
  :status,
  :secret_access_key,
  :create_date)
  include Aws::Structure
end

#create_dateTime

The date when the access key was created.

Returns:

  • (Time)


46
47
48
49
50
51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 46

class AccessKey < Struct.new(
  :user_name,
  :access_key_id,
  :status,
  :secret_access_key,
  :create_date)
  include Aws::Structure
end

#secret_access_keyString

The secret key used to sign requests.

Returns:

  • (String)


46
47
48
49
50
51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 46

class AccessKey < Struct.new(
  :user_name,
  :access_key_id,
  :status,
  :secret_access_key,
  :create_date)
  include Aws::Structure
end

#statusString

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

Returns:

  • (String)


46
47
48
49
50
51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 46

class AccessKey < Struct.new(
  :user_name,
  :access_key_id,
  :status,
  :secret_access_key,
  :create_date)
  include Aws::Structure
end

#user_nameString

The name of the IAM user that the access key is associated with.

Returns:

  • (String)


46
47
48
49
50
51
52
53
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 46

class AccessKey < Struct.new(
  :user_name,
  :access_key_id,
  :status,
  :secret_access_key,
  :create_date)
  include Aws::Structure
end