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

Class: Aws::IAM::Types::ListSSHPublicKeysRequest

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 ListSSHPublicKeysRequest data as a hash:

{
  user_name: "userNameType",
  marker: "markerType",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#markerString

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

Returns:

  • (String)


5256
5257
5258
5259
5260
5261
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5256

class ListSSHPublicKeysRequest < Struct.new(
  :user_name,
  :marker,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Returns:

  • (Integer)


5256
5257
5258
5259
5260
5261
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5256

class ListSSHPublicKeysRequest < Struct.new(
  :user_name,
  :marker,
  :max_items)
  include Aws::Structure
end

#user_nameString

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.

This parameter allows (per 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)


5256
5257
5258
5259
5260
5261
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 5256

class ListSSHPublicKeysRequest < Struct.new(
  :user_name,
  :marker,
  :max_items)
  include Aws::Structure
end