| 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 |
Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists
Description
Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an Error is returned.
This operation returns paginated results.
Synopsis
- data DescribeOptOutLists = DescribeOptOutLists' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- optOutListNames :: Maybe [Text]
- newDescribeOptOutLists :: DescribeOptOutLists
- describeOptOutLists_maxResults :: Lens' DescribeOptOutLists (Maybe Natural)
- describeOptOutLists_nextToken :: Lens' DescribeOptOutLists (Maybe Text)
- describeOptOutLists_optOutListNames :: Lens' DescribeOptOutLists (Maybe [Text])
- data DescribeOptOutListsResponse = DescribeOptOutListsResponse' {}
- newDescribeOptOutListsResponse :: Int -> DescribeOptOutListsResponse
- describeOptOutListsResponse_nextToken :: Lens' DescribeOptOutListsResponse (Maybe Text)
- describeOptOutListsResponse_optOutLists :: Lens' DescribeOptOutListsResponse (Maybe [OptOutListInformation])
- describeOptOutListsResponse_httpStatus :: Lens' DescribeOptOutListsResponse Int
Creating a Request
data DescribeOptOutLists Source #
See: newDescribeOptOutLists smart constructor.
Constructors
| DescribeOptOutLists' | |
Fields
| |
Instances
newDescribeOptOutLists :: DescribeOptOutLists Source #
Create a value of DescribeOptOutLists 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:maxResults:DescribeOptOutLists', describeOptOutLists_maxResults - The maximum number of results to return per each request.
DescribeOptOutLists, describeOptOutLists_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.
$sel:optOutListNames:DescribeOptOutLists', describeOptOutLists_optOutListNames - The OptOutLists to show the details of. This is an array of strings that
can be either the OptOutListName or OptOutListArn.
Request Lenses
describeOptOutLists_maxResults :: Lens' DescribeOptOutLists (Maybe Natural) Source #
The maximum number of results to return per each request.
describeOptOutLists_nextToken :: Lens' DescribeOptOutLists (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.
describeOptOutLists_optOutListNames :: Lens' DescribeOptOutLists (Maybe [Text]) Source #
The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
Destructuring the Response
data DescribeOptOutListsResponse Source #
See: newDescribeOptOutListsResponse smart constructor.
Constructors
| DescribeOptOutListsResponse' | |
Fields
| |
Instances
newDescribeOptOutListsResponse Source #
Create a value of DescribeOptOutListsResponse 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:
DescribeOptOutLists, describeOptOutListsResponse_nextToken - The token to be used for the next set of paginated results. If this
field is empty then there are no more results.
$sel:optOutLists:DescribeOptOutListsResponse', describeOptOutListsResponse_optOutLists - An array of OptOutListInformation objects that contain the details for
the requested OptOutLists.
$sel:httpStatus:DescribeOptOutListsResponse', describeOptOutListsResponse_httpStatus - The response's http status code.
Response Lenses
describeOptOutListsResponse_nextToken :: Lens' DescribeOptOutListsResponse (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.
describeOptOutListsResponse_optOutLists :: Lens' DescribeOptOutListsResponse (Maybe [OptOutListInformation]) Source #
An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
describeOptOutListsResponse_httpStatus :: Lens' DescribeOptOutListsResponse Int Source #
The response's http status code.