/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the resource-groups-2017-11-27.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.ResourceGroups.Model; namespace Amazon.ResourceGroups { /// /// Interface for accessing ResourceGroups /// /// Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic /// Compute Cloud instances, Amazon Relational Database Service databases, and Amazon /// Simple Storage Service 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 Amazon Web Services Systems Manager /// Automation documents, on tag-related resources in Amazon Web Services Systems Manager. /// Groups of tagged resources also let you quickly view a custom console in Amazon Web /// Services Systems Manager that shows 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 Resource /// Groups User Guide. /// /// /// /// Resource Groups uses a REST-compliant API that you can use to perform the following /// types of operations. /// /// /// public partial interface IAmazonResourceGroups : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IResourceGroupsPaginatorFactory Paginators { get; } #endif #region CreateGroup /// /// 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: /// /// /// /// Container for the necessary parameters to execute the CreateGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGroup service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for CreateGroup Operation Task CreateGroupAsync(CreateGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteGroup /// /// 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: /// /// /// /// Container for the necessary parameters to execute the DeleteGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGroup service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for DeleteGroup Operation Task DeleteGroupAsync(DeleteGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetAccountSettings /// /// Retrieves the current status of optional features in Resource Groups. /// /// Container for the necessary parameters to execute the GetAccountSettings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetAccountSettings service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GetAccountSettings Operation Task GetAccountSettingsAsync(GetAccountSettingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroup /// /// Returns information about a specified resource group. /// /// /// /// Minimum permissions /// /// /// /// To run this command, you must have the following permissions: /// ///
  • /// /// resource-groups:GetGroup /// ///
/// /// Container for the necessary parameters to execute the GetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroup service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GetGroup Operation Task GetGroupAsync(GetGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroupConfiguration /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the GetGroupConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroupConfiguration service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GetGroupConfiguration Operation Task GetGroupConfigurationAsync(GetGroupConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroupQuery /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the GetGroupQuery service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroupQuery service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GetGroupQuery Operation Task GetGroupQueryAsync(GetGroupQueryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetTags /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the GetTags service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetTags service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GetTags Operation Task GetTagsAsync(GetTagsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GroupResources /// /// Adds the specified resources to the specified group. /// /// /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the GroupResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GroupResources service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for GroupResources Operation Task GroupResourcesAsync(GroupResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListGroupResources /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the ListGroupResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListGroupResources service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// /// The request was rejected because it doesn't have valid credentials for the target /// resource. /// /// REST API Reference for ListGroupResources Operation Task ListGroupResourcesAsync(ListGroupResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListGroups /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the ListGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListGroups service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for ListGroups Operation Task ListGroupsAsync(ListGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutGroupConfiguration /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the PutGroupConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutGroupConfiguration service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for PutGroupConfiguration Operation Task PutGroupConfigurationAsync(PutGroupConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SearchResources /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the SearchResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SearchResources service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// /// The request was rejected because it doesn't have valid credentials for the target /// resource. /// /// REST API Reference for SearchResources Operation Task SearchResourcesAsync(SearchResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region Tag /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the Tag service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the Tag service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for Tag Operation Task TagAsync(TagRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UngroupResources /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the UngroupResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UngroupResources service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for UngroupResources Operation Task UngroupResourcesAsync(UngroupResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region Untag /// /// Deletes tags from a specified resource group. /// /// /// /// Minimum permissions /// /// /// /// To run this command, you must have the following permissions: /// ///
  • /// /// resource-groups:Untag /// ///
/// /// Container for the necessary parameters to execute the Untag service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the Untag service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for Untag Operation Task UntagAsync(UntagRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateAccountSettings /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateAccountSettings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateAccountSettings service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for UpdateAccountSettings Operation Task UpdateAccountSettingsAsync(UpdateAccountSettingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateGroup /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the UpdateGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateGroup service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for UpdateGroup Operation Task UpdateGroupAsync(UpdateGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateGroupQuery /// /// 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 /// ///
/// /// Container for the necessary parameters to execute the UpdateGroupQuery service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateGroupQuery service method, as returned by ResourceGroups. /// /// The request includes one or more parameters that violate validation rules. /// /// /// The caller isn't authorized to make the request. Check permissions. /// /// /// An internal error occurred while processing the request. Try again later. /// /// /// The request uses an HTTP method that isn't allowed for the specified resource. /// /// /// One or more of the specified resources don't exist. /// /// /// You've exceeded throttling limits by making too many requests in a period of time. /// /// REST API Reference for UpdateGroupQuery Operation Task UpdateGroupQueryAsync(UpdateGroupQueryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }