import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeAccessRequest, DescribeAccessResponse } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAccessCommand}. */ export interface DescribeAccessCommandInput extends DescribeAccessRequest { } /** * @public * * The output of {@link DescribeAccessCommand}. */ export interface DescribeAccessCommandOutput extends DescribeAccessResponse, __MetadataBearer { } declare const DescribeAccessCommand_base: { new (input: DescribeAccessCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribeAccessCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TransferClient, DescribeAccessCommand } from "@aws-sdk/client-transfer"; // ES Modules import * // const { TransferClient, DescribeAccessCommand } = require("@aws-sdk/client-transfer"); // CommonJS import * // import type { TransferClientConfig } from "@aws-sdk/client-transfer"; * const config = {}; // type is TransferClientConfig * const client = new TransferClient(config); * const input = { // DescribeAccessRequest * ServerId: "STRING_VALUE", // required * ExternalId: "STRING_VALUE", // required * }; * const command = new DescribeAccessCommand(input); * const response = await client.send(command); * // { // DescribeAccessResponse * // ServerId: "STRING_VALUE", // required * // Access: { // DescribedAccess * // HomeDirectory: "STRING_VALUE", * // HomeDirectoryMappings: [ // HomeDirectoryMappings * // { // HomeDirectoryMapEntry * // Entry: "STRING_VALUE", // required * // Target: "STRING_VALUE", // required * // Type: "FILE" || "DIRECTORY", * // }, * // ], * // HomeDirectoryType: "PATH" || "LOGICAL", * // Policy: "STRING_VALUE", * // PosixProfile: { // PosixProfile * // Uid: Number("long"), // required * // Gid: Number("long"), // required * // SecondaryGids: [ // SecondaryGids * // Number("long"), * // ], * // }, * // Role: "STRING_VALUE", * // ExternalId: "STRING_VALUE", * // }, * // }; * * ``` * * @param DescribeAccessCommandInput - {@link DescribeAccessCommandInput} * @returns {@link DescribeAccessCommandOutput} * @see {@link DescribeAccessCommandInput} for command's `input` shape. * @see {@link DescribeAccessCommandOutput} for command's `response` shape. * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) *

This exception is thrown when an error occurs in the Transfer Family service.

* * @throws {@link InvalidRequestException} (client fault) *

This exception is thrown when the client submits a malformed request.

* * @throws {@link ResourceNotFoundException} (client fault) *

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

* * @throws {@link ServiceUnavailableException} (server fault) *

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

* * @throws {@link TransferServiceException} *

Base exception class for all service exceptions from Transfer service.

* * * @public */ export declare class DescribeAccessCommand extends DescribeAccessCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAccessRequest; output: DescribeAccessResponse; }; sdk: { input: DescribeAccessCommandInput; output: DescribeAccessCommandOutput; }; }; }