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

Class: Aws::IAM::Types::UpdateAccessKeyRequest

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

Overview

Note:

When making an API call, you may pass UpdateAccessKeyRequest data as a hash:

{
  user_name: "existingUserNameType",
  access_key_id: "accessKeyIdType", # required
  status: "Active", # required, accepts Active, Inactive
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_key_idString

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

  • (String)


10034
10035
10036
10037
10038
10039
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10034

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

#statusString

The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

Returns:

  • (String)


10034
10035
10036
10037
10038
10039
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10034

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

#user_nameString

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:

  • (String)


10034
10035
10036
10037
10038
10039
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10034

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