com.amazonaws.services.identitymanagement.model

Class ListServerCertificatesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.ListServerCertificatesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListServerCertificatesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListServerCertificates operation.

Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide .

See Also:

AmazonIdentityManagement.listServerCertificates(ListServerCertificatesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListServerCertificatesRequest() Default constructor for a new ListServerCertificatesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
ListServerCertificatesRequest	clone()
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	getPathPrefix() The path prefix for filtering the results.
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	setPathPrefix(String pathPrefix) The path prefix for filtering the results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListServerCertificatesRequest	withMarker(String marker) Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated.
ListServerCertificatesRequest	withMaxItems(Integer maxItems) Use this only when paginating results to indicate the maximum number of items you want in the response.
ListServerCertificatesRequest	withPathPrefix(String pathPrefix) The path prefix for filtering the results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListServerCertificatesRequest

public ListServerCertificatesRequest()

Default constructor for a new ListServerCertificatesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getPathPrefix

public String getPathPrefix()

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*

Returns:

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

setPathPrefix

public void setPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*

Parameters:

pathPrefix - The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

withPathPrefix

public ListServerCertificatesRequest withPathPrefix(String pathPrefix)

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*

Parameters:

pathPrefix - The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

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.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Returns:

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.

setMarker

public void setMarker(String 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 that you received to indicate where the next call should start.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Parameters:

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 that you received to indicate where the next call should start.

withMarker

public ListServerCertificatesRequest withMarker(String 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 that you received to indicate where the next call should start.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]+

Parameters:

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 that you received to indicate where the next call should start.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxItems

public Integer getMaxItems()

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.

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. 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.

Constraints:
Range: 1 - 1000

Returns:

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.

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. 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.

setMaxItems

public void setMaxItems(Integer maxItems)

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.

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. 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.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - 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.

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. 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.

withMaxItems

public ListServerCertificatesRequest withMaxItems(Integer maxItems)

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.

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. 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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1000

Parameters:

maxItems - 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.

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. 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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListServerCertificatesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest