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

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
[Configuration => ArrayRef[Paws::ResourceGroups::GroupConfigurationItem]]
[Description => Str]
[ResourceQuery => Paws::ResourceGroups::ResourceQuery]
[Tags => Paws::ResourceGroups::Tags]

Each argument is described in detail in: Paws::ResourceGroups::CreateGroup

Returns: a Paws::ResourceGroups::CreateGroupOutput instance

Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). For more information about service configurations, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:CreateGroup

DeleteGroup

[Group => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::ResourceGroups::DeleteGroup

Returns: a Paws::ResourceGroups::DeleteGroupOutput instance

Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:DeleteGroup

GetGroup

[Group => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::ResourceGroups::GetGroup

Returns: a Paws::ResourceGroups::GetGroupOutput instance

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

GetGroupConfiguration

[Group => Str]

Each argument is described in detail in: Paws::ResourceGroups::GetGroupConfiguration

Returns: a Paws::ResourceGroups::GetGroupConfigurationOutput instance

Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupConfiguration

GetGroupQuery

[Group => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::ResourceGroups::GetGroupQuery

Returns: a Paws::ResourceGroups::GetGroupQueryOutput instance

Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroupQuery

GetTags

Arn => Str

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.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetTags

GroupResources

Group => Str
ResourceArns => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ResourceGroups::GroupResources

Returns: a Paws::ResourceGroups::GroupResourcesOutput instance

Adds the specified resources to the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GroupResources

ListGroupResources

[Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter]]
[Group => Str]
[GroupName => Str]
[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 the resources that are members of a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroupResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

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.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:ListGroups

PutGroupConfiguration

[Configuration => ArrayRef[Paws::ResourceGroups::GroupConfigurationItem]]
[Group => Str]

Each argument is described in detail in: Paws::ResourceGroups::PutGroupConfiguration

Returns: a Paws::ResourceGroups::PutGroupConfigurationOutput instance

Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:PutGroupConfiguration

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 the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:SearchResources

  • cloudformation:DescribeStacks

  • cloudformation:ListStackResources

  • tag:GetResources

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.

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.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Tag

UngroupResources

Group => Str
ResourceArns => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ResourceGroups::UngroupResources

Returns: a Paws::ResourceGroups::UngroupResourcesOutput instance

Removes the specified resources from the specified group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UngroupResources

Untag

Arn => Str
Keys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ResourceGroups::Untag

Returns: a Paws::ResourceGroups::UntagOutput instance

Deletes tags from a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:Untag

UpdateGroup

[Description => Str]
[Group => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::ResourceGroups::UpdateGroup

Returns: a Paws::ResourceGroups::UpdateGroupOutput instance

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroup

UpdateGroupQuery

ResourceQuery => Paws::ResourceGroups::ResourceQuery
[Group => Str]
[GroupName => Str]

Each argument is described in detail in: Paws::ResourceGroups::UpdateGroupQuery

Returns: a Paws::ResourceGroups::UpdateGroupQueryOutput instance

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:UpdateGroupQuery

PAGINATORS

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

ListAllGroupResources(sub { },[Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter], Group => Str, GroupName => Str, MaxResults => Int, NextToken => Str])

ListAllGroupResources([Filters => ArrayRef[Paws::ResourceGroups::ResourceFilter], Group => Str, GroupName => Str, 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 

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

If not, it will return a a Paws::ResourceGroups::ListGroupResourcesOutput instance with all the params; andparams; 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 :

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

- 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 params; andparams; 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 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