@aws-sdk/client-s3-control
Version:
AWS SDK for JavaScript S3 Control Client for Node.js, Browser and React Native
147 lines (146 loc) • 5.8 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { UpdateStorageLensGroupRequest } from "../models/models_1";
import { S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3ControlClient";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link UpdateStorageLensGroupCommand}.
*/
export interface UpdateStorageLensGroupCommandInput extends UpdateStorageLensGroupRequest {
}
/**
* @public
*
* The output of {@link UpdateStorageLensGroupCommand}.
*/
export interface UpdateStorageLensGroupCommandOutput extends __MetadataBearer {
}
declare const UpdateStorageLensGroupCommand_base: {
new (input: UpdateStorageLensGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStorageLensGroupCommandInput, UpdateStorageLensGroupCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (__0_0: UpdateStorageLensGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateStorageLensGroupCommandInput, UpdateStorageLensGroupCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>
* Updates the existing Storage Lens group.</p>
* <p>To use this operation, you must have the permission to perform the
* <code>s3:UpdateStorageLensGroup</code> action. For more information about the required Storage Lens
* Groups permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_iam_permissions.html#storage_lens_groups_permissions">Setting account permissions to use S3 Storage Lens groups</a>.</p>
* <p>For information about Storage Lens groups errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#S3LensErrorCodeList">List of Amazon S3 Storage
* Lens error codes</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { S3ControlClient, UpdateStorageLensGroupCommand } from "@aws-sdk/client-s3-control"; // ES Modules import
* // const { S3ControlClient, UpdateStorageLensGroupCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import
* const client = new S3ControlClient(config);
* const input = { // UpdateStorageLensGroupRequest
* Name: "STRING_VALUE", // required
* AccountId: "STRING_VALUE",
* StorageLensGroup: { // StorageLensGroup
* Name: "STRING_VALUE", // required
* Filter: { // StorageLensGroupFilter
* MatchAnyPrefix: [ // MatchAnyPrefix
* "STRING_VALUE",
* ],
* MatchAnySuffix: [ // MatchAnySuffix
* "STRING_VALUE",
* ],
* MatchAnyTag: [ // MatchAnyTag
* { // S3Tag
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ],
* MatchObjectAge: { // MatchObjectAge
* DaysGreaterThan: Number("int"),
* DaysLessThan: Number("int"),
* },
* MatchObjectSize: { // MatchObjectSize
* BytesGreaterThan: Number("long"),
* BytesLessThan: Number("long"),
* },
* And: { // StorageLensGroupAndOperator
* MatchAnyPrefix: [
* "STRING_VALUE",
* ],
* MatchAnySuffix: [
* "STRING_VALUE",
* ],
* MatchAnyTag: [
* {
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ],
* MatchObjectAge: {
* DaysGreaterThan: Number("int"),
* DaysLessThan: Number("int"),
* },
* MatchObjectSize: {
* BytesGreaterThan: Number("long"),
* BytesLessThan: Number("long"),
* },
* },
* Or: { // StorageLensGroupOrOperator
* MatchAnyPrefix: [
* "STRING_VALUE",
* ],
* MatchAnySuffix: [
* "STRING_VALUE",
* ],
* MatchAnyTag: [
* {
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ],
* MatchObjectAge: {
* DaysGreaterThan: Number("int"),
* DaysLessThan: Number("int"),
* },
* MatchObjectSize: {
* BytesGreaterThan: Number("long"),
* BytesLessThan: Number("long"),
* },
* },
* },
* StorageLensGroupArn: "STRING_VALUE",
* },
* };
* const command = new UpdateStorageLensGroupCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param UpdateStorageLensGroupCommandInput - {@link UpdateStorageLensGroupCommandInput}
* @returns {@link UpdateStorageLensGroupCommandOutput}
* @see {@link UpdateStorageLensGroupCommandInput} for command's `input` shape.
* @see {@link UpdateStorageLensGroupCommandOutput} for command's `response` shape.
* @see {@link S3ControlClientResolvedConfig | config} for S3ControlClient's `config` shape.
*
* @throws {@link S3ControlServiceException}
* <p>Base exception class for all service exceptions from S3Control service.</p>
*
* @public
*/
export declare class UpdateStorageLensGroupCommand extends UpdateStorageLensGroupCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: UpdateStorageLensGroupRequest;
output: {};
};
sdk: {
input: UpdateStorageLensGroupCommandInput;
output: UpdateStorageLensGroupCommandOutput;
};
};
}