@aws-sdk/client-cloudfront 3.321.1 → 3.326.0

package/dist-types/commands/AssociateAliasCommand.d.ts

@@ -42,6 +42,8 @@ export interface AssociateAliasCommandOutput extends __MetadataBearer {
  * };
  * const command = new AssociateAliasCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param AssociateAliasCommandInput - {@link AssociateAliasCommandInput}
@@ -65,6 +67,8 @@ export interface AssociateAliasCommandOutput extends __MetadataBearer {
  * @throws {@link TooManyDistributionCNAMEs} (client fault)
  *  <p>Your request contains more CNAMEs than are allowed per distribution.</p>
  *
+ * @throws {@link CloudFrontServiceException}
+ * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
  */
 export declare class AssociateAliasCommand extends $Command<AssociateAliasCommandInput, AssociateAliasCommandOutput, CloudFrontClientResolvedConfig> {

package/dist-types/commands/CopyDistributionCommand.d.ts

@@ -40,6 +40,342 @@ export interface CopyDistributionCommandOutput extends CopyDistributionResult, _
  * };
  * const command = new CopyDistributionCommand(input);
  * const response = await client.send(command);
+ * // { // CopyDistributionResult
+ * //   Distribution: { // Distribution
+ * //     Id: "STRING_VALUE", // required
+ * //     ARN: "STRING_VALUE", // required
+ * //     Status: "STRING_VALUE", // required
+ * //     LastModifiedTime: new Date("TIMESTAMP"), // required
+ * //     InProgressInvalidationBatches: Number("int"), // required
+ * //     DomainName: "STRING_VALUE", // required
+ * //     ActiveTrustedSigners: { // ActiveTrustedSigners
+ * //       Enabled: true || false, // required
+ * //       Quantity: Number("int"), // required
+ * //       Items: [ // SignerList
+ * //         { // Signer
+ * //           AwsAccountNumber: "STRING_VALUE",
+ * //           KeyPairIds: { // KeyPairIds
+ * //             Quantity: Number("int"), // required
+ * //             Items: [ // KeyPairIdList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //     ActiveTrustedKeyGroups: { // ActiveTrustedKeyGroups
+ * //       Enabled: true || false, // required
+ * //       Quantity: Number("int"), // required
+ * //       Items: [ // KGKeyPairIdsList
+ * //         { // KGKeyPairIds
+ * //           KeyGroupId: "STRING_VALUE",
+ * //           KeyPairIds: {
+ * //             Quantity: Number("int"), // required
+ * //             Items: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //     DistributionConfig: { // DistributionConfig
+ * //       CallerReference: "STRING_VALUE", // required
+ * //       Aliases: { // Aliases
+ * //         Quantity: Number("int"), // required
+ * //         Items: [ // AliasList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       DefaultRootObject: "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"),
+ * //             },
+ * //             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
+ * //                 },
+ * //               ],
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //       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",
+ * //         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: "<MethodsList>", // required
+ * //               CachedMethods: {
+ * //                 Quantity: Number("int"), // required
+ * //                 Items: "<MethodsList>", // 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",
+ * //             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
+ * //       Logging: { // LoggingConfig
+ * //         Enabled: true || false, // required
+ * //         IncludeCookies: true || false, // required
+ * //         Bucket: "STRING_VALUE", // required
+ * //         Prefix: "STRING_VALUE", // required
+ * //       },
+ * //       PriceClass: "PriceClass_100" || "PriceClass_200" || "PriceClass_All",
+ * //       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",
+ * //       HttpVersion: "http1.1" || "http2" || "http3" || "http2and3",
+ * //       IsIPV6Enabled: true || false,
+ * //       ContinuousDeploymentPolicyId: "STRING_VALUE",
+ * //       Staging: true || false,
+ * //     },
+ * //     AliasICPRecordals: [ // AliasICPRecordals
+ * //       { // AliasICPRecordal
+ * //         CNAME: "STRING_VALUE",
+ * //         ICPRecordalStatus: "APPROVED" || "SUSPENDED" || "PENDING",
+ * //       },
+ * //     ],
+ * //   },
+ * //   Location: "STRING_VALUE",
+ * //   ETag: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CopyDistributionCommandInput - {@link CopyDistributionCommandInput}
@@ -274,6 +610,8 @@ export interface CopyDistributionCommandOutput extends CopyDistributionResult, _
  * @throws {@link TrustedSignerDoesNotExist} (client fault)
  *  <p>One or more of your trusted signers don't exist.</p>
  *
+ * @throws {@link CloudFrontServiceException}
+ * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
  */
 export declare class CopyDistributionCommand extends $Command<CopyDistributionCommandInput, CopyDistributionCommandOutput, CloudFrontClientResolvedConfig> {

package/dist-types/commands/CreateCachePolicyCommand.d.ts

@@ -90,6 +90,53 @@ export interface CreateCachePolicyCommandOutput extends CreateCachePolicyResult,
  * };
  * const command = new CreateCachePolicyCommand(input);
  * const response = await client.send(command);
+ * // { // CreateCachePolicyResult
+ * //   CachePolicy: { // CachePolicy
+ * //     Id: "STRING_VALUE", // required
+ * //     LastModifiedTime: new Date("TIMESTAMP"), // required
+ * //     CachePolicyConfig: { // CachePolicyConfig
+ * //       Comment: "STRING_VALUE",
+ * //       Name: "STRING_VALUE", // required
+ * //       DefaultTTL: Number("long"),
+ * //       MaxTTL: Number("long"),
+ * //       MinTTL: Number("long"), // required
+ * //       ParametersInCacheKeyAndForwardedToOrigin: { // ParametersInCacheKeyAndForwardedToOrigin
+ * //         EnableAcceptEncodingGzip: true || false, // required
+ * //         EnableAcceptEncodingBrotli: true || false,
+ * //         HeadersConfig: { // CachePolicyHeadersConfig
+ * //           HeaderBehavior: "none" || "whitelist", // required
+ * //           Headers: { // Headers
+ * //             Quantity: Number("int"), // required
+ * //             Items: [ // HeaderList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //         CookiesConfig: { // CachePolicyCookiesConfig
+ * //           CookieBehavior: "none" || "whitelist" || "allExcept" || "all", // required
+ * //           Cookies: { // CookieNames
+ * //             Quantity: Number("int"), // required
+ * //             Items: [ // CookieNameList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //         QueryStringsConfig: { // CachePolicyQueryStringsConfig
+ * //           QueryStringBehavior: "none" || "whitelist" || "allExcept" || "all", // required
+ * //           QueryStrings: { // QueryStringNames
+ * //             Quantity: Number("int"), // required
+ * //             Items: [ // QueryStringNamesList
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   },
+ * //   Location: "STRING_VALUE",
+ * //   ETag: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateCachePolicyCommandInput - {@link CreateCachePolicyCommandInput}
@@ -132,6 +179,8 @@ export interface CreateCachePolicyCommandOutput extends CreateCachePolicyResult,
  * 			information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html">Quotas</a> (formerly known as limits) in the
  * 				<i>Amazon CloudFront Developer Guide</i>.</p>
  *
