import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { CloudFrontClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFrontClient"; import { ListDistributionsRequest, ListDistributionsResult } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListDistributionsCommand}. */ export interface ListDistributionsCommandInput extends ListDistributionsRequest { } /** * @public * * The output of {@link ListDistributionsCommand}. */ export interface ListDistributionsCommandOutput extends ListDistributionsResult, __MetadataBearer { } declare const ListDistributionsCommand_base: { new (input: ListDistributionsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [ListDistributionsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

List CloudFront distributions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CloudFrontClient, ListDistributionsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import * // const { CloudFrontClient, ListDistributionsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import * const client = new CloudFrontClient(config); * const input = { // ListDistributionsRequest * Marker: "STRING_VALUE", * MaxItems: Number("int"), * }; * const command = new ListDistributionsCommand(input); * const response = await client.send(command); * // { // ListDistributionsResult * // DistributionList: { // DistributionList * // Marker: "STRING_VALUE", // required * // NextMarker: "STRING_VALUE", * // MaxItems: Number("int"), // required * // IsTruncated: true || false, // required * // Quantity: Number("int"), // required * // Items: [ // DistributionSummaryList * // { // DistributionSummary * // Id: "STRING_VALUE", // required * // ARN: "STRING_VALUE", // required * // ETag: "STRING_VALUE", * // Status: "STRING_VALUE", // required * // LastModifiedTime: new Date("TIMESTAMP"), // required * // DomainName: "STRING_VALUE", // required * // Aliases: { // Aliases * // Quantity: Number("int"), // required * // Items: [ // AliasList * // "STRING_VALUE", * // ], * // }, * // Origins: { // Origins * // Quantity: Number("int"), // required * // Items: [ // OriginList // required * // { // Origin * // Id: "STRING_VALUE", // required * // DomainName: "STRING_VALUE", // required * // OriginPath: "STRING_VALUE", * // CustomHeaders: { // CustomHeaders * // Quantity: Number("int"), // required * // Items: [ // OriginCustomHeadersList * // { // OriginCustomHeader * // HeaderName: "STRING_VALUE", // required * // HeaderValue: "STRING_VALUE", // required * // }, * // ], * // }, * // S3OriginConfig: { // S3OriginConfig * // OriginAccessIdentity: "STRING_VALUE", // required * // }, * // CustomOriginConfig: { // CustomOriginConfig * // HTTPPort: Number("int"), // required * // HTTPSPort: Number("int"), // required * // OriginProtocolPolicy: "http-only" || "match-viewer" || "https-only", // required * // OriginSslProtocols: { // OriginSslProtocols * // Quantity: Number("int"), // required * // Items: [ // SslProtocolsList // required * // "SSLv3" || "TLSv1" || "TLSv1.1" || "TLSv1.2", * // ], * // }, * // OriginReadTimeout: Number("int"), * // OriginKeepaliveTimeout: Number("int"), * // }, * // VpcOriginConfig: { // VpcOriginConfig * // VpcOriginId: "STRING_VALUE", // required * // OriginReadTimeout: Number("int"), * // OriginKeepaliveTimeout: Number("int"), * // }, * // ConnectionAttempts: Number("int"), * // ConnectionTimeout: Number("int"), * // OriginShield: { // OriginShield * // Enabled: true || false, // required * // OriginShieldRegion: "STRING_VALUE", * // }, * // OriginAccessControlId: "STRING_VALUE", * // }, * // ], * // }, * // OriginGroups: { // OriginGroups * // Quantity: Number("int"), // required * // Items: [ // OriginGroupList * // { // OriginGroup * // Id: "STRING_VALUE", // required * // FailoverCriteria: { // OriginGroupFailoverCriteria * // StatusCodes: { // StatusCodes * // Quantity: Number("int"), // required * // Items: [ // StatusCodeList // required * // Number("int"), * // ], * // }, * // }, * // Members: { // OriginGroupMembers * // Quantity: Number("int"), // required * // Items: [ // OriginGroupMemberList // required * // { // OriginGroupMember * // OriginId: "STRING_VALUE", // required * // }, * // ], * // }, * // SelectionCriteria: "default" || "media-quality-based", * // }, * // ], * // }, * // DefaultCacheBehavior: { // DefaultCacheBehavior * // TargetOriginId: "STRING_VALUE", // required * // TrustedSigners: { // TrustedSigners * // Enabled: true || false, // required * // Quantity: Number("int"), // required * // Items: [ // AwsAccountNumberList * // "STRING_VALUE", * // ], * // }, * // TrustedKeyGroups: { // TrustedKeyGroups * // Enabled: true || false, // required * // Quantity: Number("int"), // required * // Items: [ // TrustedKeyGroupIdList * // "STRING_VALUE", * // ], * // }, * // ViewerProtocolPolicy: "allow-all" || "https-only" || "redirect-to-https", // required * // AllowedMethods: { // AllowedMethods * // Quantity: Number("int"), // required * // Items: [ // MethodsList // required * // "GET" || "HEAD" || "POST" || "PUT" || "PATCH" || "OPTIONS" || "DELETE", * // ], * // CachedMethods: { // CachedMethods * // Quantity: Number("int"), // required * // Items: [ // required * // "GET" || "HEAD" || "POST" || "PUT" || "PATCH" || "OPTIONS" || "DELETE", * // ], * // }, * // }, * // SmoothStreaming: true || false, * // Compress: true || false, * // LambdaFunctionAssociations: { // LambdaFunctionAssociations * // Quantity: Number("int"), // required * // Items: [ // LambdaFunctionAssociationList * // { // LambdaFunctionAssociation * // LambdaFunctionARN: "STRING_VALUE", // required * // EventType: "viewer-request" || "viewer-response" || "origin-request" || "origin-response", // required * // IncludeBody: true || false, * // }, * // ], * // }, * // FunctionAssociations: { // FunctionAssociations * // Quantity: Number("int"), // required * // Items: [ // FunctionAssociationList * // { // FunctionAssociation * // FunctionARN: "STRING_VALUE", // required * // EventType: "viewer-request" || "viewer-response" || "origin-request" || "origin-response", // required * // }, * // ], * // }, * // FieldLevelEncryptionId: "STRING_VALUE", * // RealtimeLogConfigArn: "STRING_VALUE", * // CachePolicyId: "STRING_VALUE", * // OriginRequestPolicyId: "STRING_VALUE", * // ResponseHeadersPolicyId: "STRING_VALUE", * // GrpcConfig: { // GrpcConfig * // Enabled: true || false, // required * // }, * // ForwardedValues: { // ForwardedValues * // QueryString: true || false, // required * // Cookies: { // CookiePreference * // Forward: "none" || "whitelist" || "all", // required * // WhitelistedNames: { // CookieNames * // Quantity: Number("int"), // required * // Items: [ // CookieNameList * // "STRING_VALUE", * // ], * // }, * // }, * // Headers: { // Headers * // Quantity: Number("int"), // required * // Items: [ // HeaderList * // "STRING_VALUE", * // ], * // }, * // QueryStringCacheKeys: { // QueryStringCacheKeys * // Quantity: Number("int"), // required * // Items: [ // QueryStringCacheKeysList * // "STRING_VALUE", * // ], * // }, * // }, * // MinTTL: Number("long"), * // DefaultTTL: Number("long"), * // MaxTTL: Number("long"), * // }, * // CacheBehaviors: { // CacheBehaviors * // Quantity: Number("int"), // required * // Items: [ // CacheBehaviorList * // { // CacheBehavior * // PathPattern: "STRING_VALUE", // required * // TargetOriginId: "STRING_VALUE", // required * // TrustedSigners: { * // Enabled: true || false, // required * // Quantity: Number("int"), // required * // Items: [ * // "STRING_VALUE", * // ], * // }, * // TrustedKeyGroups: { * // Enabled: true || false, // required * // Quantity: Number("int"), // required * // Items: [ * // "STRING_VALUE", * // ], * // }, * // ViewerProtocolPolicy: "allow-all" || "https-only" || "redirect-to-https", // required * // AllowedMethods: { * // Quantity: Number("int"), // required * // Items: "", // required * // CachedMethods: { * // Quantity: Number("int"), // required * // Items: "", // required * // }, * // }, * // SmoothStreaming: true || false, * // Compress: true || false, * // LambdaFunctionAssociations: { * // Quantity: Number("int"), // required * // Items: [ * // { * // LambdaFunctionARN: "STRING_VALUE", // required * // EventType: "viewer-request" || "viewer-response" || "origin-request" || "origin-response", // required * // IncludeBody: true || false, * // }, * // ], * // }, * // FunctionAssociations: { * // Quantity: Number("int"), // required * // Items: [ * // { * // FunctionARN: "STRING_VALUE", // required * // EventType: "viewer-request" || "viewer-response" || "origin-request" || "origin-response", // required * // }, * // ], * // }, * // FieldLevelEncryptionId: "STRING_VALUE", * // RealtimeLogConfigArn: "STRING_VALUE", * // CachePolicyId: "STRING_VALUE", * // OriginRequestPolicyId: "STRING_VALUE", * // ResponseHeadersPolicyId: "STRING_VALUE", * // GrpcConfig: { * // Enabled: true || false, // required * // }, * // ForwardedValues: { * // QueryString: true || false, // required * // Cookies: { * // Forward: "none" || "whitelist" || "all", // required * // WhitelistedNames: { * // Quantity: Number("int"), // required * // Items: [ * // "STRING_VALUE", * // ], * // }, * // }, * // Headers: { * // Quantity: Number("int"), // required * // Items: [ * // "STRING_VALUE", * // ], * // }, * // QueryStringCacheKeys: { * // Quantity: Number("int"), // required * // Items: [ * // "STRING_VALUE", * // ], * // }, * // }, * // MinTTL: Number("long"), * // DefaultTTL: Number("long"), * // MaxTTL: Number("long"), * // }, * // ], * // }, * // CustomErrorResponses: { // CustomErrorResponses * // Quantity: Number("int"), // required * // Items: [ // CustomErrorResponseList * // { // CustomErrorResponse * // ErrorCode: Number("int"), // required * // ResponsePagePath: "STRING_VALUE", * // ResponseCode: "STRING_VALUE", * // ErrorCachingMinTTL: Number("long"), * // }, * // ], * // }, * // Comment: "STRING_VALUE", // required * // PriceClass: "PriceClass_100" || "PriceClass_200" || "PriceClass_All" || "None", // required * // Enabled: true || false, // required * // ViewerCertificate: { // ViewerCertificate * // CloudFrontDefaultCertificate: true || false, * // IAMCertificateId: "STRING_VALUE", * // ACMCertificateArn: "STRING_VALUE", * // SSLSupportMethod: "sni-only" || "vip" || "static-ip", * // MinimumProtocolVersion: "SSLv3" || "TLSv1" || "TLSv1_2016" || "TLSv1.1_2016" || "TLSv1.2_2018" || "TLSv1.2_2019" || "TLSv1.2_2021", * // Certificate: "STRING_VALUE", * // CertificateSource: "cloudfront" || "iam" || "acm", * // }, * // Restrictions: { // Restrictions * // GeoRestriction: { // GeoRestriction * // RestrictionType: "blacklist" || "whitelist" || "none", // required * // Quantity: Number("int"), // required * // Items: [ // LocationList * // "STRING_VALUE", * // ], * // }, * // }, * // WebACLId: "STRING_VALUE", // required * // HttpVersion: "http1.1" || "http2" || "http3" || "http2and3", // required * // IsIPV6Enabled: true || false, // required * // AliasICPRecordals: [ // AliasICPRecordals * // { // AliasICPRecordal * // CNAME: "STRING_VALUE", * // ICPRecordalStatus: "APPROVED" || "SUSPENDED" || "PENDING", * // }, * // ], * // Staging: true || false, // required * // ConnectionMode: "direct" || "tenant-only", * // AnycastIpListId: "STRING_VALUE", * // }, * // ], * // }, * // }; * * ``` * * @param ListDistributionsCommandInput - {@link ListDistributionsCommandInput} * @returns {@link ListDistributionsCommandOutput} * @see {@link ListDistributionsCommandInput} for command's `input` shape. * @see {@link ListDistributionsCommandOutput} for command's `response` shape. * @see {@link CloudFrontClientResolvedConfig | config} for CloudFrontClient's `config` shape. * * @throws {@link InvalidArgument} (client fault) *

An argument is invalid.

* * @throws {@link CloudFrontServiceException} *

Base exception class for all service exceptions from CloudFront service.

* * * @public */ export declare class ListDistributionsCommand extends ListDistributionsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListDistributionsRequest; output: ListDistributionsResult; }; sdk: { input: ListDistributionsCommandInput; output: ListDistributionsCommandOutput; }; }; }