{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.IAM.ListServerCertificates -- Copyright : (c) 2013-2017 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Lists the server certificates stored in IAM 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 in the /IAM User Guide/ . -- -- -- This operation returns paginated results. module Network.AWS.IAM.ListServerCertificates ( -- * Creating a Request listServerCertificates , ListServerCertificates -- * Request Lenses , lscPathPrefix , lscMarker , lscMaxItems -- * Destructuring the Response , listServerCertificatesResponse , ListServerCertificatesResponse -- * Response Lenses , lscrsMarker , lscrsIsTruncated , lscrsResponseStatus , lscrsServerCertificateMetadataList ) where import Network.AWS.IAM.Types import Network.AWS.IAM.Types.Product import Network.AWS.Lens import Network.AWS.Pager import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | /See:/ 'listServerCertificates' smart constructor. data ListServerCertificates = ListServerCertificates' { _lscPathPrefix :: !(Maybe Text) , _lscMarker :: !(Maybe Text) , _lscMaxItems :: !(Maybe Nat) } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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: @/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 paramater allows (per its ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru 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. listServerCertificates :: ListServerCertificates listServerCertificates = ListServerCertificates' {_lscPathPrefix = Nothing, _lscMarker = Nothing, _lscMaxItems = Nothing} -- | 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 paramater allows (per its ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\u0021) thru the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. lscPathPrefix :: Lens' ListServerCertificates (Maybe Text) lscPathPrefix = lens _lscPathPrefix (\ s a -> s{_lscPathPrefix = a}); -- | 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. lscMarker :: Lens' ListServerCertificates (Maybe Text) lscMarker = lens _lscMarker (\ s a -> s{_lscMarker = a}); -- | (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. lscMaxItems :: Lens' ListServerCertificates (Maybe Natural) lscMaxItems = lens _lscMaxItems (\ s a -> s{_lscMaxItems = a}) . mapping _Nat; instance AWSPager ListServerCertificates where page rq rs | stop (rs ^. lscrsIsTruncated) = Nothing | isNothing (rs ^. lscrsMarker) = Nothing | otherwise = Just $ rq & lscMarker .~ rs ^. lscrsMarker instance AWSRequest ListServerCertificates where type Rs ListServerCertificates = ListServerCertificatesResponse request = postQuery iam response = receiveXMLWrapper "ListServerCertificatesResult" (\ s h x -> ListServerCertificatesResponse' <$> (x .@? "Marker") <*> (x .@? "IsTruncated") <*> (pure (fromEnum s)) <*> (x .@? "ServerCertificateMetadataList" .!@ mempty >>= parseXMLList "member")) instance Hashable ListServerCertificates where instance NFData ListServerCertificates where instance ToHeaders ListServerCertificates where toHeaders = const mempty instance ToPath ListServerCertificates where toPath = const "/" instance ToQuery ListServerCertificates where toQuery ListServerCertificates'{..} = mconcat ["Action" =: ("ListServerCertificates" :: ByteString), "Version" =: ("2010-05-08" :: ByteString), "PathPrefix" =: _lscPathPrefix, "Marker" =: _lscMarker, "MaxItems" =: _lscMaxItems] -- | Contains the response to a successful 'ListServerCertificates' request. -- -- -- -- /See:/ 'listServerCertificatesResponse' smart constructor. data ListServerCertificatesResponse = ListServerCertificatesResponse' { _lscrsMarker :: !(Maybe Text) , _lscrsIsTruncated :: !(Maybe Bool) , _lscrsResponseStatus :: !Int , _lscrsServerCertificateMetadataList :: ![ServerCertificateMetadata] } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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. listServerCertificatesResponse :: Int -- ^ 'lscrsResponseStatus' -> ListServerCertificatesResponse listServerCertificatesResponse pResponseStatus_ = ListServerCertificatesResponse' { _lscrsMarker = Nothing , _lscrsIsTruncated = Nothing , _lscrsResponseStatus = pResponseStatus_ , _lscrsServerCertificateMetadataList = mempty } -- | When @IsTruncated@ is @true@ , this element is present and contains the value to use for the @Marker@ parameter in a subsequent pagination request. lscrsMarker :: Lens' ListServerCertificatesResponse (Maybe Text) lscrsMarker = lens _lscrsMarker (\ s a -> s{_lscrsMarker = a}); -- | 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. lscrsIsTruncated :: Lens' ListServerCertificatesResponse (Maybe Bool) lscrsIsTruncated = lens _lscrsIsTruncated (\ s a -> s{_lscrsIsTruncated = a}); -- | -- | The response status code. lscrsResponseStatus :: Lens' ListServerCertificatesResponse Int lscrsResponseStatus = lens _lscrsResponseStatus (\ s a -> s{_lscrsResponseStatus = a}); -- | A list of server certificates. lscrsServerCertificateMetadataList :: Lens' ListServerCertificatesResponse [ServerCertificateMetadata] lscrsServerCertificateMetadataList = lens _lscrsServerCertificateMetadataList (\ s a -> s{_lscrsServerCertificateMetadataList = a}) . _Coerce; instance NFData ListServerCertificatesResponse where