2019/11/26 - AWS Resource Groups Tagging API - 3 new 1 updated api methods
Changes You can use tag policies to help standardize on tags across your organization's resources.
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's master account and from the us-east-1 Region.
See also: AWS API Documentation
Request Syntax
client.get_compliance_summary(
TargetIdFilters=[
'string',
],
RegionFilters=[
'string',
],
ResourceTypeFilters=[
'string',
],
TagKeyFilters=[
'string',
],
GroupBy=[
'TARGET_ID'|'REGION'|'RESOURCE_TYPE',
],
MaxResults=123,
PaginationToken='string'
)
list
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.
(string) --
list
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.
(string) --
list
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.
(string) --
list
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.
(string) --
list
A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
(string) --
integer
A limit that restricts the number of results that are returned per page.
string
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.
dict
Response Syntax
{
'SummaryList': [
{
'LastUpdated': 'string',
'TargetId': 'string',
'TargetIdType': 'ACCOUNT'|'OU'|'ROOT',
'Region': 'string',
'ResourceType': 'string',
'NonCompliantResources': 123
},
],
'PaginationToken': 'string'
}
Response Structure
(dict) --
SummaryList (list) --
A table that shows counts of noncompliant resources.
(dict) --
A count of noncompliant resources.
LastUpdated (string) --
The timestamp that shows when this summary was generated in this Region.
TargetId (string) --
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.
TargetIdType (string) --
Whether the target is an account, an OU, or the organization root.
Region (string) --
The AWS Region that the summary applies to.
ResourceType (string) --
The AWS resource type.
NonCompliantResources (integer) --
The count of noncompliant resources.
PaginationToken (string) --
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.
Generates a report that lists all tagged resources in accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily.
The generated report is saved to the following location:
s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv
You can call this operation only from the organization's master account and from the us-east-1 Region.
See also: AWS API Documentation
Request Syntax
client.start_report_creation(
S3Bucket='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the status of the StartReportCreation operation.
You can call this operation only from the organization's master account and from the us-east-1 Region.
See also: AWS API Documentation
Request Syntax
client.describe_report_creation()
dict
Response Syntax
{
'Status': 'string',
'S3Location': 'string',
'ErrorMessage': 'string'
}
Response Structure
(dict) --
Status (string) --
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.
S3Location (string) --
The path to the Amazon S3 bucket where the report was stored on creation.
ErrorMessage (string) --
Details of the common errors that all operations return.
{'ExcludeCompliantResources': 'boolean', 'IncludeComplianceDetails': 'boolean'}
Response {'ResourceTagMappingList': {'ComplianceDetails': {'ComplianceStatus': 'boolean',
'KeysWithNoncompliantValues': ['string'],
'NoncompliantKeys': ['string']}}}
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS 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 AWS Organizations User Guide.
Note
You can check the PaginationToken response parameter to determine if a query is complete. Queries occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.
See also: AWS API Documentation
Request Syntax
client.get_resources(
PaginationToken='string',
TagFilters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
ResourcesPerPage=123,
TagsPerPage=123,
ResourceTypeFilters=[
'string',
],
IncludeComplianceDetails=True|False,
ExcludeCompliantResources=True|False
)
string
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
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)
(dict) --
A list of tags (keys and values) that are used to specify the associated resources.
Key (string) --
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.
Values (list) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
(string) --
integer
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
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
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.
(string) --
boolean
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
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 .
dict
Response Syntax
{
'PaginationToken': 'string',
'ResourceTagMappingList': [
{
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ComplianceDetails': {
'NoncompliantKeys': [
'string',
],
'KeysWithNoncompliantValues': [
'string',
],
'ComplianceStatus': True|False
}
},
]
}
Response Structure
(dict) --
PaginationToken (string) --
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.
ResourceTagMappingList (list) --
A list of resource ARNs and the tags (keys and values) associated with each.
(dict) --
A list of resource ARNs and the tags (keys and values) that are associated with each.
ResourceARN (string) --
The ARN of the resource.
Tags (list) --
The tags that have been applied to one or more AWS resources.
(dict) --
The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tagging AWS Resources in the AWS General Reference .
Key (string) --
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.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
ComplianceDetails (dict) --
Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
NoncompliantKeys (list) --
The tag key is noncompliant with the effective tag policy.
(string) --
KeysWithNoncompliantValues (list) --
The tag value is noncompliant with the effective tag policy.
(string) --
ComplianceStatus (boolean) --
Whether a resource is compliant with the effective tag policy.