NAME
Paws::ResourceGroups - Perl Interface to AWS AWS Resource Groups
SYNOPSIS
use Paws;
my $obj = Paws->service('ResourceGroups');
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
AWS Resource Groups
AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the AWS Resource Groups User Guide (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html).
AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search results
Getting data about resources that are members of a group
Searching AWS resources based on a resource query
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27
METHODS
CreateGroup
- Name => Str
- ResourceQuery => Paws::ResourceGroups::ResourceQuery
- [Description => Str]
- [Tags => Paws::ResourceGroups::Tags]
Each argument is described in detail in: Paws::ResourceGroups::CreateGroup
Returns: a Paws::ResourceGroups::CreateGroupOutput instance
Creates a group with a specified name, description, and resource query.
DeleteGroup
Each argument is described in detail in: Paws::ResourceGroups::DeleteGroup
Returns: a Paws::ResourceGroups::DeleteGroupOutput instance
Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
GetGroup
Each argument is described in detail in: Paws::ResourceGroups::GetGroup
Returns: a Paws::ResourceGroups::GetGroupOutput instance
Returns information about a specified resource group.
GetGroupQuery
Each argument is described in detail in: Paws::ResourceGroups::GetGroupQuery
Returns: a Paws::ResourceGroups::GetGroupQueryOutput instance
Returns the resource query associated with the specified resource group.
GetTags
Each argument is described in detail in: Paws::ResourceGroups::GetTags
Returns: a Paws::ResourceGroups::GetTagsOutput instance
Returns a list of tags that are associated with a resource group, specified by an ARN.
ListGroupResources
- GroupName => Str
- [Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter]]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::ResourceGroups::ListGroupResources
Returns: a Paws::ResourceGroups::ListGroupResourcesOutput instance
Returns a list of ARNs of resources that are members of a specified resource group.
ListGroups
- [Filters => ArrayRef[Paws::ResourceGroups::GroupFilter]]
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::ResourceGroups::ListGroups
Returns: a Paws::ResourceGroups::ListGroupsOutput instance
Returns a list of existing resource groups in your account.
SearchResources
- ResourceQuery => Paws::ResourceGroups::ResourceQuery
- [MaxResults => Int]
- [NextToken => Str]
Each argument is described in detail in: Paws::ResourceGroups::SearchResources
Returns: a Paws::ResourceGroups::SearchResourcesOutput instance
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Tag
- Arn => Str
- Tags => Paws::ResourceGroups::Tags
Each argument is described in detail in: Paws::ResourceGroups::Tag
Returns: a Paws::ResourceGroups::TagOutput instance
Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Untag
Each argument is described in detail in: Paws::ResourceGroups::Untag
Returns: a Paws::ResourceGroups::UntagOutput instance
Deletes specified tags from a specified resource.
UpdateGroup
Each argument is described in detail in: Paws::ResourceGroups::UpdateGroup
Returns: a Paws::ResourceGroups::UpdateGroupOutput instance
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
UpdateGroupQuery
- GroupName => Str
- ResourceQuery => Paws::ResourceGroups::ResourceQuery
Each argument is described in detail in: Paws::ResourceGroups::UpdateGroupQuery
Returns: a Paws::ResourceGroups::UpdateGroupQueryOutput instance
Updates the resource query of a group.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllGroupResources(sub { },GroupName => Str, [Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter], MaxResults => Int, NextToken => Str])
ListAllGroupResources(GroupName => Str, [Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter], MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ResourceIdentifiers, passing the object as the first parameter, and the string 'ResourceIdentifiers' as the second parameter
If not, it will return a a Paws::ResourceGroups::ListGroupResourcesOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
ListAllGroups(sub { },[Filters => ArrayRef[Paws::ResourceGroups::GroupFilter], MaxResults => Int, NextToken => Str])
ListAllGroups([Filters => ArrayRef[Paws::ResourceGroups::GroupFilter], MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter
If not, it will return a a Paws::ResourceGroups::ListGroupsOutput instance with all the param
s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SearchAllResources(sub { },ResourceQuery => Paws::ResourceGroups::ResourceQuery, [MaxResults => Int, NextToken => Str])
SearchAllResources(ResourceQuery => Paws::ResourceGroups::ResourceQuery, [MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- ResourceIdentifiers, passing the object as the first parameter, and the string 'ResourceIdentifiers' as the second parameter
If not, it will return a a Paws::ResourceGroups::SearchResourcesOutput instance with all the param
s; 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