public class ListSSHPublicKeysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ListSSHPublicKeys operation.
Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.
The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide .
Although each user is limited to a small number of keys, you can still
paginate the results using the MaxItems and
Marker parameters.
NOOP| Constructor and Description |
|---|
ListSSHPublicKeysRequest() |
| Modifier and Type | Method and Description |
|---|---|
ListSSHPublicKeysRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getMarker()
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
Integer |
getMaxItems()
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
String |
getUserName()
The name of the IAM user to list SSH public keys for.
|
int |
hashCode() |
void |
setMarker(String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
void |
setMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
void |
setUserName(String userName)
The name of the IAM user to list SSH public keys for.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListSSHPublicKeysRequest |
withMarker(String marker)
Use this parameter only when paginating results and only after you
receive a response indicating that the results are truncated.
|
ListSSHPublicKeysRequest |
withMaxItems(Integer maxItems)
Use this only when paginating results to indicate the maximum number
of items you want in the response.
|
ListSSHPublicKeysRequest |
withUserName(String userName)
The name of the IAM user to list SSH public keys for.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic String getUserName()
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
public void setUserName(String userName)
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
userName - 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.public ListSSHPublicKeysRequest withUserName(String userName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]+
userName - 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.public String getMarker()
Marker element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
Marker element in the response you
received to inform the next call about where to start.public void setMarker(String marker)
Marker element in the response you
received to inform the next call about where to start.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
marker - 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 you
received to inform the next call about where to start.public ListSSHPublicKeysRequest withMarker(String marker)
Marker element in the response you
received to inform the next call about where to start.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+
marker - 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 you
received to inform the next call about where to start.public Integer getMaxItems()
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
Constraints:
Range: 1 - 1000
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
public void setMaxItems(Integer maxItems)
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
Constraints:
Range: 1 - 1000
maxItems - Use this only when paginating results to indicate the maximum number
of items you want in the response. If there are additional items
beyond the maximum you specify, the IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
public ListSSHPublicKeysRequest withMaxItems(Integer maxItems)
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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 a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
maxItems - Use this only when paginating results to indicate the maximum number
of items you want in the response. If there are additional items
beyond the maximum you specify, the IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100. Note that IAM might return fewer
results, even when there are more results available. If this is the
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.
public String toString()
toString in class ObjectObject.toString()public ListSSHPublicKeysRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2015. All rights reserved.