/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ResourceTagging

NAME

Paws::ResourceTagging - Perl Interface to AWS AWS Resource Groups Tagging API

SYNOPSIS

use Paws;

my $obj = Paws->service('ResourceTagging');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Resource Groups Tagging API

For the AWS API documentation, see https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html

METHODS

DescribeReportCreation

Each argument is described in detail in: Paws::ResourceTagging::DescribeReportCreation

Returns: a Paws::ResourceTagging::DescribeReportCreationOutput instance

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

GetComplianceSummary

[GroupBy => ArrayRef[Str|Undef]]
[MaxResults => Int]
[PaginationToken => Str]
[RegionFilters => ArrayRef[Str|Undef]]
[ResourceTypeFilters => ArrayRef[Str|Undef]]
[TagKeyFilters => ArrayRef[Str|Undef]]
[TargetIdFilters => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::ResourceTagging::GetComplianceSummary

Returns: a Paws::ResourceTagging::GetComplianceSummaryOutput instance

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) in the AWS Organizations User Guide.

You can call this operation only from the organization's management account and from the us-east-1 Region.

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.

GetResources

[ExcludeCompliantResources => Bool]
[IncludeComplianceDetails => Bool]
[PaginationToken => Str]
[ResourceARNList => ArrayRef[Str|Undef]]
[ResourcesPerPage => Int]
[ResourceTypeFilters => ArrayRef[Str|Undef]]
[TagFilters => ArrayRef[Paws::ResourceTagging::TagFilter]]
[TagsPerPage => Int]

Each argument is described in detail in: Paws::ResourceTagging::GetResources

Returns: a Paws::ResourceTagging::GetResourcesOutput instance

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 (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html) in the AWS 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.

GetTagKeys

[PaginationToken => Str]

Each argument is described in detail in: Paws::ResourceTagging::GetTagKeys

Returns: a Paws::ResourceTagging::GetTagKeysOutput instance

Returns all tag keys currently in use in the specified Region for the calling AWS account.

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.

GetTagValues

Key => Str
[PaginationToken => Str]

Each argument is described in detail in: Paws::ResourceTagging::GetTagValues

Returns: a Paws::ResourceTagging::GetTagValuesOutput instance

Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.

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.

StartReportCreation

S3Bucket => Str

Each argument is described in detail in: Paws::ResourceTagging::StartReportCreation

Returns: a Paws::ResourceTagging::StartReportCreationOutput instance

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

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 management account and from the us-east-1 Region.

TagResources

ResourceARNList => ArrayRef[Str|Undef]
Tags => Paws::ResourceTagging::TagMap

Each argument is described in detail in: Paws::ResourceTagging::TagResources

Returns: a Paws::ResourceTagging::TagResourcesOutput instance

Applies one or more tags to the specified resources. Note the following:

  • Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API (https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html).

  • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) in the AWS General Reference.

  • You can only tag resources that are located in the specified AWS Region for the AWS account.

  • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

UntagResources

ResourceARNList => ArrayRef[Str|Undef]
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ResourceTagging::UntagResources

Returns: a Paws::ResourceTagging::UntagResourcesOutput instance

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.

  • You can only tag resources that are located in the specified AWS Region for the calling AWS account.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllComplianceSummary(sub { },[GroupBy => ArrayRef[Str|Undef], MaxResults => Int, PaginationToken => Str, RegionFilters => ArrayRef[Str|Undef], ResourceTypeFilters => ArrayRef[Str|Undef], TagKeyFilters => ArrayRef[Str|Undef], TargetIdFilters => ArrayRef[Str|Undef]])

GetAllComplianceSummary([GroupBy => ArrayRef[Str|Undef], MaxResults => Int, PaginationToken => Str, RegionFilters => ArrayRef[Str|Undef], ResourceTypeFilters => ArrayRef[Str|Undef], TagKeyFilters => ArrayRef[Str|Undef], TargetIdFilters => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

- SummaryList, passing the object as the first parameter, and the string 'SummaryList' as the second parameter

If not, it will return a a Paws::ResourceTagging::GetComplianceSummaryOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllResources(sub { },[ExcludeCompliantResources => Bool, IncludeComplianceDetails => Bool, PaginationToken => Str, ResourceARNList => ArrayRef[Str|Undef], ResourcesPerPage => Int, ResourceTypeFilters => ArrayRef[Str|Undef], TagFilters => ArrayRef[Paws::ResourceTagging::TagFilter], TagsPerPage => Int])

GetAllResources([ExcludeCompliantResources => Bool, IncludeComplianceDetails => Bool, PaginationToken => Str, ResourceARNList => ArrayRef[Str|Undef], ResourcesPerPage => Int, ResourceTypeFilters => ArrayRef[Str|Undef], TagFilters => ArrayRef[Paws::ResourceTagging::TagFilter], TagsPerPage => Int])

If passed a sub as first parameter, it will call the sub for each element found in :

- ResourceTagMappingList, passing the object as the first parameter, and the string 'ResourceTagMappingList' as the second parameter

If not, it will return a a Paws::ResourceTagging::GetResourcesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllTagKeys(sub { },[PaginationToken => Str])

GetAllTagKeys([PaginationToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- TagKeys, passing the object as the first parameter, and the string 'TagKeys' as the second parameter

If not, it will return a a Paws::ResourceTagging::GetTagKeysOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllTagValues(sub { },Key => Str, [PaginationToken => Str])

GetAllTagValues(Key => Str, [PaginationToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- TagValues, passing the object as the first parameter, and the string 'TagValues' as the second parameter

If not, it will return a a Paws::ResourceTagging::GetTagValuesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues