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.
+ *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
+ *Returns a list of ARNs of resources that are members of a specified resource group.
+ * + */ + public listGroupResources( + args: ListGroupResourcesCommandInput, + options?: __HttpHandlerOptions + ): PromiseAdds 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.
+ * + */ + public tag( + args: TagCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates an existing group with a new or changed description. You cannot update the name of a resource group.
+ * + */ + public updateGroup( + args: UpdateGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a group with a specified name, description, and resource query.
+ * + */ + public createGroup( + args: CreateGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the resource query of a group.
+ * + */ + public updateGroupQuery( + args: UpdateGroupQueryCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns 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.
+ * + */ + public searchResources( + args: SearchResourcesCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of existing resource groups in your account.
+ * + */ + public listGroups( + args: ListGroupsCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes specified tags from a specified resource.
+ * + */ + public untag( + args: UntagCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
+ * + */ + public deleteGroup( + args: DeleteGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns the resource query associated with the specified resource group.
+ * + */ + public getGroupQuery( + args: GetGroupQueryCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of tags that are associated with a resource group, specified by an ARN.
+ * + */ + public getTags( + args: GetTagsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns information about a specified resource group.
+ * + */ + public getGroup( + args: GetGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseAWS 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.
+ *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
+ *The request does not comply with validation rules that are defined for the request parameters.
+ * + */ +export interface BadRequestException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "BadRequestException"; + $fault: "client"; + Message?: string; +} + +export namespace BadRequestException { + export function isa(o: any): o is BadRequestException { + return _smithy.isa(o, "BadRequestException"); + } +} + +export interface CreateGroupInput { + __type?: "CreateGroupInput"; + /** + * + *The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, + * punctuation, and spaces.
+ * + */ + Description?: string; + + /** + * + *The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created.
+ * A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with
+ * AWS or aws; these are reserved. A resource group name must be unique within your account.
The resource query that determines which AWS resources are members of this group.
+ * + */ + ResourceQuery: ResourceQuery | undefined; + + /** + * + *The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, + * and tag values can have a maximum length of 256 characters.
+ * + */ + Tags?: { [key: string]: string }; +} + +export namespace CreateGroupInput { + export function isa(o: any): o is CreateGroupInput { + return _smithy.isa(o, "CreateGroupInput"); + } +} + +export interface CreateGroupOutput extends $MetadataBearer { + __type?: "CreateGroupOutput"; + /** + * + *A full description of the resource group after it is created.
+ * + */ + Group?: Group; + + /** + * + *The resource query associated with the group.
+ * + */ + ResourceQuery?: ResourceQuery; + + /** + * + *The tags associated with the group.
+ * + */ + Tags?: { [key: string]: string }; +} + +export namespace CreateGroupOutput { + export function isa(o: any): o is CreateGroupOutput { + return _smithy.isa(o, "CreateGroupOutput"); + } +} + +export interface DeleteGroupInput { + __type?: "DeleteGroupInput"; + /** + * + *The name of the resource group to delete.
+ * + */ + GroupName: string | undefined; +} + +export namespace DeleteGroupInput { + export function isa(o: any): o is DeleteGroupInput { + return _smithy.isa(o, "DeleteGroupInput"); + } +} + +export interface DeleteGroupOutput extends $MetadataBearer { + __type?: "DeleteGroupOutput"; + /** + * + *A full description of the deleted resource group.
+ * + */ + Group?: Group; +} + +export namespace DeleteGroupOutput { + export function isa(o: any): o is DeleteGroupOutput { + return _smithy.isa(o, "DeleteGroupOutput"); + } +} + +/** + * + *The caller is not authorized to make the request.
+ * + */ +export interface ForbiddenException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "ForbiddenException"; + $fault: "client"; + Message?: string; +} + +export namespace ForbiddenException { + export function isa(o: any): o is ForbiddenException { + return _smithy.isa(o, "ForbiddenException"); + } +} + +export interface GetGroupInput { + __type?: "GetGroupInput"; + /** + * + *The name of the resource group.
+ * + */ + GroupName: string | undefined; +} + +export namespace GetGroupInput { + export function isa(o: any): o is GetGroupInput { + return _smithy.isa(o, "GetGroupInput"); + } +} + +export interface GetGroupOutput extends $MetadataBearer { + __type?: "GetGroupOutput"; + /** + * + *A full description of the resource group.
+ * + */ + Group?: Group; +} + +export namespace GetGroupOutput { + export function isa(o: any): o is GetGroupOutput { + return _smithy.isa(o, "GetGroupOutput"); + } +} + +export interface GetGroupQueryInput { + __type?: "GetGroupQueryInput"; + /** + * + *The name of the resource group.
+ * + */ + GroupName: string | undefined; +} + +export namespace GetGroupQueryInput { + export function isa(o: any): o is GetGroupQueryInput { + return _smithy.isa(o, "GetGroupQueryInput"); + } +} + +export interface GetGroupQueryOutput extends $MetadataBearer { + __type?: "GetGroupQueryOutput"; + /** + * + *The resource query associated with the specified group.
+ * + */ + GroupQuery?: GroupQuery; +} + +export namespace GetGroupQueryOutput { + export function isa(o: any): o is GetGroupQueryOutput { + return _smithy.isa(o, "GetGroupQueryOutput"); + } +} + +export interface GetTagsInput { + __type?: "GetTagsInput"; + /** + * + *The ARN of the resource group for which you want a list of tags. The resource must exist within the account you are using.
+ * + */ + Arn: string | undefined; +} + +export namespace GetTagsInput { + export function isa(o: any): o is GetTagsInput { + return _smithy.isa(o, "GetTagsInput"); + } +} + +export interface GetTagsOutput extends $MetadataBearer { + __type?: "GetTagsOutput"; + /** + * + *The ARN of the tagged resource group.
+ * + */ + Arn?: string; + + /** + * + *The tags associated with the specified resource group.
+ * + */ + Tags?: { [key: string]: string }; +} + +export namespace GetTagsOutput { + export function isa(o: any): o is GetTagsOutput { + return _smithy.isa(o, "GetTagsOutput"); + } +} + +/** + * + *A resource group.
+ * + */ +export interface Group { + __type?: "Group"; + /** + * + *The description of the resource group.
+ * + */ + Description?: string; + + /** + * + *The ARN of a resource group.
+ * + */ + GroupArn: string | undefined; + + /** + * + *The name of a resource group.
+ * + */ + Name: string | undefined; +} + +export namespace Group { + export function isa(o: any): o is Group { + return _smithy.isa(o, "Group"); + } +} + +/** + * + *A filter name and value pair that is used to obtain more specific results from a list of groups.
+ * + */ +export interface GroupFilter { + __type?: "GroupFilter"; + /** + * + *The name of the filter. Filter names are case-sensitive.
+ * + */ + Name: GroupFilterName | string | undefined; + + /** + * + *One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
+ * + */ + Values: ArrayThe ARN and group name of a group.
+ * + */ +export interface GroupIdentifier { + __type?: "GroupIdentifier"; + /** + * + *The ARN of a resource group.
+ * + */ + GroupArn?: string; + + /** + * + *The name of a resource group.
+ * + */ + GroupName?: string; +} + +export namespace GroupIdentifier { + export function isa(o: any): o is GroupIdentifier { + return _smithy.isa(o, "GroupIdentifier"); + } +} + +/** + * + *The underlying resource query of a resource group. Resources that match query results are part of the group.
+ * + */ +export interface GroupQuery { + __type?: "GroupQuery"; + /** + * + *The name of a resource group that is associated with a specific resource query.
+ * + */ + GroupName: string | undefined; + + /** + * + *The resource query which determines which AWS resources are members of the associated resource group.
+ * + */ + ResourceQuery: ResourceQuery | undefined; +} + +export namespace GroupQuery { + export function isa(o: any): o is GroupQuery { + return _smithy.isa(o, "GroupQuery"); + } +} + +/** + * + *An internal error occurred while processing the request.
+ * + */ +export interface InternalServerErrorException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "InternalServerErrorException"; + $fault: "server"; + Message?: string; +} + +export namespace InternalServerErrorException { + export function isa(o: any): o is InternalServerErrorException { + return _smithy.isa(o, "InternalServerErrorException"); + } +} + +export interface ListGroupResourcesInput { + __type?: "ListGroupResourcesInput"; + /** + * + *Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.
+ *
+ * resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.
The name of the resource group.
+ * + */ + GroupName: string | undefined; + + /** + * + *The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50.
+ * + */ + MaxResults?: number; + + /** + * + *The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, + * run the call again, add the NextToken parameter, and specify the NextToken value.
+ * + */ + NextToken?: string; +} + +export namespace ListGroupResourcesInput { + export function isa(o: any): o is ListGroupResourcesInput { + return _smithy.isa(o, "ListGroupResourcesInput"); + } +} + +export interface ListGroupResourcesOutput extends $MetadataBearer { + __type?: "ListGroupResourcesOutput"; + /** + * + *The NextToken value to include in a subsequent ListGroupResources request, to get more results.
A list of QueryError objects. Each error is an object that contains
+ * ErrorCode and Message structures. Possible values
+ * for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
The ARNs and resource types of resources that are members of the group that you specified.
+ * + */ + ResourceIdentifiers?: ArrayFilters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
+ *
+ * resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.
The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.
+ * + */ + MaxResults?: number; + + /** + * + *The NextToken value that is returned in a paginated ListGroups request. To get the next page of results,
+ * run the call again, add the NextToken parameter, and specify the NextToken value.
A list of GroupIdentifier objects. Each identifier is an object that contains both the GroupName and the GroupArn.
+ * + */ + GroupIdentifiers?: ArrayA list of resource groups.
+ * + */ + Groups?: ArrayThe NextToken value to include in a subsequent ListGroups request, to get more results.
The request uses an HTTP method which is not allowed for the specified resource.
+ * + */ +export interface MethodNotAllowedException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "MethodNotAllowedException"; + $fault: "client"; + Message?: string; +} + +export namespace MethodNotAllowedException { + export function isa(o: any): o is MethodNotAllowedException { + return _smithy.isa(o, "MethodNotAllowedException"); + } +} + +/** + * + *One or more resources specified in the request do not exist.
+ * + */ +export interface NotFoundException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "NotFoundException"; + $fault: "client"; + Message?: string; +} + +export namespace NotFoundException { + export function isa(o: any): o is NotFoundException { + return _smithy.isa(o, "NotFoundException"); + } +} + +/** + * + *A two-part error structure that can occur in ListGroupResources or
+ * SearchResources operations on CloudFormation stack-based queries. The error
+ * occurs if the CloudFormation stack on which the query is based either does not exist, or
+ * has a status that renders the stack inactive. A QueryError occurrence does
+ * not necessarily mean that AWS Resource Groups could not complete the operation, but the
+ * resulting group might have no member resources.
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
A message that explains the ErrorCode value. Messages might state
+ * that the specified CloudFormation stack does not exist (or no longer exists).
+ * For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the
+ * CloudFormation stack has a status that is not (or no longer) active, such as
+ * CREATE_FAILED.
A filter name and value pair that is used to obtain more specific results from a list of resources.
+ * + */ +export interface ResourceFilter { + __type?: "ResourceFilter"; + /** + * + *The name of the filter. Filter names are case-sensitive.
+ * + */ + Name: ResourceFilterName | string | undefined; + + /** + * + *One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
+ * + */ + Values: ArrayThe ARN of a resource, and its resource type.
+ * + */ +export interface ResourceIdentifier { + __type?: "ResourceIdentifier"; + /** + * + *The ARN of a resource.
+ * + */ + ResourceArn?: string; + + /** + * + *The resource type of a resource, such as AWS::EC2::Instance.
The query that is used to define a resource group or a search for resources.
+ * + */ +export interface ResourceQuery { + __type?: "ResourceQuery"; + /** + * + *The query that defines a group or a search.
+ * + */ + Query: string | undefined; + + /** + * + *The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0.
+ *
+ * TAG_FILTERS_1_0:
+ * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags,
+ * as supported by the AWS Tagging API GetResources operation.
+ * If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you
+ * specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.
For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each.
+ * ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}]) The results of this query might include the following.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"}, and {"Key":"Version","Value":"2"}
+ *
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"}, and {"Key":"Version","Value":"1"}
+ *The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. + * The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
+ *An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"}.
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"}, and {"Key":"Version","Value":"4"}
+ *
+ *
+ * CLOUDFORMATION_STACK_1_0:
+ * A JSON syntax that lets you specify a CloudFormation stack ARN.
The maximum number of group member ARNs returned by SearchResources in paginated output. By default, this number is 50.
The NextToken value that is returned in a paginated SearchResources request. To get the next page of results,
+ * run the call again, add the NextToken parameter, and specify the NextToken value.
The search query, using the same formats that are supported for resource group definition.
+ * + */ + ResourceQuery: ResourceQuery | undefined; +} + +export namespace SearchResourcesInput { + export function isa(o: any): o is SearchResourcesInput { + return _smithy.isa(o, "SearchResourcesInput"); + } +} + +export interface SearchResourcesOutput extends $MetadataBearer { + __type?: "SearchResourcesOutput"; + /** + * + *The NextToken value to include in a subsequent SearchResources request, to get more results.
A list of QueryError objects. Each error is an object that
+ * contains ErrorCode and Message structures. Possible values
+ * for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and
+ * CLOUDFORMATION_STACK_NOT_EXISTING.
The ARNs and resource types of resources that are members of the group that you specified.
+ * + */ + ResourceIdentifiers?: ArrayThe ARN of the resource to which to add tags.
+ * + */ + Arn: string | undefined; + + /** + * + *The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, + * and tag values can have a maximum length of 256 characters.
+ * + */ + Tags: { [key: string]: string } | undefined; +} + +export namespace TagInput { + export function isa(o: any): o is TagInput { + return _smithy.isa(o, "TagInput"); + } +} + +export interface TagOutput extends $MetadataBearer { + __type?: "TagOutput"; + /** + * + *The ARN of the tagged resource.
+ * + */ + Arn?: string; + + /** + * + *The tags that have been added to the specified resource.
+ * + */ + Tags?: { [key: string]: string }; +} + +export namespace TagOutput { + export function isa(o: any): o is TagOutput { + return _smithy.isa(o, "TagOutput"); + } +} + +/** + * + *The caller has exceeded throttling limits.
+ * + */ +export interface TooManyRequestsException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "TooManyRequestsException"; + $fault: "client"; + Message?: string; +} + +export namespace TooManyRequestsException { + export function isa(o: any): o is TooManyRequestsException { + return _smithy.isa(o, "TooManyRequestsException"); + } +} + +/** + * + *The request has not been applied because it lacks valid authentication credentials for the target resource.
+ * + */ +export interface UnauthorizedException + extends _smithy.SmithyException, + $MetadataBearer { + __type: "UnauthorizedException"; + $fault: "client"; + Message?: string; +} + +export namespace UnauthorizedException { + export function isa(o: any): o is UnauthorizedException { + return _smithy.isa(o, "UnauthorizedException"); + } +} + +export interface UntagInput { + __type?: "UntagInput"; + /** + * + *The ARN of the resource from which to remove tags.
+ * + */ + Arn: string | undefined; + + /** + * + *The keys of the tags to be removed.
+ * + */ + Keys: ArrayThe ARN of the resource from which tags have been removed.
+ * + */ + Arn?: string; + + /** + * + *The keys of tags that have been removed.
+ * + */ + Keys?: ArrayThe description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, + * punctuation, and spaces.
+ * + */ + Description?: string; + + /** + * + *The name of the resource group for which you want to update its description.
+ * + */ + GroupName: string | undefined; +} + +export namespace UpdateGroupInput { + export function isa(o: any): o is UpdateGroupInput { + return _smithy.isa(o, "UpdateGroupInput"); + } +} + +export interface UpdateGroupOutput extends $MetadataBearer { + __type?: "UpdateGroupOutput"; + /** + * + *The full description of the resource group after it has been updated.
+ * + */ + Group?: Group; +} + +export namespace UpdateGroupOutput { + export function isa(o: any): o is UpdateGroupOutput { + return _smithy.isa(o, "UpdateGroupOutput"); + } +} + +export interface UpdateGroupQueryInput { + __type?: "UpdateGroupQueryInput"; + /** + * + *The name of the resource group for which you want to edit the query.
+ * + */ + GroupName: string | undefined; + + /** + * + *The resource query that determines which AWS resources are members of the resource group.
+ * + */ + ResourceQuery: ResourceQuery | undefined; +} + +export namespace UpdateGroupQueryInput { + export function isa(o: any): o is UpdateGroupQueryInput { + return _smithy.isa(o, "UpdateGroupQueryInput"); + } +} + +export interface UpdateGroupQueryOutput extends $MetadataBearer { + __type?: "UpdateGroupQueryOutput"; + /** + * + *The resource query associated with the resource group after the update.
+ * + */ + GroupQuery?: GroupQuery; +} + +export namespace UpdateGroupQueryOutput { + export function isa(o: any): o is UpdateGroupQueryOutput { + return _smithy.isa(o, "UpdateGroupQueryOutput"); + } +} diff --git a/clients/client-resource-groups/package.json b/clients/client-resource-groups/package.json new file mode 100644 index 000000000000..0232dfbc5811 --- /dev/null +++ b/clients/client-resource-groups/package.json @@ -0,0 +1,75 @@ +{ + "name": "@aws-sdk/client-resource-groups", + "description": "@aws-sdk/client-resource-groups client", + "version": "0.1.0-preview.1", + "scripts": { + "clean": "npm run remove-definitions && npm run remove-dist && npm run remove-js && npm run remove-maps", + "build-documentation": "npm run clean && typedoc ./", + "prepublishOnly": "yarn build", + "pretest": "tsc", + "remove-definitions": "rimraf ./types", + "remove-dist": "rimraf ./dist", + "remove-documentation": "rimraf ./docs", + "remove-js": "rimraf *.js && rimraf ./commands/*.js && rimraf ./models/*.js && rimraf ./protocols/*.js", + "remove-maps": "rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./models/*.js.map && rimraf ./protocols/*.js.map", + "test": "exit 0", + "smoke-test": "npm run pretest && node ./test/smoke/index.spec.js", + "build:es": "tsc -p tsconfig.es.json", + "build": "yarn pretest && yarn build:es" + }, + "main": "./dist/cjs/index.js", + "types": "./types/index.d.ts", + "module": "./dist/es/index.js", + "browser": { + "./runtimeConfig": "./runtimeConfig.browser" + }, + "sideEffects": false, + "dependencies": { + "tslib": "^1.8.0", + "@aws-crypto/sha256-browser": "^0.1.0-preview.1", + "@aws-sdk/config-resolver": "^0.1.0-preview.5", + "@aws-sdk/credential-provider-node": "^0.1.0-preview.7", + "@aws-sdk/fetch-http-handler": "^0.1.0-preview.5", + "@aws-sdk/hash-node": "^0.1.0-preview.5", + "@aws-sdk/invalid-dependency": "^0.1.0-preview.1", + "@aws-sdk/middleware-content-length": "^0.1.0-preview.5", + "@aws-sdk/middleware-host-header": "^0.1.0-preview.1", + "@aws-sdk/middleware-retry": "^0.1.0-preview.5", + "@aws-sdk/middleware-serde": "^0.1.0-preview.1", + "@aws-sdk/middleware-signing": "^0.1.0-preview.7", + "@aws-sdk/middleware-stack": "^0.1.0-preview.6", + "@aws-sdk/middleware-user-agent": "^0.1.0-preview.1", + "@aws-sdk/node-http-handler": "^0.1.0-preview.6", + "@aws-sdk/protocol-http": "^0.1.0-preview.1", + "@aws-sdk/region-provider": "^0.1.0-preview.5", + "@aws-sdk/smithy-client": "^0.1.0-preview.1", + "@aws-sdk/stream-collector-browser": "^0.1.0-preview.5", + "@aws-sdk/stream-collector-node": "^0.1.0-preview.6", + "@aws-sdk/types": "^0.1.0-preview.5", + "@aws-sdk/url-parser-browser": "^0.1.0-preview.5", + "@aws-sdk/url-parser-node": "^0.1.0-preview.5", + "@aws-sdk/util-base64-browser": "^0.1.0-preview.3", + "@aws-sdk/util-base64-node": "^0.1.0-preview.3", + "@aws-sdk/util-body-length-browser": "^0.1.0-preview.3", + "@aws-sdk/util-body-length-node": "^0.1.0-preview.4", + "@aws-sdk/util-user-agent-browser": "^0.1.0-preview.6", + "@aws-sdk/util-user-agent-node": "^0.1.0-preview.6", + "@aws-sdk/util-utf8-browser": "^0.1.0-preview.3", + "@aws-sdk/util-utf8-node": "^0.1.0-preview.3" + }, + "devDependencies": { + "rimraf": "^3.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.3", + "@types/node": "^12.7.5", + "tslib": "^1.8.0" + }, + "engines": { + "node": ">=8.0.0" + }, + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0" +} diff --git a/clients/client-resource-groups/protocols/Aws_restJson1_1.ts b/clients/client-resource-groups/protocols/Aws_restJson1_1.ts new file mode 100644 index 000000000000..1b2ecbfd91d9 --- /dev/null +++ b/clients/client-resource-groups/protocols/Aws_restJson1_1.ts @@ -0,0 +1,1943 @@ +import { + CreateGroupCommandInput, + CreateGroupCommandOutput +} from "../commands/CreateGroupCommand"; +import { + DeleteGroupCommandInput, + DeleteGroupCommandOutput +} from "../commands/DeleteGroupCommand"; +import { + GetGroupCommandInput, + GetGroupCommandOutput +} from "../commands/GetGroupCommand"; +import { + GetGroupQueryCommandInput, + GetGroupQueryCommandOutput +} from "../commands/GetGroupQueryCommand"; +import { + GetTagsCommandInput, + GetTagsCommandOutput +} from "../commands/GetTagsCommand"; +import { + ListGroupResourcesCommandInput, + ListGroupResourcesCommandOutput +} from "../commands/ListGroupResourcesCommand"; +import { + ListGroupsCommandInput, + ListGroupsCommandOutput +} from "../commands/ListGroupsCommand"; +import { + SearchResourcesCommandInput, + SearchResourcesCommandOutput +} from "../commands/SearchResourcesCommand"; +import { TagCommandInput, TagCommandOutput } from "../commands/TagCommand"; +import { + UntagCommandInput, + UntagCommandOutput +} from "../commands/UntagCommand"; +import { + UpdateGroupCommandInput, + UpdateGroupCommandOutput +} from "../commands/UpdateGroupCommand"; +import { + UpdateGroupQueryCommandInput, + UpdateGroupQueryCommandOutput +} from "../commands/UpdateGroupQueryCommand"; +import { + BadRequestException, + ForbiddenException, + Group, + GroupFilter, + GroupIdentifier, + GroupQuery, + InternalServerErrorException, + MethodNotAllowedException, + NotFoundException, + QueryError, + ResourceFilter, + ResourceIdentifier, + ResourceQuery, + TooManyRequestsException, + UnauthorizedException +} from "../models/index"; +import { + HttpRequest as __HttpRequest, + HttpResponse as __HttpResponse +} from "@aws-sdk/protocol-http"; +import { SmithyException as __SmithyException } from "@aws-sdk/smithy-client"; +import { + Endpoint as __Endpoint, + MetadataBearer as __MetadataBearer, + ResponseMetadata as __ResponseMetadata, + SerdeContext as __SerdeContext +} from "@aws-sdk/types"; + +export async function serializeAws_restJson1_1CreateGroupCommand( + input: CreateGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/groups"; + let body: any = {}; + const bodyParams: any = {}; + if (input.Description !== undefined) { + bodyParams["Description"] = input.Description; + } + if (input.Name !== undefined) { + bodyParams["Name"] = input.Name; + } + if (input.ResourceQuery !== undefined) { + bodyParams["ResourceQuery"] = serializeAws_restJson1_1ResourceQuery( + input.ResourceQuery, + context + ); + } + if (input.Tags !== undefined) { + bodyParams["Tags"] = serializeAws_restJson1_1Tags(input.Tags, context); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "POST", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function serializeAws_restJson1_1DeleteGroupCommand( + input: DeleteGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = ""; + let resolvedPath = "/groups/{GroupName}"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "DELETE", + headers: headers, + path: resolvedPath + }); +} + +export async function serializeAws_restJson1_1GetGroupCommand( + input: GetGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = ""; + let resolvedPath = "/groups/{GroupName}"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "GET", + headers: headers, + path: resolvedPath + }); +} + +export async function serializeAws_restJson1_1GetGroupQueryCommand( + input: GetGroupQueryCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = ""; + let resolvedPath = "/groups/{GroupName}/query"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "GET", + headers: headers, + path: resolvedPath + }); +} + +export async function serializeAws_restJson1_1GetTagsCommand( + input: GetTagsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = ""; + let resolvedPath = "/resources/{Arn}/tags"; + if (input.Arn !== undefined) { + const labelValue: any = input.Arn.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: Arn."); + } + resolvedPath = resolvedPath.replace("{Arn}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: Arn."); + } + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "GET", + headers: headers, + path: resolvedPath + }); +} + +export async function serializeAws_restJson1_1ListGroupResourcesCommand( + input: ListGroupResourcesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/groups/{GroupName}/resource-identifiers-list"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + const query: any = {}; + if (input.MaxResults !== undefined) { + query["maxResults"] = input.MaxResults.toString(); + } + if (input.NextToken !== undefined) { + query["nextToken"] = input.NextToken.toString(); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.Filters !== undefined) { + bodyParams["Filters"] = serializeAws_restJson1_1ResourceFilterList( + input.Filters, + context + ); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "POST", + headers: headers, + path: resolvedPath, + query: query, + body: body + }); +} + +export async function serializeAws_restJson1_1ListGroupsCommand( + input: ListGroupsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/groups-list"; + const query: any = {}; + if (input.MaxResults !== undefined) { + query["maxResults"] = input.MaxResults.toString(); + } + if (input.NextToken !== undefined) { + query["nextToken"] = input.NextToken.toString(); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.Filters !== undefined) { + bodyParams["Filters"] = serializeAws_restJson1_1GroupFilterList( + input.Filters, + context + ); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "POST", + headers: headers, + path: resolvedPath, + query: query, + body: body + }); +} + +export async function serializeAws_restJson1_1SearchResourcesCommand( + input: SearchResourcesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/resources/search"; + let body: any = {}; + const bodyParams: any = {}; + if (input.MaxResults !== undefined) { + bodyParams["MaxResults"] = input.MaxResults; + } + if (input.NextToken !== undefined) { + bodyParams["NextToken"] = input.NextToken; + } + if (input.ResourceQuery !== undefined) { + bodyParams["ResourceQuery"] = serializeAws_restJson1_1ResourceQuery( + input.ResourceQuery, + context + ); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "POST", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function serializeAws_restJson1_1TagCommand( + input: TagCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/resources/{Arn}/tags"; + if (input.Arn !== undefined) { + const labelValue: any = input.Arn.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: Arn."); + } + resolvedPath = resolvedPath.replace("{Arn}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: Arn."); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.Tags !== undefined) { + bodyParams["Tags"] = serializeAws_restJson1_1Tags(input.Tags, context); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "PUT", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function serializeAws_restJson1_1UntagCommand( + input: UntagCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/resources/{Arn}/tags"; + if (input.Arn !== undefined) { + const labelValue: any = input.Arn.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: Arn."); + } + resolvedPath = resolvedPath.replace("{Arn}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: Arn."); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.Keys !== undefined) { + bodyParams["Keys"] = serializeAws_restJson1_1TagKeyList( + input.Keys, + context + ); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "PATCH", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function serializeAws_restJson1_1UpdateGroupCommand( + input: UpdateGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/groups/{GroupName}"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.Description !== undefined) { + bodyParams["Description"] = input.Description; + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "PUT", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function serializeAws_restJson1_1UpdateGroupQueryCommand( + input: UpdateGroupQueryCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> { + const headers: any = {}; + headers["Content-Type"] = "application/json"; + let resolvedPath = "/groups/{GroupName}/query"; + if (input.GroupName !== undefined) { + const labelValue: any = input.GroupName.toString(); + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: GroupName."); + } + resolvedPath = resolvedPath.replace("{GroupName}", labelValue); + } else { + throw new Error("No value provided for input HTTP label: GroupName."); + } + let body: any = {}; + const bodyParams: any = {}; + if (input.ResourceQuery !== undefined) { + bodyParams["ResourceQuery"] = serializeAws_restJson1_1ResourceQuery( + input.ResourceQuery, + context + ); + } + body = JSON.stringify(bodyParams); + return new __HttpRequest({ + ...context.endpoint, + protocol: "https", + method: "PUT", + headers: headers, + path: resolvedPath, + body: body + }); +} + +export async function deserializeAws_restJson1_1CreateGroupCommand( + output: __HttpResponse, + context: __SerdeContext +): Promise