| 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.Backup.ListTags
Description
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags only works for resource types that support full Backup
management of their backups. Those resource types are listed in the
"Full Backup management" section of the
Feature availability by resource
table.
Synopsis
- data ListTags = ListTags' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceArn :: Text
- newListTags :: Text -> ListTags
- listTags_maxResults :: Lens' ListTags (Maybe Natural)
- listTags_nextToken :: Lens' ListTags (Maybe Text)
- listTags_resourceArn :: Lens' ListTags Text
- data ListTagsResponse = ListTagsResponse' {}
- newListTagsResponse :: Int -> ListTagsResponse
- listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text)
- listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (HashMap Text Text))
- listTagsResponse_httpStatus :: Lens' ListTagsResponse Int
Creating a Request
See: newListTags smart constructor.
Constructors
| ListTags' | |
Fields
| |
Instances
Create a value of ListTags 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:ListTags', listTags_maxResults - The maximum number of items to be returned.
ListTags, listTags_nextToken - The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListTags, listTags_resourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the type of resource. Valid targets for
ListTags are recovery points, backup plans, and backup vaults.
Request Lenses
listTags_maxResults :: Lens' ListTags (Maybe Natural) Source #
The maximum number of items to be returned.
listTags_nextToken :: Lens' ListTags (Maybe Text) Source #
The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
listTags_resourceArn :: Lens' ListTags Text Source #
An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the type of resource. Valid targets for
ListTags are recovery points, backup plans, and backup vaults.
Destructuring the Response
data ListTagsResponse Source #
See: newListTagsResponse smart constructor.
Constructors
| ListTagsResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse 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:
ListTags, listTagsResponse_nextToken - The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListTagsResponse, listTagsResponse_tags - To help organize your resources, you can assign your own metadata to the
resources you create. Each tag is a key-value pair.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
Response Lenses
listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #
The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (HashMap Text Text)) Source #
To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #
The response's http status code.