@aws-sdk/client-s3-control/dist-types/commands/GetMultiRegionAccessPointCommand.d.ts

AWS SDK for JavaScript S3 Control Client for Node.js, Browser and React Native

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { GetMultiRegionAccessPointRequest, GetMultiRegionAccessPointResult } from "../models/models_0";
import { S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3ControlClient";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link GetMultiRegionAccessPointCommand}.
 */
export interface GetMultiRegionAccessPointCommandInput extends GetMultiRegionAccessPointRequest {
}
/**
 * @public
 *
 * The output of {@link GetMultiRegionAccessPointCommand}.
 */
export interface GetMultiRegionAccessPointCommandOutput extends GetMultiRegionAccessPointResult, __MetadataBearer {
}
declare const GetMultiRegionAccessPointCommand_base: {
    new (input: GetMultiRegionAccessPointCommandInput): import("@smithy/smithy-client").CommandImpl<GetMultiRegionAccessPointCommandInput, GetMultiRegionAccessPointCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (__0_0: GetMultiRegionAccessPointCommandInput): import("@smithy/smithy-client").CommandImpl<GetMultiRegionAccessPointCommandInput, GetMultiRegionAccessPointCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <note>
 *             <p>This operation is not supported by directory buckets.</p>
 *          </note>
 *          <p>Returns configuration information about the specified Multi-Region Access Point.</p>
 *          <p>This action will always be routed to the US West (Oregon) Region. For more information
 *          about the restrictions around working with Multi-Region Access Points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPointRestrictions.html">Multi-Region Access Point
 *             restrictions and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>
 *          <p>The following actions are related to <code>GetMultiRegionAccessPoint</code>:</p>
 *          <ul>
 *             <li>
 *                <p>
 *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateMultiRegionAccessPoint.html">CreateMultiRegionAccessPoint</a>
 *                </p>
 *             </li>
 *             <li>
 *                <p>
 *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteMultiRegionAccessPoint.html">DeleteMultiRegionAccessPoint</a>
 *                </p>
 *             </li>
 *             <li>
 *                <p>
 *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeMultiRegionAccessPointOperation.html">DescribeMultiRegionAccessPointOperation</a>
 *                </p>
 *             </li>
 *             <li>
 *                <p>
 *                   <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListMultiRegionAccessPoints.html">ListMultiRegionAccessPoints</a>
 *                </p>
 *             </li>
 *          </ul>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { S3ControlClient, GetMultiRegionAccessPointCommand } from "@aws-sdk/client-s3-control"; // ES Modules import
 * // const { S3ControlClient, GetMultiRegionAccessPointCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import
 * const client = new S3ControlClient(config);
 * const input = { // GetMultiRegionAccessPointRequest
 *   AccountId: "STRING_VALUE",
 *   Name: "STRING_VALUE", // required
 * };
 * const command = new GetMultiRegionAccessPointCommand(input);
 * const response = await client.send(command);
 * // { // GetMultiRegionAccessPointResult
 * //   AccessPoint: { // MultiRegionAccessPointReport
 * //     Name: "STRING_VALUE",
 * //     Alias: "STRING_VALUE",
 * //     CreatedAt: new Date("TIMESTAMP"),
 * //     PublicAccessBlock: { // PublicAccessBlockConfiguration
 * //       BlockPublicAcls: true || false,
 * //       IgnorePublicAcls: true || false,
 * //       BlockPublicPolicy: true || false,
 * //       RestrictPublicBuckets: true || false,
 * //     },
 * //     Status: "READY" || "INCONSISTENT_ACROSS_REGIONS" || "CREATING" || "PARTIALLY_CREATED" || "PARTIALLY_DELETED" || "DELETING",
 * //     Regions: [ // RegionReportList
 * //       { // RegionReport
 * //         Bucket: "STRING_VALUE",
 * //         Region: "STRING_VALUE",
 * //         BucketAccountId: "STRING_VALUE",
 * //       },
 * //     ],
 * //   },
 * // };
 *
 * ```
 *
 * @param GetMultiRegionAccessPointCommandInput - {@link GetMultiRegionAccessPointCommandInput}
 * @returns {@link GetMultiRegionAccessPointCommandOutput}
 * @see {@link GetMultiRegionAccessPointCommandInput} for command's `input` shape.
 * @see {@link GetMultiRegionAccessPointCommandOutput} 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 GetMultiRegionAccessPointCommand extends GetMultiRegionAccessPointCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: GetMultiRegionAccessPointRequest;
            output: GetMultiRegionAccessPointResult;
        };
        sdk: {
            input: GetMultiRegionAccessPointCommandInput;
            output: GetMultiRegionAccessPointCommandOutput;
        };
    };
}