import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeAddressesRequest, DescribeAddressesResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeAddressesCommand}. */ export interface DescribeAddressesCommandInput extends DescribeAddressesRequest { } /** * @public * * The output of {@link DescribeAddressesCommand}. */ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult, __MetadataBearer { } declare const DescribeAddressesCommand_base: { new (input: DescribeAddressesCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeAddressesCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns a specified number of ADDRESS objects. Calling this API in one of * the US regions will return addresses from the list of all addresses associated with this * account in all US regions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SnowballClient, DescribeAddressesCommand } from "@aws-sdk/client-snowball"; // ES Modules import * // const { SnowballClient, DescribeAddressesCommand } = require("@aws-sdk/client-snowball"); // CommonJS import * // import type { SnowballClientConfig } from "@aws-sdk/client-snowball"; * const config = {}; // type is SnowballClientConfig * const client = new SnowballClient(config); * const input = { // DescribeAddressesRequest * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeAddressesCommand(input); * const response = await client.send(command); * // { // DescribeAddressesResult * // Addresses: [ // AddressList * // { // Address * // AddressId: "STRING_VALUE", * // Name: "STRING_VALUE", * // Company: "STRING_VALUE", * // Street1: "STRING_VALUE", * // Street2: "STRING_VALUE", * // Street3: "STRING_VALUE", * // City: "STRING_VALUE", * // StateOrProvince: "STRING_VALUE", * // PrefectureOrDistrict: "STRING_VALUE", * // Landmark: "STRING_VALUE", * // Country: "STRING_VALUE", * // PostalCode: "STRING_VALUE", * // PhoneNumber: "STRING_VALUE", * // IsRestricted: true || false, * // Type: "CUST_PICKUP" || "AWS_SHIP", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeAddressesCommandInput - {@link DescribeAddressesCommandInput} * @returns {@link DescribeAddressesCommandOutput} * @see {@link DescribeAddressesCommandInput} for command's `input` shape. * @see {@link DescribeAddressesCommandOutput} for command's `response` shape. * @see {@link SnowballClientResolvedConfig | config} for SnowballClient's `config` shape. * * @throws {@link InvalidNextTokenException} (client fault) *

The NextToken string was altered unexpectedly, and the operation has * stopped. Run the operation without changing the NextToken string, and try * again.

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

The specified resource can't be found. Check the information you provided in your last * request, and try again.

* * @throws {@link SnowballServiceException} *

Base exception class for all service exceptions from Snowball service.

* * * @example To describe all the addresses you've created for AWS Snowball * ```javascript * // This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. * const input = { /* empty *\/ }; * const command = new DescribeAddressesCommand(input); * const response = await client.send(command); * /* response is * { * Addresses: [ * { * AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", * City: "Seattle", * Company: "My Company", * Country: "US", * Name: "My Name", * PhoneNumber: "425-555-5555", * PostalCode: "98101", * StateOrProvince: "WA", * Street1: "123 Main Street" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeAddressesCommand extends DescribeAddressesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAddressesRequest; output: DescribeAddressesResult; }; sdk: { input: DescribeAddressesCommandInput; output: DescribeAddressesCommandOutput; }; }; }