AWS Documentation » AWS Identity and Access Management » IAM API Reference » Actions » ListServerCertificates	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

ListServerCertificates

Description

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.

Request Parameters

For information about the common parameters that all actions use, see Common Parameters.

Marker

Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.

Type: String

Length constraints: Minimum length of 1. Maximum length of 320.

Required: No

MaxItems

Use this only when paginating results to indicate the maximum number of server certificates you want in the response. If there are additional server certificates beyond the maximum you specify, the IsTruncated response element will be set to true. This parameter is optional. If you do not include it, it defaults to 100.

Type: Integer

Required: No

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.

Type: String

Length constraints: Minimum length of 1. Maximum length of 512.

Required: No

Response Elements

The following elements are returned in a ListServerCertificatesResult structure.

IsTruncated

A flag that indicates whether there are more server certificates to list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more server certificates in the list.

Type: Boolean

Marker

If IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

Type: String

ServerCertificateMetadataList

A list of server certificates.

Type: ServerCertificateMetadata list

Examples

Sample Request

https://iam.amazonaws.com/
?Action=ListServerCertificates
&PathPrefix=/company/servercerts
&Version=2010-05-08
&AUTHPARAMS

Sample Response

<ListServerCertificatesResponse>
  <ListServerCertificatesResult>
    <IsTruncated>false</IsTruncated>
    <ServerCertificateMetadataList>
      <member>
        <ServerCertificateMetadata>
          <ServerCertificateName>ProdServerCert</ServerCertificateName>
          <Path>/company/servercerts/</Path>
          <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert</Arn>
          <UploadDate>2010-05-08T01:02:03.004Z</UploadDate>
          <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE1</ServerCertificateId>
        </ServerCertificateMetadata>
      </member>
      <member>
        <ServerCertificateMetadata>
          <ServerCertificateName>BetaServerCert</ServerCertificateName>
          <Path>/company/servercerts/</Path>
          <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert</Arn>
          <UploadDate>2010-05-08T02:03:01.004Z</UploadDate>
          <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE2</ServerCertificateId>
        </ServerCertificateMetadata>
      </member>
      <member>
        <ServerCertificateMetadata>
          <ServerCertificateName>TestServerCert</ServerCertificateName>
          <Path>/company/servercerts/</Path>
          <Arn>arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert</Arn>
          <UploadDate>2010-05-08T03:01:02.004Z</UploadDate>
          <ServerCertificateId>ASCACKCEVSQ6CEXAMPLE3</ServerCertificateId>
        </ServerCertificateMetadata>
      </member>
    </ServerCertificateMetadataList>
  </ListServerCertificatesResult>
  <ResponseMetadata>
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
  </ResponseMetadata>
</ListServerCertificatesResponse>

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...