Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an Error is returned.
This operation returns paginated results.
Synopsis
- data DescribeSenderIds = DescribeSenderIds' {}
- newDescribeSenderIds :: DescribeSenderIds
- describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter])
- describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural)
- describeSenderIds_nextToken :: Lens' DescribeSenderIds (Maybe Text)
- describeSenderIds_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry])
- data DescribeSenderIdsResponse = DescribeSenderIdsResponse' {
- nextToken :: Maybe Text
- senderIds :: Maybe [SenderIdInformation]
- httpStatus :: Int
- newDescribeSenderIdsResponse :: Int -> DescribeSenderIdsResponse
- describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (Maybe Text)
- describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation])
- describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int
Creating a Request
data DescribeSenderIds Source #
See: newDescribeSenderIds
smart constructor.
DescribeSenderIds' | |
|
Instances
newDescribeSenderIds :: DescribeSenderIds Source #
Create a value of DescribeSenderIds
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:filters:DescribeSenderIds'
, describeSenderIds_filters
- An array of SenderIdFilter objects to filter the results.
$sel:maxResults:DescribeSenderIds'
, describeSenderIds_maxResults
- The maximum number of results to return per each request.
DescribeSenderIds
, describeSenderIds_nextToken
- The token to be used for the next set of paginated results. You don't
need to supply a value for this field in the initial request.
DescribeSenderIds
, describeSenderIds_senderIds
- An array of SenderIdAndCountry objects to search for.
Request Lenses
describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter]) Source #
An array of SenderIdFilter objects to filter the results.
describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural) Source #
The maximum number of results to return per each request.
describeSenderIds_nextToken :: Lens' DescribeSenderIds (Maybe Text) Source #
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
describeSenderIds_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry]) Source #
An array of SenderIdAndCountry objects to search for.
Destructuring the Response
data DescribeSenderIdsResponse Source #
See: newDescribeSenderIdsResponse
smart constructor.
DescribeSenderIdsResponse' | |
|
Instances
newDescribeSenderIdsResponse Source #
Create a value of DescribeSenderIdsResponse
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:
DescribeSenderIds
, describeSenderIdsResponse_nextToken
- The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
DescribeSenderIds
, describeSenderIdsResponse_senderIds
- An array of SernderIdInformation objects that contain the details for
the requested SenderIds.
$sel:httpStatus:DescribeSenderIdsResponse'
, describeSenderIdsResponse_httpStatus
- The response's http status code.
Response Lenses
describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (Maybe Text) Source #
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation]) Source #
An array of SernderIdInformation objects that contain the details for the requested SenderIds.
describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int Source #
The response's http status code.