List<E> noncompliantKeys
These tag keys on the resource are noncompliant with the effective tag policy.
List<E> keysWithNoncompliantValues
These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values.
Boolean complianceStatus
Whether a resource is compliant with the effective tag policy.
String status
Reports the status of the operation.
The operation status can be one of the following:
RUNNING - Report creation is in progress.
SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you
specified when you ran StartReportCreation.
FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.
NO REPORT - No report was generated in the last 90 days.
String s3Location
The path to the Amazon S3 bucket where the report was stored on creation.
String errorMessage
Details of the common errors that all operations return.
Integer statusCode
The HTTP status code of the common error.
String errorCode
The code of the common error. Valid values include InternalServiceException,
InvalidParameterException, and any valid error code returned by the Amazon Web Services service that
hosts the resource that you want to tag.
String errorMessage
The message of the common error.
List<E> targetIdFilters
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
List<E> regionFilters
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
List<E> resourceTypeFilters
Specifies that you want the response to include information for only resources of the specified types. 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). Consult the Amazon Web Services General Reference for the following:
For a list of service name strings, see Amazon Web Services Service Namespaces.
For resource type strings, see Example ARNs.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
List<E> tagKeyFilters
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
List<E> groupBy
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
Integer maxResults
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.
String 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.
List<E> summaryList
A table that shows counts of noncompliant resources.
String 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.
String 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.
List<E> 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)
Integer 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.
Integer 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.
List<E> 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
Boolean 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.
Boolean 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.
List<E> 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.
String 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.
List<E> resourceTagMappingList
A list of resource ARNs and the tags (keys and values) associated with each.
String 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.
String 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.
List<E> tagKeys
A list of all tag keys in the Amazon Web Services account.
String 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.
String key
Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.
String 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.
List<E> tagValues
A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.
String resourceARN
The ARN of the resource.
List<E> tags
The tags that have been applied to one or more Amazon Web Services resources.
ComplianceDetails complianceDetails
Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
String s3Bucket
The name of the Amazon S3 bucket where the report will be stored; for example:
awsexamplebucket
For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.
String lastUpdated
The timestamp that shows when this summary was generated in this Region.
String targetId
The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API.
String targetIdType
Whether the target is an account, an OU, or the organization root.
String region
The Amazon Web Services Region that the summary applies to.
String resourceType
The Amazon Web Services resource type.
Long nonCompliantResources
The count of noncompliant resources.
String key
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
String value
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
String key
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
List<E> values
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
List<E> resourceARNList
Specifies the list of ARNs of the resources that you want to apply tags to.
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.
Map<K,V> tags
Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.
Map<K,V> failedResourcesMap
A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed
resource. The value is a FailureInfo object that contains an error code, a status code, and an error
message. If there are no errors, the FailedResourcesMap is empty.
List<E> resourceARNList
Specifies a list of ARNs of the resources that you want to remove tags from.
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.
List<E> tagKeys
Specifies a list of tag keys that you want to remove from the specified resources.
Map<K,V> failedResourcesMap
A map containing a key-value pair for each failed item that couldn't be untagged. The key is the ARN of the
failed resource. The value is a FailureInfo object that contains an error code, a status code, and
an error message. If there are no errors, the FailedResourcesMap is empty.
Copyright © 2024. All rights reserved.