libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.ListServerCertificates

Description

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

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

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a servercertificate, see GetServerCertificate.

This operation returns paginated results.

Synopsis

Creating a Request

data ListServerCertificates Source #

See: newListServerCertificates smart constructor.

Constructors

ListServerCertificates' 

Fields

  • pathPrefix :: Maybe Text

    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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

  • marker :: Maybe Text

    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.

  • maxItems :: Maybe Natural

    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, the number of items 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.

Instances

Instances details
Eq ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Read ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Show ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Generic ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Associated Types

type Rep ListServerCertificates :: Type -> Type #

NFData ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Methods

rnf :: ListServerCertificates -> () #

Hashable ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

AWSPager ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

AWSRequest ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Associated Types

type AWSResponse ListServerCertificates #

ToHeaders ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

ToPath ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

ToQuery ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

type Rep ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

type Rep ListServerCertificates = D1 ('MetaData "ListServerCertificates" "Amazonka.IAM.ListServerCertificates" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListServerCertificates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pathPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListServerCertificates Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

newListServerCertificates :: ListServerCertificates Source #

Create a value of ListServerCertificates with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pathPrefix:ListServerCertificates', listServerCertificates_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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

$sel:marker:ListServerCertificates', listServerCertificates_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.

$sel:maxItems:ListServerCertificates', listServerCertificates_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.

If you do not include this parameter, the number of items 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.

Request Lenses

listServerCertificates_pathPrefix :: Lens' ListServerCertificates (Maybe Text) Source #

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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

listServerCertificates_marker :: Lens' ListServerCertificates (Maybe Text) Source #

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.

listServerCertificates_maxItems :: Lens' ListServerCertificates (Maybe Natural) Source #

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, the number of items 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.

Destructuring the Response

data ListServerCertificatesResponse Source #

Contains the response to a successful ListServerCertificates request.

See: newListServerCertificatesResponse smart constructor.

Constructors

ListServerCertificatesResponse' 

Fields

  • marker :: Maybe Text

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

  • isTruncated :: Maybe Bool

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • httpStatus :: Int

    The response's http status code.

  • serverCertificateMetadataList :: [ServerCertificateMetadata]

    A list of server certificates.

Instances

Instances details
Eq ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Read ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Show ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Generic ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

Associated Types

type Rep ListServerCertificatesResponse :: Type -> Type #

NFData ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

type Rep ListServerCertificatesResponse Source # 
Instance details

Defined in Amazonka.IAM.ListServerCertificates

type Rep ListServerCertificatesResponse = D1 ('MetaData "ListServerCertificatesResponse" "Amazonka.IAM.ListServerCertificates" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "ListServerCertificatesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "serverCertificateMetadataList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ServerCertificateMetadata]))))

newListServerCertificatesResponse Source #

Create a value of ListServerCertificatesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:marker:ListServerCertificates', listServerCertificatesResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:isTruncated:ListServerCertificatesResponse', listServerCertificatesResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

$sel:httpStatus:ListServerCertificatesResponse', listServerCertificatesResponse_httpStatus - The response's http status code.

$sel:serverCertificateMetadataList:ListServerCertificatesResponse', listServerCertificatesResponse_serverCertificateMetadataList - A list of server certificates.

Response Lenses

listServerCertificatesResponse_marker :: Lens' ListServerCertificatesResponse (Maybe Text) Source #

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

listServerCertificatesResponse_isTruncated :: Lens' ListServerCertificatesResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.