Retrieves the status of your account's Amazon Web Services service access, and validates the service * linked role required to access the multi-account search feature. Only the management - * account or a delegated administrator with service access enabled can invoke this API - * call.
+ * account can invoke this API call. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-resource-explorer-2/src/commands/ListResourcesCommand.ts b/clients/client-resource-explorer-2/src/commands/ListResourcesCommand.ts new file mode 100644 index 000000000000..25fe0e25f3a3 --- /dev/null +++ b/clients/client-resource-explorer-2/src/commands/ListResourcesCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListResourcesInput, ListResourcesInputFilterSensitiveLog, ListResourcesOutput } from "../models/models_0"; +import { de_ListResourcesCommand, se_ListResourcesCommand } from "../protocols/Aws_restJson1"; +import { + ResourceExplorer2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../ResourceExplorer2Client"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListResourcesCommand}. + */ +export interface ListResourcesCommandInput extends ListResourcesInput {} +/** + * @public + * + * The output of {@link ListResourcesCommand}. + */ +export interface ListResourcesCommandOutput extends ListResourcesOutput, __MetadataBearer {} + +/** + *Returns a list of resources and their details that match the specified criteria. This query must + * use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region + * in which you call this operation.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceExplorer2Client, ListResourcesCommand } from "@aws-sdk/client-resource-explorer-2"; // ES Modules import + * // const { ResourceExplorer2Client, ListResourcesCommand } = require("@aws-sdk/client-resource-explorer-2"); // CommonJS import + * const client = new ResourceExplorer2Client(config); + * const input = { // ListResourcesInput + * Filters: { // SearchFilter + * FilterString: "STRING_VALUE", // required + * }, + * MaxResults: Number("int"), + * ViewArn: "STRING_VALUE", + * NextToken: "STRING_VALUE", + * }; + * const command = new ListResourcesCommand(input); + * const response = await client.send(command); + * // { // ListResourcesOutput + * // Resources: [ // ResourceList + * // { // Resource + * // Arn: "STRING_VALUE", + * // OwningAccountId: "STRING_VALUE", + * // Region: "STRING_VALUE", + * // ResourceType: "STRING_VALUE", + * // Service: "STRING_VALUE", + * // LastReportedAt: new Date("TIMESTAMP"), + * // Properties: [ // ResourcePropertyList + * // { // ResourceProperty + * // Name: "STRING_VALUE", + * // LastReportedAt: new Date("TIMESTAMP"), + * // Data: "DOCUMENT_VALUE", + * // }, + * // ], + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // ViewArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListResourcesCommandInput - {@link ListResourcesCommandInput} + * @returns {@link ListResourcesCommandOutput} + * @see {@link ListResourcesCommandInput} for command's `input` shape. + * @see {@link ListResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceExplorer2ClientResolvedConfig | config} for ResourceExplorer2Client's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The credentials that you used to call this operation don't have the minimum required + * permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *The request failed because of internal service error. Try your request again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *You specified a resource that doesn't exist. Check the ID or ARN that you used to + * identity the resource, and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request failed because you exceeded a rate limit for this operation. For more + * information, see Quotas for + * Resource Explorer.
+ * + * @throws {@link UnauthorizedException} (client fault) + *The principal making the request isn't permitted to perform the operation.
+ * + * @throws {@link ValidationException} (client fault) + *You provided an invalid value for one of the operation's parameters. Check the syntax + * for the operation, and try again.
+ * + * @throws {@link ResourceExplorer2ServiceException} + *Base exception class for all service exceptions from ResourceExplorer2 service.
+ * + * @public + */ +export class ListResourcesCommand extends $Command + .classBuilder< + ListResourcesCommandInput, + ListResourcesCommandOutput, + ResourceExplorer2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ResourceExplorer2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("ResourceExplorer", "ListResources", {}) + .n("ResourceExplorer2Client", "ListResourcesCommand") + .f(ListResourcesInputFilterSensitiveLog, void 0) + .ser(se_ListResourcesCommand) + .de(de_ListResourcesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListResourcesInput; + output: ListResourcesOutput; + }; + sdk: { + input: ListResourcesCommandInput; + output: ListResourcesCommandOutput; + }; + }; +} diff --git a/clients/client-resource-explorer-2/src/commands/index.ts b/clients/client-resource-explorer-2/src/commands/index.ts index 5f42cefee8df..10598448c4ba 100644 --- a/clients/client-resource-explorer-2/src/commands/index.ts +++ b/clients/client-resource-explorer-2/src/commands/index.ts @@ -12,6 +12,7 @@ export * from "./GetIndexCommand"; export * from "./GetViewCommand"; export * from "./ListIndexesCommand"; export * from "./ListIndexesForMembersCommand"; +export * from "./ListResourcesCommand"; export * from "./ListSupportedResourceTypesCommand"; export * from "./ListTagsForResourceCommand"; export * from "./ListViewsCommand"; diff --git a/clients/client-resource-explorer-2/src/models/models_0.ts b/clients/client-resource-explorer-2/src/models/models_0.ts index a66ac971a8de..84e3994a0f07 100644 --- a/clients/client-resource-explorer-2/src/models/models_0.ts +++ b/clients/client-resource-explorer-2/src/models/models_0.ts @@ -1150,16 +1150,13 @@ export interface ListIndexesForMembersOutput { /** * @public */ -export interface ListSupportedResourceTypesInput { +export interface ListResourcesInput { /** - *The parameter for receiving additional results if you receive a
- * NextToken response in a previous request. A NextToken response
- * indicates that more output is available. Set this parameter to the value of the previous
- * call's NextToken response to indicate where the output should continue
- * from. The pagination tokens expire after 24 hours.
A search filter defines which resources can be part of a search query result + * set.
* @public */ - NextToken?: string; + Filters?: SearchFilter; /** *The maximum number of results that you want included on each page of the @@ -1176,71 +1173,28 @@ export interface ListSupportedResourceTypesInput { * @public */ MaxResults?: number; -} - -/** - *
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
- * @public - */ -export interface SupportedResourceType { - /** - *The Amazon Web Service that is associated with the resource type. This is the primary - * service that lets you create and interact with resources of this type.
- * @public - */ - Service?: string; - - /** - *The unique identifier of the resource type.
- * @public - */ - ResourceType?: string; -} -/** - * @public - */ -export interface ListSupportedResourceTypesOutput { /** - *The list of resource types supported by Resource Explorer.
+ *Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't + * specify a value for this parameter, then the operation automatically uses the default view + * for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have + * a default view or if you don't have permission to use the default view, then the operation + * fails with a 401 Unauthorized exception.
* @public */ - ResourceTypes?: SupportedResourceType[]; + ViewArn?: string; /** - *If present, indicates that more output is available than is
- * included in the current response. Use this value in the NextToken request parameter
- * in a subsequent call to the operation to get the next part of the output. You should repeat this
- * until the NextToken response element comes back as null.
- * The pagination tokens expire after 24 hours.
The parameter for receiving additional results if you receive a
+ * NextToken response in a previous request. A NextToken response
+ * indicates that more output is available. Set this parameter to the value of the previous
+ * call's NextToken response to indicate where the output should continue
+ * from. The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view or index that you want to attach tags to.
- * @public - */ - resourceArn: string | undefined; -} - -/** - * @public - */ -export interface ListTagsForResourceOutput { - /** - *The tag key and value pairs that you want to attach to the specified view or - * index.
- * @public - */ - Tags?: RecordA structure that describes a property of a resource.
* @public @@ -1298,7 +1252,7 @@ export interface Resource { ResourceType?: string; /** - *The Amazon Web Service that owns the resource and is responsible for creating and updating + *
The Amazon Web Servicesservice that owns the resource and is responsible for creating and updating * it.
* @public */ @@ -1319,6 +1273,127 @@ export interface Resource { Properties?: ResourceProperty[]; } +/** + * @public + */ +export interface ListResourcesOutput { + /** + *The list of structures that describe the resources that match the query.
+ * @public + */ + Resources?: Resource[]; + + /** + *If present, indicates that more output is available than is
+ * included in the current response. Use this value in the NextToken request parameter
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
+ * until the NextToken response element comes back as null.
+ * The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view that this operation used to perform the search.
+ * @public + */ + ViewArn?: string; +} + +/** + * @public + */ +export interface ListSupportedResourceTypesInput { + /** + *The parameter for receiving additional results if you receive a
+ * NextToken response in a previous request. A NextToken response
+ * indicates that more output is available. Set this parameter to the value of the previous
+ * call's NextToken response to indicate where the output should continue
+ * from. The pagination tokens expire after 24 hours.
The maximum number of results that you want included on each page of the
+ * response. If you do not include this parameter, it defaults to a value appropriate to the
+ * operation. If additional items exist beyond those included in the current response, the
+ * NextToken response element is present and has a value (is not null). Include that
+ * value as the NextToken request parameter in the next call to the operation to get
+ * the next part of the results.
An API operation can return fewer results than the maximum even when there are
+ * more results available. You should check NextToken after every operation to ensure
+ * that you receive all of the results.
A structure that describes a resource type supported by Amazon Web Services Resource Explorer.
+ * @public + */ +export interface SupportedResourceType { + /** + *The Amazon Web Servicesservice that is associated with the resource type. This is the primary + * service that lets you create and interact with resources of this type.
+ * @public + */ + Service?: string; + + /** + *The unique identifier of the resource type.
+ * @public + */ + ResourceType?: string; +} + +/** + * @public + */ +export interface ListSupportedResourceTypesOutput { + /** + *The list of resource types supported by Resource Explorer.
+ * @public + */ + ResourceTypes?: SupportedResourceType[]; + + /** + *If present, indicates that more output is available than is
+ * included in the current response. Use this value in the NextToken request parameter
+ * in a subsequent call to the operation to get the next part of the output. You should repeat this
+ * until the NextToken response element comes back as null.
+ * The pagination tokens expire after 24 hours.
The Amazon resource name (ARN) of the view or index that you want to attach tags to.
+ * @public + */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceOutput { + /** + *The tag key and value pairs that you want to attach to the specified view or + * index.
+ * @public + */ + Tags?: RecordInformation about the number of results that match the query. At this time, Amazon Web Services Resource Explorer
* doesn't count more than 1,000 matches for any query. This structure
@@ -1574,6 +1649,14 @@ export const GetIndexOutputFilterSensitiveLog = (obj: GetIndexOutput): any => ({
...(obj.Tags && { Tags: SENSITIVE_STRING }),
});
+/**
+ * @internal
+ */
+export const ListResourcesInputFilterSensitiveLog = (obj: ListResourcesInput): any => ({
+ ...obj,
+ ...(obj.Filters && { Filters: SENSITIVE_STRING }),
+});
+
/**
* @internal
*/
diff --git a/clients/client-resource-explorer-2/src/pagination/ListResourcesPaginator.ts b/clients/client-resource-explorer-2/src/pagination/ListResourcesPaginator.ts
new file mode 100644
index 000000000000..39b3c5d95173
--- /dev/null
+++ b/clients/client-resource-explorer-2/src/pagination/ListResourcesPaginator.ts
@@ -0,0 +1,24 @@
+// smithy-typescript generated code
+import { createPaginator } from "@smithy/core";
+import { Paginator } from "@smithy/types";
+
+import {
+ ListResourcesCommand,
+ ListResourcesCommandInput,
+ ListResourcesCommandOutput,
+} from "../commands/ListResourcesCommand";
+import { ResourceExplorer2Client } from "../ResourceExplorer2Client";
+import { ResourceExplorer2PaginationConfiguration } from "./Interfaces";
+
+/**
+ * @public
+ */
+export const paginateListResources: (
+ config: ResourceExplorer2PaginationConfiguration,
+ input: ListResourcesCommandInput,
+ ...rest: any[]
+) => Paginator Retrieves the status of your account's Amazon Web Services service access, and validates the service\n linked role required to access the multi-account search feature. Only the management\n account or a delegated administrator with service access enabled can invoke this API\n call. Retrieves the status of your account's Amazon Web Services service access, and validates the service\n linked role required to access the multi-account search feature. Only the management\n account can invoke this API call. Returns a list of resources and their details that match the specified criteria. This query must \n use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region \n in which you call this operation. The maximum number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value appropriate to the \n operation. If additional items exist beyond those included in the current response, the \n An API operation can return fewer results than the maximum even when there are \n more results available. You should check Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't \n specify a value for this parameter, then the operation automatically uses the default view \n for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have \n a default view or if you don't have permission to use the default view, then the operation \n fails with a 401 Unauthorized exception. The parameter for receiving additional results if you receive a \n The list of structures that describe the resources that match the query. If present, indicates that more output is available than is \n included in the current response. Use this value in the The Amazon resource name (ARN) of the view that this operation used to perform the search. The Amazon Web Service that owns the resource and is responsible for creating and updating\n it. The Amazon Web Servicesservice that owns the resource and is responsible for creating and updating\n it. The Amazon Web Service that is associated with the resource type. This is the primary\n service that lets you create and interact with resources of this type. The Amazon Web Servicesservice that is associated with the resource type. This is the primary\n service that lets you create and interact with resources of this type.NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.NextToken after every operation to ensure \n that you receive all of the results.NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.