Network.AWS.IAM.ListServerCertificates

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 AWS services that can use the server certificates that you manage with IAM.

This operation returns paginated results.

Creating a Request

listServerCertificates :: ListServerCertificates

Creates a value of ListServerCertificates with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lscPathPrefix - The path prefix for filtering the results. For example: companyservercerts would get all server certificates for which the path starts with companyservercerts . This parameter is optional. If it is not included, it defaults to a slash (), listing all server certificates. This parameter allows (per its <http:wikipedia.orgwikiregex 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.
• lscMarker - 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.
• lscMaxItems - (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.

data ListServerCertificates

See: listServerCertificates smart constructor.

Instances

Eq ListServerCertificates

Methods

(==) :: ListServerCertificates -> ListServerCertificates -> Bool

(/=) :: ListServerCertificates -> ListServerCertificates -> Bool

Data ListServerCertificates

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListServerCertificates -> c ListServerCertificates

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListServerCertificates

toConstr :: ListServerCertificates -> Constr

dataTypeOf :: ListServerCertificates -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListServerCertificates)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListServerCertificates)

gmapT :: (forall b. Data b => b -> b) -> ListServerCertificates -> ListServerCertificates

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListServerCertificates -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListServerCertificates -> r

gmapQ :: (forall d. Data d => d -> u) -> ListServerCertificates -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListServerCertificates -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListServerCertificates -> m ListServerCertificates

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListServerCertificates -> m ListServerCertificates

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListServerCertificates -> m ListServerCertificates

Read ListServerCertificates

Methods

readsPrec :: Int -> ReadS ListServerCertificates

readList :: ReadS [ListServerCertificates]

readPrec :: ReadPrec ListServerCertificates

readListPrec :: ReadPrec [ListServerCertificates]

Show ListServerCertificates

Methods

showsPrec :: Int -> ListServerCertificates -> ShowS

show :: ListServerCertificates -> String

showList :: [ListServerCertificates] -> ShowS

Generic ListServerCertificates

Associated Types

type Rep ListServerCertificates :: * -> *

Methods

from :: ListServerCertificates -> Rep ListServerCertificates x

to :: Rep ListServerCertificates x -> ListServerCertificates

Hashable ListServerCertificates

Methods

hashWithSalt :: Int -> ListServerCertificates -> Int

hash :: ListServerCertificates -> Int

NFData ListServerCertificates

Methods

rnf :: ListServerCertificates -> ()

AWSPager ListServerCertificates

Methods

page :: ListServerCertificates -> Rs ListServerCertificates -> Maybe ListServerCertificates

AWSRequest ListServerCertificates

Associated Types

type Rs ListServerCertificates :: *

Methods

request :: ListServerCertificates -> Request ListServerCertificates

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListServerCertificates -> ClientResponse -> m (Response ListServerCertificates)

ToHeaders ListServerCertificates

Methods

toHeaders :: ListServerCertificates -> [Header]

ToPath ListServerCertificates

Methods

toPath :: ListServerCertificates -> ByteString

ToQuery ListServerCertificates

Methods

toQuery :: ListServerCertificates -> QueryString

type Rep ListServerCertificates

type Rep ListServerCertificates = D1 * (MetaData "ListServerCertificates" "Network.AWS.IAM.ListServerCertificates" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListServerCertificates'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lscPathPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lscMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lscMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs ListServerCertificates

type Rs ListServerCertificates = ListServerCertificatesResponse

Request Lenses

lscPathPrefix :: Lens' ListServerCertificates (Maybe Text)

The path prefix for filtering the results. For example: companyservercerts would get all server certificates for which the path starts with companyservercerts . This parameter is optional. If it is not included, it defaults to a slash (), listing all server certificates. This parameter allows (per its <http:wikipedia.orgwikiregex 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.

lscMarker :: Lens' ListServerCertificates (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.

lscMaxItems :: Lens' ListServerCertificates (Maybe Natural)

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

Destructuring the Response

listServerCertificatesResponse

Arguments

:: Int

lscrsResponseStatus

-> ListServerCertificatesResponse

Creates a value of ListServerCertificatesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lscrsMarker - When IsTruncated is true , this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.
• lscrsIsTruncated - 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 of your results.
• lscrsResponseStatus - -- | The response status code.
• lscrsServerCertificateMetadataList - A list of server certificates.

data ListServerCertificatesResponse

Contains the response to a successful ListServerCertificates request.

See: listServerCertificatesResponse smart constructor.

Instances

Eq ListServerCertificatesResponse

Methods

(==) :: ListServerCertificatesResponse -> ListServerCertificatesResponse -> Bool

(/=) :: ListServerCertificatesResponse -> ListServerCertificatesResponse -> Bool

Data ListServerCertificatesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListServerCertificatesResponse -> c ListServerCertificatesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListServerCertificatesResponse

toConstr :: ListServerCertificatesResponse -> Constr

dataTypeOf :: ListServerCertificatesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListServerCertificatesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListServerCertificatesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListServerCertificatesResponse -> ListServerCertificatesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListServerCertificatesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListServerCertificatesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListServerCertificatesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListServerCertificatesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListServerCertificatesResponse -> m ListServerCertificatesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListServerCertificatesResponse -> m ListServerCertificatesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListServerCertificatesResponse -> m ListServerCertificatesResponse

Read ListServerCertificatesResponse

Methods

readsPrec :: Int -> ReadS ListServerCertificatesResponse

readList :: ReadS [ListServerCertificatesResponse]

readPrec :: ReadPrec ListServerCertificatesResponse

readListPrec :: ReadPrec [ListServerCertificatesResponse]

Show ListServerCertificatesResponse

Methods

showsPrec :: Int -> ListServerCertificatesResponse -> ShowS

show :: ListServerCertificatesResponse -> String

showList :: [ListServerCertificatesResponse] -> ShowS

Generic ListServerCertificatesResponse

Associated Types

type Rep ListServerCertificatesResponse :: * -> *

Methods

from :: ListServerCertificatesResponse -> Rep ListServerCertificatesResponse x

to :: Rep ListServerCertificatesResponse x -> ListServerCertificatesResponse

NFData ListServerCertificatesResponse

Methods

rnf :: ListServerCertificatesResponse -> ()

type Rep ListServerCertificatesResponse

type Rep ListServerCertificatesResponse = D1 * (MetaData "ListServerCertificatesResponse" "Network.AWS.IAM.ListServerCertificates" "amazonka-iam-1.6.0-CI3f7XZIc4eD0Ehb04tNY7" False) (C1 * (MetaCons "ListServerCertificatesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lscrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lscrsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lscrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_lscrsServerCertificateMetadataList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [ServerCertificateMetadata])))))

Response Lenses

lscrsMarker :: Lens' ListServerCertificatesResponse (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.

lscrsIsTruncated :: Lens' ListServerCertificatesResponse (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 of your results.

lscrsResponseStatus :: Lens' ListServerCertificatesResponse Int

• - | The response status code.

lscrsServerCertificateMetadataList :: Lens' ListServerCertificatesResponse [ServerCertificateMetadata]

A list of server certificates.