Amazonka.ResourceGroupsTagging.GetResources

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

Depending on what information you want returned, you can also specify the following:

• Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
• Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

This operation returns paginated results.

Creating a Request

data GetResources

See: newGetResources smart constructor.

Constructors

GetResources'

Fields

• excludeCompliantResources :: Maybe Bool

  Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

  You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

• includeComplianceDetails :: Maybe Bool

  Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

• paginationToken :: Maybe Text

  Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

• resourceARNList :: Maybe (NonEmpty Text)

  Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

  If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

  An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

• resourceTypeFilters :: Maybe [Text]

  Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

  You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

  ec2:instance,s3:bucket,auditmanager

• resourcesPerPage :: Maybe Int

  Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

• tagFilters :: Maybe [TagFilter]

  Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

  Note the following when deciding how to use TagFilters:

  • If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].
  • If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
  • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

  • If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.

    For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

    • GetResources({filter1}) returns resources tagged with key1=value1
    • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
    • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value
    • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
• tagsPerPage :: Maybe Int

  Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

  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 three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

  You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.

Instances

ToJSON GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

toJSON :: GetResources -> Value

toEncoding :: GetResources -> Encoding

toJSONList :: [GetResources] -> Value

toEncodingList :: [GetResources] -> Encoding

ToHeaders GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

toHeaders :: GetResources -> [Header]

ToPath GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

toPath :: GetResources -> ByteString

ToQuery GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

toQuery :: GetResources -> QueryString

AWSPager GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

page :: GetResources -> AWSResponse GetResources -> Maybe GetResources

AWSRequest GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Associated Types

type AWSResponse GetResources

Methods

request :: (Service -> Service) -> GetResources -> Request GetResources

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResources)))

Generic GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Associated Types

type Rep GetResources :: Type -> Type

Methods

from :: GetResources -> Rep GetResources x

to :: Rep GetResources x -> GetResources

Read GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

readsPrec :: Int -> ReadS GetResources

readList :: ReadS [GetResources]

readPrec :: ReadPrec GetResources

readListPrec :: ReadPrec [GetResources]

Show GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

showsPrec :: Int -> GetResources -> ShowS

show :: GetResources -> String

showList :: [GetResources] -> ShowS

NFData GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

rnf :: GetResources -> ()

Eq GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

(==) :: GetResources -> GetResources -> Bool

(/=) :: GetResources -> GetResources -> Bool

Hashable GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

hashWithSalt :: Int -> GetResources -> Int

hash :: GetResources -> Int

type AWSResponse GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

type AWSResponse GetResources = GetResourcesResponse

type Rep GetResources

Defined in Amazonka.ResourceGroupsTagging.GetResources

type Rep GetResources = D1 ('MetaData "GetResources" "Amazonka.ResourceGroupsTagging.GetResources" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetResources'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "excludeCompliantResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "includeComplianceDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceARNList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :*: ((S1 ('MetaSel ('Just "resourceTypeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourcesPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "tagFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagFilter])) :*: S1 ('MetaSel ('Just "tagsPerPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newGetResources :: GetResources

Create a value of GetResources 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:excludeCompliantResources:GetResources', getResources_excludeCompliantResources - Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

$sel:includeComplianceDetails:GetResources', getResources_includeComplianceDetails - Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

GetResources, getResources_paginationToken - Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

$sel:resourceARNList:GetResources', getResources_resourceARNList - Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

$sel:resourceTypeFilters:GetResources', getResources_resourceTypeFilters - Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

ec2:instance,s3:bucket,auditmanager

$sel:resourcesPerPage:GetResources', getResources_resourcesPerPage - Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

$sel:tagFilters:GetResources', getResources_tagFilters - Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].
• If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.

  For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

  • GetResources({filter1}) returns resources tagged with key1=value1
  • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
  • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value
  • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

$sel:tagsPerPage:GetResources', getResources_tagsPerPage - Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

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 three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.

Request Lenses

getResources_excludeCompliantResources :: Lens' GetResources (Maybe Bool)

Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.

getResources_includeComplianceDetails :: Lens' GetResources (Maybe Bool)

Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.

getResources_paginationToken :: Lens' GetResources (Maybe Text)

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

getResources_resourceARNList :: Lens' GetResources (Maybe (NonEmpty Text))

Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage, TagsPerPage, PaginationToken) in the same request. If you specify both, you get an Invalid Parameter exception.

If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

getResources_resourceTypeFilters :: Lens' GetResources (Maybe [Text])

Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API.

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

ec2:instance,s3:bucket,auditmanager

getResources_resourcesPerPage :: Lens' GetResources (Maybe Int)

Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

getResources_tagFilters :: Lens' GetResources (Maybe [TagFilter])

Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:

• If you don't specify a TagFilter, the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [].
• If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
• If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

• If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value.

  For example, for the following filters: filter1= {keyA,{value1}}, filter2={keyB,{value2,value3,value4}}, filter3= {keyC}:

  • GetResources({filter1}) returns resources tagged with key1=value1
  • GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
  • GetResources({filter3}) returns resources tagged with any tag with the key key3, and with any or no value
  • GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)

getResources_tagsPerPage :: Lens' GetResources (Maybe Int)

Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

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 three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.

Destructuring the Response

data GetResourcesResponse

See: newGetResourcesResponse smart constructor.

Constructors

GetResourcesResponse'

Fields

• paginationToken :: Maybe Text

  A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

• resourceTagMappingList :: Maybe [ResourceTagMapping]

  A list of resource ARNs and the tags (keys and values) associated with each.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

Associated Types

type Rep GetResourcesResponse :: Type -> Type

Methods

from :: GetResourcesResponse -> Rep GetResourcesResponse x

to :: Rep GetResourcesResponse x -> GetResourcesResponse

Read GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

readsPrec :: Int -> ReadS GetResourcesResponse

readList :: ReadS [GetResourcesResponse]

readPrec :: ReadPrec GetResourcesResponse

readListPrec :: ReadPrec [GetResourcesResponse]

Show GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

showsPrec :: Int -> GetResourcesResponse -> ShowS

show :: GetResourcesResponse -> String

showList :: [GetResourcesResponse] -> ShowS

NFData GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

rnf :: GetResourcesResponse -> ()

Eq GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

Methods

(==) :: GetResourcesResponse -> GetResourcesResponse -> Bool

(/=) :: GetResourcesResponse -> GetResourcesResponse -> Bool

type Rep GetResourcesResponse

Defined in Amazonka.ResourceGroupsTagging.GetResources

type Rep GetResourcesResponse = D1 ('MetaData "GetResourcesResponse" "Amazonka.ResourceGroupsTagging.GetResources" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceTagMappingList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTagMapping])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourcesResponse

Arguments

:: Int

$sel:httpStatus:GetResourcesResponse'

-> GetResourcesResponse

Create a value of GetResourcesResponse 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:

GetResources, getResourcesResponse_paginationToken - A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

$sel:resourceTagMappingList:GetResourcesResponse', getResourcesResponse_resourceTagMappingList - A list of resource ARNs and the tags (keys and values) associated with each.

$sel:httpStatus:GetResourcesResponse', getResourcesResponse_httpStatus - The response's http status code.

Response Lenses

getResourcesResponse_paginationToken :: Lens' GetResourcesResponse (Maybe Text)

A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

getResourcesResponse_resourceTagMappingList :: Lens' GetResourcesResponse (Maybe [ResourceTagMapping])

A list of resource ARNs and the tags (keys and values) associated with each.

getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int

The response's http status code.