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 AWS service that hosts the
resource that you want to tag.
String errorMessage
The message of the common error.
List<E> targetIdFilters
The 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
A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
List<E> resourceTypeFilters
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
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 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.
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.
List<E> tagKeyFilters
A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
List<E> groupBy
A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
Integer maxResults
A limit that restricts the number of results that are returned per page.
String paginationToken
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.
List<E> summaryList
A table that shows counts of noncompliant resources.
String paginationToken
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.
String paginationToken
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.
List<E> tagFilters
A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as 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 do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.
If you don't specify a TagFilter, the response includes all resources that were ever associated with tags.
Resources that currently don't have associated 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 specified 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 any values for a key, the response returns resources that are tagged with that key irrespective of the value.
For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:
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 containing key3 as its tag key, irrespective of its value
GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)
Integer resourcesPerPage
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 100 items.
Integer tagsPerPage
AWS 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 and the maximum of 500 items.
List<E> resourceTypeFilters
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
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 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.
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.
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.
String paginationToken
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.
List<E> resourceTagMappingList
A list of resource ARNs and the tags (keys and values) associated with each.
String paginationToken
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.
String paginationToken
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.
List<E> tagKeys
A list of all tag keys in the AWS account.
String paginationToken
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.
String key
The key for which you want to list all existing values in the specified Region for the AWS account.
String paginationToken
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.
List<E> tagValues
A list of all tag values for the specified key in the AWS account.
String resourceARN
The ARN of the resource.
List<E> tags
The tags that have been applied to one or more AWS 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 AWS Organizations ListRoots API.
String targetIdType
Whether the target is an account, an OU, or the organization root.
String region
The AWS Region that the summary applies to.
String resourceType
The AWS resource type.
Long nonCompliantResources
The count of noncompliant resources.
List<E> resourceARNList
A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Map<K,V> tags
The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.
List<E> resourceARNList
A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
List<E> tagKeys
A list of the tag keys that you want to remove from the specified resources.
Copyright © 2020. All rights reserved.