ResourceGroups

import { ResourceGroups } from "https://aws-api.deno.dev/v0.4/services/resourcegroups.ts?docs=full";

class ResourceGroups {

constructor(apiFactory: client.ApiFactory);

async createGroup(params: CreateGroupInput, opts?: client.RequestOptions): Promise<CreateGroupOutput>;

async deleteGroup(params?: DeleteGroupInput, opts?: client.RequestOptions): Promise<DeleteGroupOutput>;

async getAccountSettings(opts?: client.RequestOptions): Promise<GetAccountSettingsOutput>;

async getGroup(params?: GetGroupInput, opts?: client.RequestOptions): Promise<GetGroupOutput>;

async getGroupConfiguration(params?: GetGroupConfigurationInput, opts?: client.RequestOptions): Promise<GetGroupConfigurationOutput>;

async getGroupQuery(params?: GetGroupQueryInput, opts?: client.RequestOptions): Promise<GetGroupQueryOutput>;

async getTags(params: GetTagsInput, opts?: client.RequestOptions): Promise<GetTagsOutput>;

async groupResources(params: GroupResourcesInput, opts?: client.RequestOptions): Promise<GroupResourcesOutput>;

async listGroupResources(params?: ListGroupResourcesInput, opts?: client.RequestOptions): Promise<ListGroupResourcesOutput>;

async listGroups(params?: ListGroupsInput, opts?: client.RequestOptions): Promise<ListGroupsOutput>;

async putGroupConfiguration(params?: PutGroupConfigurationInput, opts?: client.RequestOptions): Promise<void>;

async searchResources(params: SearchResourcesInput, opts?: client.RequestOptions): Promise<SearchResourcesOutput>;

async tag(params: TagInput, opts?: client.RequestOptions): Promise<TagOutput>;

async ungroupResources(params: UngroupResourcesInput, opts?: client.RequestOptions): Promise<UngroupResourcesOutput>;

async untag(params: UntagInput, opts?: client.RequestOptions): Promise<UntagOutput>;

async updateAccountSettings(params?: UpdateAccountSettingsInput, opts?: client.RequestOptions): Promise<UpdateAccountSettingsOutput>;

async updateGroup(params?: UpdateGroupInput, opts?: client.RequestOptions): Promise<UpdateGroupOutput>;

async updateGroupQuery(params: UpdateGroupQueryInput, opts?: client.RequestOptions): Promise<UpdateGroupQueryOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new ResourceGroups(apiFactory: client.ApiFactory)

[src]

§Methods

createGroup(params: CreateGroupInput, opts?: client.RequestOptions): Promise<CreateGroupOutput>

[src]

Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.

Minimum permissions

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

```
resource-groups:CreateGroup
```

deleteGroup(params?: DeleteGroupInput, opts?: client.RequestOptions): Promise<DeleteGroupOutput>

[src]

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
```

getAccountSettings(opts?: client.RequestOptions): Promise<GetAccountSettingsOutput>

[src]

Retrieves the current status of optional features in Resource Groups.

getGroup(params?: GetGroupInput, opts?: client.RequestOptions): Promise<GetGroupOutput>

[src]

Returns information about a specified resource group.

Minimum permissions

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

```
resource-groups:GetGroup
```

getGroupConfiguration(params?: GetGroupConfigurationInput, opts?: client.RequestOptions): Promise<GetGroupConfigurationOutput>

[src]

Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.

Minimum permissions

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

```
resource-groups:GetGroupConfiguration
```

getGroupQuery(params?: GetGroupQueryInput, opts?: client.RequestOptions): Promise<GetGroupQueryOutput>

[src]

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.

Minimum permissions

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

```
resource-groups:GetGroupQuery
```

getTags(params: GetTagsInput, opts?: client.RequestOptions): Promise<GetTagsOutput>

[src]

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(params: GroupResourcesInput, opts?: client.RequestOptions): Promise<GroupResourcesOutput>

[src]

Adds the specified resources to the specified group.

! IMPORTANT: ! You can use this operation with only resource groups that are configured with the following types: ! - AWS::EC2::HostManagement ! - AWS::EC2::CapacityReservationPool ! Other resource group type and resource types aren't currently supported by this operation.

Minimum permissions

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

```
resource-groups:GroupResources
```

listGroupResources(params?: ListGroupResourcesInput, opts?: client.RequestOptions): Promise<ListGroupResourcesOutput>

[src]

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(params?: ListGroupsInput, opts?: client.RequestOptions): Promise<ListGroupsOutput>

[src]

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(params?: PutGroupConfigurationInput, opts?: client.RequestOptions): Promise<void>

[src]

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(params: SearchResourcesInput, opts?: client.RequestOptions): Promise<SearchResourcesOutput>

[src]

Returns a list of Amazon Web Services 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(params: TagInput, opts?: client.RequestOptions): Promise<TagOutput>

[src]

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.

! IMPORTANT: ! 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(params: UngroupResourcesInput, opts?: client.RequestOptions): Promise<UngroupResourcesOutput>

[src]

Removes the specified resources from the specified group. This operation works only with static groups that you populated using the "GroupResources" operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.

Minimum permissions

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

```
resource-groups:UngroupResources
```

untag(params: UntagInput, opts?: client.RequestOptions): Promise<UntagOutput>

[src]

Deletes tags from a specified resource group.

Minimum permissions

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

```
resource-groups:Untag
```

updateAccountSettings(params?: UpdateAccountSettingsInput, opts?: client.RequestOptions): Promise<UpdateAccountSettingsOutput>

[src]

Turns on or turns off optional features in Resource Groups.

The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the "GetAccountSettings" operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.

updateGroup(params?: UpdateGroupInput, opts?: client.RequestOptions): Promise<UpdateGroupOutput>

[src]

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(params: UpdateGroupQueryInput, opts?: client.RequestOptions): Promise<UpdateGroupQueryOutput>

[src]

Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.

Minimum permissions

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

```
resource-groups:UpdateGroupQuery
```

§Static Properties

ApiMetadata: client.ApiMetadata

[src]