| 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.OpsWorksCM.ListTagsForResource
Description
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.
This operation returns paginated results.
Synopsis
- data ListTagsForResource = ListTagsForResource' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceArn :: Text
- newListTagsForResource :: Text -> ListTagsForResource
- listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- data ListTagsForResourceResponse = ListTagsForResourceResponse' {}
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
Creating a Request
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' | |
Fields
| |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:ListTagsForResource', listTagsForResource_maxResults - To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListTagsForResource, listTagsForResource_nextToken - NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call ListTagsForResource again, and assign the token from the
previous results as the value of the nextToken parameter. If there are
no more results, the response object's nextToken parameter value is
null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise server for which you want to show
applied tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
Request Lenses
listTagsForResource_maxResults :: Lens' ListTagsForResource (Maybe Natural) Source #
To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #
NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call ListTagsForResource again, and assign the token from the
previous results as the value of the nextToken parameter. If there are
no more results, the response object's nextToken parameter value is
null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise server for which you want to show
applied tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
Destructuring the Response
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' | |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResource, listTagsForResourceResponse_nextToken - A token that you can use as the value of NextToken in subsequent calls
to the API to show more results.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Tags that have been applied to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
Response Lenses
listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
A token that you can use as the value of NextToken in subsequent calls
to the API to show more results.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
Tags that have been applied to the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.