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 |
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters . The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
This operation returns paginated results.
Synopsis
- getResources :: GetResources
- data GetResources
- grPaginationToken :: Lens' GetResources (Maybe Text)
- grResourcesPerPage :: Lens' GetResources (Maybe Int)
- grResourceTypeFilters :: Lens' GetResources [Text]
- grTagFilters :: Lens' GetResources [TagFilter]
- grTagsPerPage :: Lens' GetResources (Maybe Int)
- getResourcesResponse :: Int -> GetResourcesResponse
- data GetResourcesResponse
- grrsPaginationToken :: Lens' GetResourcesResponse (Maybe Text)
- grrsResourceTagMappingList :: Lens' GetResourcesResponse [ResourceTagMapping]
- grrsResponseStatus :: Lens' GetResourcesResponse Int
Creating a Request
getResources :: GetResources Source #
Creates a value of GetResources
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grPaginationToken
- A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes aPaginationToken
, use that string for this value to request an additional page of data.grResourcesPerPage
- A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.grResourceTypeFilters
- The constraints on the resources that you want returned. The format of each resource type isservice[:resourceType]
. For example, specifying a resource type ofec2
returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type ofec2:instance
returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following: * For a list of service name strings, see AWS Service Namespaces . * For resource type strings, see Example ARNs . * For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces .grTagFilters
- A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values. If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter. If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.grTagsPerPage
- A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).GetResources
does not split a resource and its associated tags across pages. If the specifiedTagsPerPage
would cause such a break, aPaginationToken
is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify aTagsPerPage
of100
and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can setTagsPerPage
to a minimum of 100 items and the maximum of 500 items.
data GetResources Source #
See: getResources
smart constructor.
Instances
Request Lenses
grPaginationToken :: Lens' GetResources (Maybe Text) Source #
A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken
, use that string for this value to request an additional page of data.
grResourcesPerPage :: Lens' GetResources (Maybe Int) Source #
A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.
grResourceTypeFilters :: Lens' GetResources [Text] Source #
The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]
. For example, specifying a resource type of ec2
returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of ec2:instance
returns only EC2 instances. The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following: * For a list of service name strings, see AWS Service Namespaces . * For resource type strings, see Example ARNs . * For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces .
grTagFilters :: Lens' GetResources [TagFilter] Source #
A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values. If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter. If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.
grTagsPerPage :: Lens' GetResources (Maybe Int) Source #
A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair). GetResources
does not split a resource and its associated tags across pages. If the specified TagsPerPage
would cause such a break, a PaginationToken
is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage
of 100
and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags. You can set TagsPerPage
to a minimum of 100 items and the maximum of 500 items.
Destructuring the Response
Creates a value of GetResourcesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grrsPaginationToken
- A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for thePaginationToken
value in a subsequent request.grrsResourceTagMappingList
- A list of resource ARNs and the tags (keys and values) associated with each.grrsResponseStatus
- -- | The response status code.
data GetResourcesResponse Source #
See: getResourcesResponse
smart constructor.
Instances
Response Lenses
grrsPaginationToken :: Lens' GetResourcesResponse (Maybe Text) Source #
A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken
value in a subsequent request.
grrsResourceTagMappingList :: Lens' GetResourcesResponse [ResourceTagMapping] Source #
A list of resource ARNs and the tags (keys and values) associated with each.
grrsResponseStatus :: Lens' GetResourcesResponse Int Source #
- - | The response status code.