+ * @throws {@link CloudFrontServiceException}
+ * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
  */
 export declare class CreateCachePolicyCommand extends $Command<CreateCachePolicyCommandInput, CreateCachePolicyCommandOutput, CloudFrontClientResolvedConfig> {

package/dist-types/commands/CreateCloudFrontOriginAccessIdentityCommand.d.ts

@@ -38,6 +38,19 @@ export interface CreateCloudFrontOriginAccessIdentityCommandOutput extends Creat
  * };
  * const command = new CreateCloudFrontOriginAccessIdentityCommand(input);
  * const response = await client.send(command);
+ * // { // CreateCloudFrontOriginAccessIdentityResult
+ * //   CloudFrontOriginAccessIdentity: { // CloudFrontOriginAccessIdentity
+ * //     Id: "STRING_VALUE", // required
+ * //     S3CanonicalUserId: "STRING_VALUE", // required
+ * //     CloudFrontOriginAccessIdentityConfig: { // CloudFrontOriginAccessIdentityConfig
+ * //       CallerReference: "STRING_VALUE", // required
+ * //       Comment: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * //   Location: "STRING_VALUE",
+ * //   ETag: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateCloudFrontOriginAccessIdentityCommandInput - {@link CreateCloudFrontOriginAccessIdentityCommandInput}
@@ -68,6 +81,8 @@ export interface CreateCloudFrontOriginAccessIdentityCommandOutput extends Creat
  *  <p>Processing your request would cause you to exceed the maximum number of origin access
  * 			identities allowed.</p>
  *
+ * @throws {@link CloudFrontServiceException}
+ * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
  */
 export declare class CreateCloudFrontOriginAccessIdentityCommand extends $Command<CreateCloudFrontOriginAccessIdentityCommandInput, CreateCloudFrontOriginAccessIdentityCommandOutput, CloudFrontClientResolvedConfig> {

package/dist-types/commands/CreateContinuousDeploymentPolicyCommand.d.ts

@@ -61,6 +61,38 @@ export interface CreateContinuousDeploymentPolicyCommandOutput extends CreateCon
  * };
  * const command = new CreateContinuousDeploymentPolicyCommand(input);
  * const response = await client.send(command);
+ * // { // CreateContinuousDeploymentPolicyResult
+ * //   ContinuousDeploymentPolicy: { // ContinuousDeploymentPolicy
+ * //     Id: "STRING_VALUE", // required
+ * //     LastModifiedTime: new Date("TIMESTAMP"), // required
+ * //     ContinuousDeploymentPolicyConfig: { // ContinuousDeploymentPolicyConfig
+ * //       StagingDistributionDnsNames: { // StagingDistributionDnsNames
+ * //         Quantity: Number("int"), // required
+ * //         Items: [ // StagingDistributionDnsNameList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       Enabled: true || false, // required
+ * //       TrafficConfig: { // TrafficConfig
+ * //         SingleWeightConfig: { // ContinuousDeploymentSingleWeightConfig
+ * //           Weight: Number("float"), // required
+ * //           SessionStickinessConfig: { // SessionStickinessConfig
+ * //             IdleTTL: Number("int"), // required
+ * //             MaximumTTL: Number("int"), // required
+ * //           },
+ * //         },
+ * //         SingleHeaderConfig: { // ContinuousDeploymentSingleHeaderConfig
+ * //           Header: "STRING_VALUE", // required
+ * //           Value: "STRING_VALUE", // required
+ * //         },
+ * //         Type: "SingleWeight" || "SingleHeader", // required
+ * //       },
+ * //     },
+ * //   },
+ * //   Location: "STRING_VALUE",
+ * //   ETag: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param CreateContinuousDeploymentPolicyCommandInput - {@link CreateContinuousDeploymentPolicyCommandInput}
@@ -89,6 +121,8 @@ export interface CreateContinuousDeploymentPolicyCommandOutput extends CreateCon
  *  <p>You have reached the maximum number of continuous deployment policies for this
  * 			Amazon Web Services account.</p>
  *
+ * @throws {@link CloudFrontServiceException}
+ * <p>Base exception class for all service exceptions from CloudFront service.</p>
  *
  */
 export declare class CreateContinuousDeploymentPolicyCommand extends $Command<CreateContinuousDeploymentPolicyCommandInput, CreateContinuousDeploymentPolicyCommandOutput, CloudFrontClientResolvedConfig> {