1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class ResourceGroupsTaggingAPI extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: ResourceGroupsTaggingAPI.Types.ClientConfiguration)
|
13 | config: Config & ResourceGroupsTaggingAPI.Types.ClientConfiguration;
|
14 | /**
|
15 | * Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
|
16 | */
|
17 | getResources(params: ResourceGroupsTaggingAPI.Types.GetResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetResourcesOutput, AWSError>;
|
18 | /**
|
19 | * Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
|
20 | */
|
21 | getResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetResourcesOutput, AWSError>;
|
22 | /**
|
23 | * Returns all tag keys in the specified region for the AWS account.
|
24 | */
|
25 | getTagKeys(params: ResourceGroupsTaggingAPI.Types.GetTagKeysInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagKeysOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetTagKeysOutput, AWSError>;
|
26 | /**
|
27 | * Returns all tag keys in the specified region for the AWS account.
|
28 | */
|
29 | getTagKeys(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagKeysOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetTagKeysOutput, AWSError>;
|
30 | /**
|
31 | * Returns all tag values for the specified key in the specified region for the AWS account.
|
32 | */
|
33 | getTagValues(params: ResourceGroupsTaggingAPI.Types.GetTagValuesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagValuesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetTagValuesOutput, AWSError>;
|
34 | /**
|
35 | * Returns all tag values for the specified key in the specified region for the AWS account.
|
36 | */
|
37 | getTagValues(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.GetTagValuesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.GetTagValuesOutput, AWSError>;
|
38 | /**
|
39 | * Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide. Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances. You can only tag resources that are located in the specified 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
|
40 | */
|
41 | tagResources(params: ResourceGroupsTaggingAPI.Types.TagResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.TagResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.TagResourcesOutput, AWSError>;
|
42 | /**
|
43 | * Applies one or more tags to the specified resources. Note the following: Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide. Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances. You can only tag resources that are located in the specified 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
|
44 | */
|
45 | tagResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.TagResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.TagResourcesOutput, AWSError>;
|
46 | /**
|
47 | * 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. You can only tag resources that are located in the specified region for the AWS account.
|
48 | */
|
49 | untagResources(params: ResourceGroupsTaggingAPI.Types.UntagResourcesInput, callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.UntagResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.UntagResourcesOutput, AWSError>;
|
50 | /**
|
51 | * 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide. You can only tag resources that are located in the specified region for the AWS account.
|
52 | */
|
53 | untagResources(callback?: (err: AWSError, data: ResourceGroupsTaggingAPI.Types.UntagResourcesOutput) => void): Request<ResourceGroupsTaggingAPI.Types.UntagResourcesOutput, AWSError>;
|
54 | }
|
55 | declare namespace ResourceGroupsTaggingAPI {
|
56 | export type AmazonResourceType = string;
|
57 | export type ErrorCode = "InternalServiceException"|"InvalidParameterException"|string;
|
58 | export type ErrorMessage = string;
|
59 | export type FailedResourcesMap = {[key: string]: FailureInfo};
|
60 | export interface FailureInfo {
|
61 | |
62 |
|
63 |
|
64 | StatusCode?: StatusCode;
|
65 | |
66 |
|
67 |
|
68 | ErrorCode?: ErrorCode;
|
69 | |
70 |
|
71 |
|
72 | ErrorMessage?: ErrorMessage;
|
73 | }
|
74 | export interface GetResourcesInput {
|
75 | |
76 |
|
77 |
|
78 | PaginationToken?: PaginationToken;
|
79 | |
80 |
|
81 |
|
82 | TagFilters?: TagFilterList;
|
83 | |
84 |
|
85 |
|
86 | ResourcesPerPage?: ResourcesPerPage;
|
87 | |
88 |
|
89 |
|
90 | TagsPerPage?: TagsPerPage;
|
91 | |
92 |
|
93 |
|
94 | ResourceTypeFilters?: ResourceTypeFilterList;
|
95 | }
|
96 | export interface GetResourcesOutput {
|
97 | |
98 |
|
99 |
|
100 | PaginationToken?: PaginationToken;
|
101 | |
102 |
|
103 |
|
104 | ResourceTagMappingList?: ResourceTagMappingList;
|
105 | }
|
106 | export interface GetTagKeysInput {
|
107 | |
108 |
|
109 |
|
110 | PaginationToken?: PaginationToken;
|
111 | }
|
112 | export interface GetTagKeysOutput {
|
113 | |
114 |
|
115 |
|
116 | PaginationToken?: PaginationToken;
|
117 | |
118 |
|
119 |
|
120 | TagKeys?: TagKeyList;
|
121 | }
|
122 | export interface GetTagValuesInput {
|
123 | |
124 |
|
125 |
|
126 | PaginationToken?: PaginationToken;
|
127 | |
128 |
|
129 |
|
130 | Key: TagKey;
|
131 | }
|
132 | export interface GetTagValuesOutput {
|
133 | |
134 |
|
135 |
|
136 | PaginationToken?: PaginationToken;
|
137 | |
138 |
|
139 |
|
140 | TagValues?: TagValuesOutputList;
|
141 | }
|
142 | export type PaginationToken = string;
|
143 | export type ResourceARN = string;
|
144 | export type ResourceARNList = ResourceARN[];
|
145 | export interface ResourceTagMapping {
|
146 | |
147 |
|
148 |
|
149 | ResourceARN?: ResourceARN;
|
150 | |
151 |
|
152 |
|
153 | Tags?: TagList;
|
154 | }
|
155 | export type ResourceTagMappingList = ResourceTagMapping[];
|
156 | export type ResourceTypeFilterList = AmazonResourceType[];
|
157 | export type ResourcesPerPage = number;
|
158 | export type StatusCode = number;
|
159 | export interface Tag {
|
160 | |
161 |
|
162 |
|
163 | Key: TagKey;
|
164 | |
165 |
|
166 |
|
167 | Value: TagValue;
|
168 | }
|
169 | export interface TagFilter {
|
170 | |
171 |
|
172 |
|
173 | Key?: TagKey;
|
174 | |
175 |
|
176 |
|
177 | Values?: TagValueList;
|
178 | }
|
179 | export type TagFilterList = TagFilter[];
|
180 | export type TagKey = string;
|
181 | export type TagKeyList = TagKey[];
|
182 | export type TagKeyListForUntag = TagKey[];
|
183 | export type TagList = Tag[];
|
184 | export type TagMap = {[key: string]: TagValue};
|
185 | export interface TagResourcesInput {
|
186 | |
187 |
|
188 |
|
189 | ResourceARNList: ResourceARNList;
|
190 | |
191 |
|
192 |
|
193 | Tags: TagMap;
|
194 | }
|
195 | export interface TagResourcesOutput {
|
196 | |
197 |
|
198 |
|
199 | FailedResourcesMap?: FailedResourcesMap;
|
200 | }
|
201 | export type TagValue = string;
|
202 | export type TagValueList = TagValue[];
|
203 | export type TagValuesOutputList = TagValue[];
|
204 | export type TagsPerPage = number;
|
205 | export interface UntagResourcesInput {
|
206 | |
207 |
|
208 |
|
209 | ResourceARNList: ResourceARNList;
|
210 | |
211 |
|
212 |
|
213 | TagKeys: TagKeyListForUntag;
|
214 | }
|
215 | export interface UntagResourcesOutput {
|
216 | |
217 |
|
218 |
|
219 | FailedResourcesMap?: FailedResourcesMap;
|
220 | }
|
221 | |
222 |
|
223 |
|
224 | export type apiVersion = "2017-01-26"|"latest"|string;
|
225 | export interface ClientApiVersions {
|
226 | |
227 |
|
228 |
|
229 | apiVersion?: apiVersion;
|
230 | }
|
231 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
232 | |
233 |
|
234 |
|
235 | export import Types = ResourceGroupsTaggingAPI;
|
236 | }
|
237 | export = ResourceGroupsTaggingAPI;
|