Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes one or more of the tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .
This operation returns paginated results.
Synopsis
- describeTags :: DescribeTags
- data DescribeTags
- dtFilters :: Lens' DescribeTags [Filter]
- dtNextToken :: Lens' DescribeTags (Maybe Text)
- dtDryRun :: Lens' DescribeTags (Maybe Bool)
- dtMaxResults :: Lens' DescribeTags (Maybe Int)
- describeTagsResponse :: Int -> DescribeTagsResponse
- data DescribeTagsResponse
- dtrsNextToken :: Lens' DescribeTagsResponse (Maybe Text)
- dtrsTags :: Lens' DescribeTagsResponse [TagDescription]
- dtrsResponseStatus :: Lens' DescribeTagsResponse Int
Creating a Request
describeTags :: DescribeTags Source #
Creates a value of DescribeTags
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtFilters
- One or more filters. *key
- The tag key. *resource-id
- The resource ID. *resource-type
- The resource type (customer-gateway
|dhcp-options
|elastic-ip
|fpga-image
|image
|instance
|internet-gateway
|launch-template
|natgateway
|network-acl
|network-interface
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). *value
- The tag value.dtNextToken
- The token to retrieve the next page of results.dtDryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.dtMaxResults
- The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returnedNextToken
value.
data DescribeTags Source #
Contains the parameters for DescribeTags.
See: describeTags
smart constructor.
Instances
Request Lenses
dtFilters :: Lens' DescribeTags [Filter] Source #
One or more filters. * key
- The tag key. * resource-id
- The resource ID. * resource-type
- The resource type (customer-gateway
| dhcp-options
| elastic-ip
| fpga-image
| image
| instance
| internet-gateway
| launch-template
| natgateway
| network-acl
| network-interface
| reserved-instances
| route-table
| security-group
| snapshot
| spot-instances-request
| subnet
| volume
| vpc
| vpc-peering-connection
| vpn-connection
| vpn-gateway
). * value
- The tag value.
dtNextToken :: Lens' DescribeTags (Maybe Text) Source #
The token to retrieve the next page of results.
dtDryRun :: Lens' DescribeTags (Maybe Bool) Source #
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
dtMaxResults :: Lens' DescribeTags (Maybe Int) Source #
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
Destructuring the Response
Creates a value of DescribeTagsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtrsNextToken
- The token to use to retrieve the next page of results. This value isnull
when there are no more results to return..dtrsTags
- A list of tags.dtrsResponseStatus
- -- | The response status code.
data DescribeTagsResponse Source #
Contains the output of DescribeTags.
See: describeTagsResponse
smart constructor.
Instances
Response Lenses
dtrsNextToken :: Lens' DescribeTagsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is null
when there are no more results to return..
dtrsTags :: Lens' DescribeTagsResponse [TagDescription] Source #
A list of tags.
dtrsResponseStatus :: Lens' DescribeTagsResponse Int Source #
- - | The response status code.