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 |
Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.
This operation supports pagination. You can optionally specify the
Limit
parameter in the body to limit the number of tape pools in the
response. If the number of tape pools returned in the response is
truncated, the response includes a Marker
element that you can use in
your subsequent request to retrieve the next set of tape pools.
This operation returns paginated results.
Synopsis
- data ListTapePools = ListTapePools' {}
- newListTapePools :: ListTapePools
- listTapePools_limit :: Lens' ListTapePools (Maybe Natural)
- listTapePools_marker :: Lens' ListTapePools (Maybe Text)
- listTapePools_poolARNs :: Lens' ListTapePools (Maybe [Text])
- data ListTapePoolsResponse = ListTapePoolsResponse' {}
- newListTapePoolsResponse :: Int -> ListTapePoolsResponse
- listTapePoolsResponse_marker :: Lens' ListTapePoolsResponse (Maybe Text)
- listTapePoolsResponse_poolInfos :: Lens' ListTapePoolsResponse (Maybe [PoolInfo])
- listTapePoolsResponse_httpStatus :: Lens' ListTapePoolsResponse Int
Creating a Request
data ListTapePools Source #
See: newListTapePools
smart constructor.
ListTapePools' | |
|
Instances
newListTapePools :: ListTapePools Source #
Create a value of ListTapePools
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:limit:ListTapePools'
, listTapePools_limit
- An optional number limit for the tape pools in the list returned by this
call.
ListTapePools
, listTapePools_marker
- A string that indicates the position at which to begin the returned list
of tape pools.
$sel:poolARNs:ListTapePools'
, listTapePools_poolARNs
- The Amazon Resource Name (ARN) of each of the custom tape pools you want
to list. If you don't specify a custom tape pool ARN, the response
lists all custom tape pools.
Request Lenses
listTapePools_limit :: Lens' ListTapePools (Maybe Natural) Source #
An optional number limit for the tape pools in the list returned by this call.
listTapePools_marker :: Lens' ListTapePools (Maybe Text) Source #
A string that indicates the position at which to begin the returned list of tape pools.
listTapePools_poolARNs :: Lens' ListTapePools (Maybe [Text]) Source #
The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.
Destructuring the Response
data ListTapePoolsResponse Source #
See: newListTapePoolsResponse
smart constructor.
ListTapePoolsResponse' | |
|
Instances
newListTapePoolsResponse Source #
Create a value of ListTapePoolsResponse
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:
ListTapePools
, listTapePoolsResponse_marker
- A string that indicates the position at which to begin the returned list
of tape pools. Use the marker in your next request to continue
pagination of tape pools. If there are no more tape pools to list, this
element does not appear in the response body.
$sel:poolInfos:ListTapePoolsResponse'
, listTapePoolsResponse_poolInfos
- An array of PoolInfo
objects, where each object describes a single
custom tape pool. If there are no custom tape pools, the PoolInfos
is
an empty array.
$sel:httpStatus:ListTapePoolsResponse'
, listTapePoolsResponse_httpStatus
- The response's http status code.
Response Lenses
listTapePoolsResponse_marker :: Lens' ListTapePoolsResponse (Maybe Text) Source #
A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.
listTapePoolsResponse_poolInfos :: Lens' ListTapePoolsResponse (Maybe [PoolInfo]) Source #
An array of PoolInfo
objects, where each object describes a single
custom tape pool. If there are no custom tape pools, the PoolInfos
is
an empty array.
listTapePoolsResponse_httpStatus :: Lens' ListTapePoolsResponse Int Source #
The response's http status code.