@aws-sdk/client-cloudfront 3.224.0 → 3.226.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +4 -3
  2. package/dist-cjs/CloudFront.js +15 -0
  3. package/dist-cjs/commands/UpdateDistributionWithStagingConfigCommand.js +46 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoint/ruleset.js +0 -9
  6. package/dist-cjs/models/models_0.js +61 -51
  7. package/dist-cjs/models/models_1.js +60 -5
  8. package/dist-cjs/protocols/Aws_restXml.js +351 -7
  9. package/dist-es/CloudFront.js +15 -0
  10. package/dist-es/commands/UpdateDistributionWithStagingConfigCommand.js +42 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoint/ruleset.js +0 -9
  13. package/dist-es/models/models_0.js +52 -42
  14. package/dist-es/models/models_1.js +49 -0
  15. package/dist-es/protocols/Aws_restXml.js +344 -2
  16. package/dist-types/CloudFront.d.ts +252 -216
  17. package/dist-types/CloudFrontClient.d.ts +7 -5
  18. package/dist-types/commands/AssociateAliasCommand.d.ts +2 -2
  19. package/dist-types/commands/CopyDistributionCommand.d.ts +5 -5
  20. package/dist-types/commands/CreateCachePolicyCommand.d.ts +15 -13
  21. package/dist-types/commands/CreateCloudFrontOriginAccessIdentityCommand.d.ts +4 -3
  22. package/dist-types/commands/CreateContinuousDeploymentPolicyCommand.d.ts +9 -10
  23. package/dist-types/commands/CreateFunctionCommand.d.ts +4 -4
  24. package/dist-types/commands/CreateKeyGroupCommand.d.ts +8 -7
  25. package/dist-types/commands/CreateMonitoringSubscriptionCommand.d.ts +2 -2
  26. package/dist-types/commands/CreateOriginAccessControlCommand.d.ts +4 -4
  27. package/dist-types/commands/CreateOriginRequestPolicyCommand.d.ts +12 -10
  28. package/dist-types/commands/CreateRealtimeLogConfigCommand.d.ts +2 -1
  29. package/dist-types/commands/CreateResponseHeadersPolicyCommand.d.ts +4 -4
  30. package/dist-types/commands/CreateStreamingDistributionCommand.d.ts +3 -3
  31. package/dist-types/commands/CreateStreamingDistributionWithTagsCommand.d.ts +3 -3
  32. package/dist-types/commands/DeleteCachePolicyCommand.d.ts +5 -5
  33. package/dist-types/commands/DeleteFunctionCommand.d.ts +5 -5
  34. package/dist-types/commands/DeleteKeyGroupCommand.d.ts +1 -1
  35. package/dist-types/commands/DeleteMonitoringSubscriptionCommand.d.ts +2 -1
  36. package/dist-types/commands/DeleteOriginAccessControlCommand.d.ts +3 -3
  37. package/dist-types/commands/DeleteOriginRequestPolicyCommand.d.ts +6 -6
  38. package/dist-types/commands/DeleteRealtimeLogConfigCommand.d.ts +2 -2
  39. package/dist-types/commands/DeleteStreamingDistributionCommand.d.ts +22 -20
  40. package/dist-types/commands/DescribeFunctionCommand.d.ts +2 -2
  41. package/dist-types/commands/GetCachePolicyCommand.d.ts +5 -5
  42. package/dist-types/commands/GetCachePolicyConfigCommand.d.ts +3 -3
  43. package/dist-types/commands/GetKeyGroupCommand.d.ts +3 -2
  44. package/dist-types/commands/GetKeyGroupConfigCommand.d.ts +1 -1
  45. package/dist-types/commands/GetMonitoringSubscriptionCommand.d.ts +2 -2
  46. package/dist-types/commands/GetOriginRequestPolicyCommand.d.ts +6 -5
  47. package/dist-types/commands/GetOriginRequestPolicyConfigCommand.d.ts +5 -5
  48. package/dist-types/commands/GetRealtimeLogConfigCommand.d.ts +3 -3
  49. package/dist-types/commands/GetResponseHeadersPolicyCommand.d.ts +2 -2
  50. package/dist-types/commands/GetResponseHeadersPolicyConfigCommand.d.ts +2 -2
  51. package/dist-types/commands/GetStreamingDistributionCommand.d.ts +2 -1
  52. package/dist-types/commands/ListCachePoliciesCommand.d.ts +2 -2
  53. package/dist-types/commands/ListConflictingAliasesCommand.d.ts +8 -8
  54. package/dist-types/commands/ListDistributionsByKeyGroupCommand.d.ts +2 -2
  55. package/dist-types/commands/ListDistributionsByRealtimeLogConfigCommand.d.ts +4 -4
  56. package/dist-types/commands/ListFieldLevelEncryptionConfigsCommand.d.ts +2 -1
  57. package/dist-types/commands/ListFieldLevelEncryptionProfilesCommand.d.ts +2 -1
  58. package/dist-types/commands/ListOriginAccessControlsCommand.d.ts +5 -5
  59. package/dist-types/commands/ListOriginRequestPoliciesCommand.d.ts +2 -2
  60. package/dist-types/commands/PublishFunctionCommand.d.ts +10 -9
  61. package/dist-types/commands/TestFunctionCommand.d.ts +9 -9
  62. package/dist-types/commands/UpdateContinuousDeploymentPolicyCommand.d.ts +4 -3
  63. package/dist-types/commands/UpdateDistributionCommand.d.ts +14 -13
  64. package/dist-types/commands/UpdateDistributionWithStagingConfigCommand.d.ts +46 -0
  65. package/dist-types/commands/UpdateFunctionCommand.d.ts +3 -3
  66. package/dist-types/commands/UpdateKeyGroupCommand.d.ts +1 -1
  67. package/dist-types/commands/UpdateOriginRequestPolicyCommand.d.ts +2 -1
  68. package/dist-types/commands/UpdatePublicKeyCommand.d.ts +2 -1
  69. package/dist-types/commands/UpdateRealtimeLogConfigCommand.d.ts +1 -1
  70. package/dist-types/commands/index.d.ts +1 -0
  71. package/dist-types/models/models_0.d.ts +1291 -1191
  72. package/dist-types/models/models_1.d.ts +488 -325
  73. package/dist-types/protocols/Aws_restXml.d.ts +3 -0
  74. package/dist-types/ts3.4/CloudFront.d.ts +23 -0
  75. package/dist-types/ts3.4/CloudFrontClient.d.ts +6 -0
  76. package/dist-types/ts3.4/commands/UpdateDistributionWithStagingConfigCommand.d.ts +41 -0
  77. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  78. package/dist-types/ts3.4/models/models_0.d.ts +46 -38
  79. package/dist-types/ts3.4/models/models_1.d.ts +54 -1
  80. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +12 -0
  81. package/package.json +29 -29
@@ -8,12 +8,13 @@ export interface GetKeyGroupCommandInput extends GetKeyGroupRequest {
8
8
  export interface GetKeyGroupCommandOutput extends GetKeyGroupResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets a key group, including the date and time when the key group was last modified.</p>
11
+ * <p>Gets a key group, including the date and time when the key group was last
12
+ * modified.</p>
12
13
  * <p>To get a key group, you must provide the key group’s identifier. If the key group is
13
14
  * referenced in a distribution’s cache behavior, you can get the key group’s identifier
14
15
  * using <code>ListDistributions</code> or <code>GetDistribution</code>. If the key group
15
16
  * is not referenced in a cache behavior, you can get the identifier using
16
- * <code>ListKeyGroups</code>.</p>
17
+ * <code>ListKeyGroups</code>.</p>
17
18
  * @example
18
19
  * Use a bare-bones client and the command you need to make an API call.
19
20
  * ```javascript
@@ -13,7 +13,7 @@ export interface GetKeyGroupConfigCommandOutput extends GetKeyGroupConfigResult,
13
13
  * key group is referenced in a distribution’s cache behavior, you can get the key group’s
14
14
  * identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the
15
15
  * key group is not referenced in a cache behavior, you can get the identifier using
16
- * <code>ListKeyGroups</code>.</p>
16
+ * <code>ListKeyGroups</code>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -8,8 +8,8 @@ export interface GetMonitoringSubscriptionCommandInput extends GetMonitoringSubs
8
8
  export interface GetMonitoringSubscriptionCommandOutput extends GetMonitoringSubscriptionResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets information about whether additional CloudWatch metrics are enabled for the specified
12
- * CloudFront distribution.</p>
11
+ * <p>Gets information about whether additional CloudWatch metrics are enabled for the
12
+ * specified CloudFront distribution.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -17,11 +17,12 @@ export interface GetOriginRequestPolicyCommandOutput extends GetOriginRequestPol
17
17
  * <p>The date and time when the policy was last modified.</p>
18
18
  * </li>
19
19
  * </ul>
20
- * <p>To get an origin request policy, you must provide the policy’s identifier. If the origin
21
- * request policy is attached to a distribution’s cache behavior, you can get the policy’s
22
- * identifier using <code>ListDistributions</code> or <code>GetDistribution</code>. If the
23
- * origin request policy is not attached to a cache behavior, you can get the identifier
24
- * using <code>ListOriginRequestPolicies</code>.</p>
20
+ * <p>To get an origin request policy, you must provide the policy’s identifier. If the
21
+ * origin request policy is attached to a distribution’s cache behavior, you can get the
22
+ * policy’s identifier using <code>ListDistributions</code> or
23
+ * <code>GetDistribution</code>. If the origin request policy is not attached to a cache
24
+ * behavior, you can get the identifier using
25
+ * <code>ListOriginRequestPolicies</code>.</p>
25
26
  * @example
26
27
  * Use a bare-bones client and the command you need to make an API call.
27
28
  * ```javascript
@@ -9,11 +9,11 @@ export interface GetOriginRequestPolicyConfigCommandOutput extends GetOriginRequ
9
9
  }
10
10
  /**
11
11
  * <p>Gets an origin request policy configuration.</p>
12
- * <p>To get an origin request policy configuration, you must provide the policy’s identifier. If
13
- * the origin request policy is attached to a distribution’s cache behavior, you can get
14
- * the policy’s identifier using <code>ListDistributions</code> or
15
- * <code>GetDistribution</code>. If the origin request policy is not attached to a cache
16
- * behavior, you can get the identifier using
12
+ * <p>To get an origin request policy configuration, you must provide the policy’s
13
+ * identifier. If the origin request policy is attached to a distribution’s cache behavior,
14
+ * you can get the policy’s identifier using <code>ListDistributions</code> or
15
+ * <code>GetDistribution</code>. If the origin request policy is not attached to a
16
+ * cache behavior, you can get the identifier using
17
17
  * <code>ListOriginRequestPolicies</code>.</p>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,9 +9,9 @@ export interface GetRealtimeLogConfigCommandOutput extends GetRealtimeLogConfigR
9
9
  }
10
10
  /**
11
11
  * <p>Gets a real-time log configuration.</p>
12
- * <p>To get a real-time log configuration, you can provide the configuration’s name or its Amazon
13
- * Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the
14
- * name to identify the real-time log configuration to get.</p>
12
+ * <p>To get a real-time log configuration, you can provide the configuration’s name or its
13
+ * Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront
14
+ * uses the name to identify the real-time log configuration to get.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -8,8 +8,8 @@ export interface GetResponseHeadersPolicyCommandInput extends GetResponseHeaders
8
8
  export interface GetResponseHeadersPolicyCommandOutput extends GetResponseHeadersPolicyResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets a response headers policy, including metadata (the policy’s identifier and the date and
12
- * time when the policy was last modified).</p>
11
+ * <p>Gets a response headers policy, including metadata (the policy’s identifier and the
12
+ * date and time when the policy was last modified).</p>
13
13
  * <p>To get a response headers policy, you must provide the policy’s identifier. If the
14
14
  * response headers policy is attached to a distribution’s cache behavior, you can get the
15
15
  * policy’s identifier using <code>ListDistributions</code> or
@@ -12,9 +12,9 @@ export interface GetResponseHeadersPolicyConfigCommandOutput extends GetResponse
12
12
  * <p>To get a response headers policy configuration, you must provide the policy’s
13
13
  * identifier. If the response headers policy is attached to a distribution’s cache
14
14
  * behavior, you can get the policy’s identifier using <code>ListDistributions</code> or
15
- * <code>GetDistribution</code>. If the response headers policy is not attached to a
15
+ * <code>GetDistribution</code>. If the response headers policy is not attached to a
16
16
  * cache behavior, you can get the identifier using
17
- * <code>ListResponseHeadersPolicies</code>.</p>
17
+ * <code>ListResponseHeadersPolicies</code>.</p>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
20
20
  * ```javascript
@@ -8,7 +8,8 @@ export interface GetStreamingDistributionCommandInput extends GetStreamingDistri
8
8
  export interface GetStreamingDistributionCommandOutput extends GetStreamingDistributionResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets information about a specified RTMP distribution, including the distribution configuration.</p>
11
+ * <p>Gets information about a specified RTMP distribution, including the distribution
12
+ * configuration.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -9,8 +9,8 @@ export interface ListCachePoliciesCommandOutput extends ListCachePoliciesResult,
9
9
  }
10
10
  /**
11
11
  * <p>Gets a list of cache policies.</p>
12
- * <p>You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or
13
- * only the custom policies created in your Amazon Web Services account.</p>
12
+ * <p>You can optionally apply a filter to return only the managed policies created by
13
+ * Amazon Web Services, or only the custom policies created in your Amazon Web Services account.</p>
14
14
  * <p>You can optionally specify the maximum number of items to receive in the response. If
15
15
  * the total number of items in the list exceeds the maximum that you specify, or the
16
16
  * default maximum, the response is paginated. To get the next page of items, send a
@@ -18,14 +18,14 @@ export interface ListConflictingAliasesCommandOutput extends ListConflictingAlia
18
18
  * input, the returned list can include <code>www.example.com</code> and the overlapping
19
19
  * wildcard alternate domain name (<code>*.example.com</code>), if they exist. If you
20
20
  * provide <code>*.example.com</code> as input, the returned list can include
21
- * <code>*.example.com</code> and any alternate domain names covered by that wildcard (for
22
- * example, <code>www.example.com</code>, <code>test.example.com</code>,
23
- * <code>dev.example.com</code>, and so on), if they exist.</p>
24
- * <p>To list conflicting aliases, you provide the alias to search and the ID of a distribution in
25
- * your account that has an attached SSL/TLS certificate that includes the provided alias.
26
- * For more information, including how to set up the distribution and certificate, see
27
- * <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move">Moving an alternate domain name to a different distribution</a>
28
- * in the <i>Amazon CloudFront Developer Guide</i>.</p>
21
+ * <code>*.example.com</code> and any alternate domain names covered by that wildcard
22
+ * (for example, <code>www.example.com</code>, <code>test.example.com</code>,
23
+ * <code>dev.example.com</code>, and so on), if they exist.</p>
24
+ * <p>To list conflicting aliases, you provide the alias to search and the ID of a
25
+ * distribution in your account that has an attached SSL/TLS certificate that includes the
26
+ * provided alias. For more information, including how to set up the distribution and
27
+ * certificate, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move">Moving an alternate domain name to a different
28
+ * distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
29
29
  * <p>You can optionally specify the maximum number of items to receive in the response. If
30
30
  * the total number of items in the list exceeds the maximum that you specify, or the
31
31
  * default maximum, the response is paginated. To get the next page of items, send a
@@ -8,8 +8,8 @@ export interface ListDistributionsByKeyGroupCommandInput extends ListDistributio
8
8
  export interface ListDistributionsByKeyGroupCommandOutput extends ListDistributionsByKeyGroupResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets a list of distribution IDs for distributions that have a cache behavior that references
12
- * the specified key group.</p>
11
+ * <p>Gets a list of distribution IDs for distributions that have a cache behavior that
12
+ * references the specified key group.</p>
13
13
  * <p>You can optionally specify the maximum number of items to receive in the response. If
14
14
  * the total number of items in the list exceeds the maximum that you specify, or the
15
15
  * default maximum, the response is paginated. To get the next page of items, send a
@@ -8,10 +8,10 @@ export interface ListDistributionsByRealtimeLogConfigCommandInput extends ListDi
8
8
  export interface ListDistributionsByRealtimeLogConfigCommandOutput extends ListDistributionsByRealtimeLogConfigResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Gets a list of distributions that have a cache behavior that’s associated with the specified
12
- * real-time log configuration.</p>
13
- * <p>You can specify the real-time log configuration by its name or its Amazon Resource Name
14
- * (ARN). You must provide at least one. If you provide both, CloudFront uses the name to
11
+ * <p>Gets a list of distributions that have a cache behavior that’s associated with the
12
+ * specified real-time log configuration.</p>
13
+ * <p>You can specify the real-time log configuration by its name or its Amazon Resource
14
+ * Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to
15
15
  * identify the real-time log configuration to list distributions for.</p>
16
16
  * <p>You can optionally specify the maximum number of items to receive in the response. If
17
17
  * the total number of items in the list exceeds the maximum that you specify, or the
@@ -8,7 +8,8 @@ export interface ListFieldLevelEncryptionConfigsCommandInput extends ListFieldLe
8
8
  export interface ListFieldLevelEncryptionConfigsCommandOutput extends ListFieldLevelEncryptionConfigsResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>List all field-level encryption configurations that have been created in CloudFront for this account.</p>
11
+ * <p>List all field-level encryption configurations that have been created in CloudFront for this
12
+ * account.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -8,7 +8,8 @@ export interface ListFieldLevelEncryptionProfilesCommandInput extends ListFieldL
8
8
  export interface ListFieldLevelEncryptionProfilesCommandOutput extends ListFieldLevelEncryptionProfilesResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Request a list of field-level encryption profiles that have been created in CloudFront for this account.</p>
11
+ * <p>Request a list of field-level encryption profiles that have been created in CloudFront for
12
+ * this account.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -9,11 +9,11 @@ export interface ListOriginAccessControlsCommandOutput extends ListOriginAccessC
9
9
  }
10
10
  /**
11
11
  * <p>Gets the list of CloudFront origin access controls in this Amazon Web Services account.</p>
12
- * <p>You can optionally specify the maximum number of items to receive in the response. If the
13
- * total number of items in the list exceeds the maximum that you specify, or the default
14
- * maximum, the response is paginated. To get the next page of items, send another request
15
- * that specifies the <code>NextMarker</code> value from the current response as the
16
- * <code>Marker</code> value in the next request.</p>
12
+ * <p>You can optionally specify the maximum number of items to receive in the response. If
13
+ * the total number of items in the list exceeds the maximum that you specify, or the
14
+ * default maximum, the response is paginated. To get the next page of items, send another
15
+ * request that specifies the <code>NextMarker</code> value from the current response as
16
+ * the <code>Marker</code> value in the next request.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -9,8 +9,8 @@ export interface ListOriginRequestPoliciesCommandOutput extends ListOriginReques
9
9
  }
10
10
  /**
11
11
  * <p>Gets a list of origin request policies.</p>
12
- * <p>You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or
13
- * only the custom policies created in your Amazon Web Services account.</p>
12
+ * <p>You can optionally apply a filter to return only the managed policies created by
13
+ * Amazon Web Services, or only the custom policies created in your Amazon Web Services account.</p>
14
14
  * <p>You can optionally specify the maximum number of items to receive in the response. If
15
15
  * the total number of items in the list exceeds the maximum that you specify, or the
16
16
  * default maximum, the response is paginated. To get the next page of items, send a
@@ -8,15 +8,16 @@ export interface PublishFunctionCommandInput extends PublishFunctionRequest {
8
8
  export interface PublishFunctionCommandOutput extends PublishFunctionResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Publishes a CloudFront function by copying the function code from the <code>DEVELOPMENT</code>
12
- * stage to <code>LIVE</code>. This automatically updates all cache behaviors that are
13
- * using this function to use the newly published copy in the <code>LIVE</code>
14
- * stage.</p>
15
- * <p>When a function is published to the <code>LIVE</code> stage, you can attach the function to
16
- * a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).</p>
17
- * <p>To publish a function, you must provide the function’s name and version (<code>ETag</code>
18
- * value). To get these values, you can use <code>ListFunctions</code> and
19
- * <code>DescribeFunction</code>.</p>
11
+ * <p>Publishes a CloudFront function by copying the function code from the
12
+ * <code>DEVELOPMENT</code> stage to <code>LIVE</code>. This automatically updates all
13
+ * cache behaviors that are using this function to use the newly published copy in the
14
+ * <code>LIVE</code> stage.</p>
15
+ * <p>When a function is published to the <code>LIVE</code> stage, you can attach the
16
+ * function to a distribution’s cache behavior, using the function’s Amazon Resource Name
17
+ * (ARN).</p>
18
+ * <p>To publish a function, you must provide the function’s name and version
19
+ * (<code>ETag</code> value). To get these values, you can use
20
+ * <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
20
21
  * @example
21
22
  * Use a bare-bones client and the command you need to make an API call.
22
23
  * ```javascript
@@ -9,15 +9,15 @@ export interface TestFunctionCommandOutput extends TestFunctionResult, __Metadat
9
9
  }
10
10
  /**
11
11
  * <p>Tests a CloudFront function.</p>
12
- * <p>To test a function, you provide an <i>event object</i> that represents an HTTP
13
- * request or response that your CloudFront distribution could receive in production. CloudFront runs
14
- * the function, passing it the event object that you provided, and returns the function’s
15
- * result (the modified event object) in the response. The response also contains function
16
- * logs and error messages, if any exist. For more information about testing functions, see
17
- * <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function">Testing functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
18
- * <p>To test a function, you provide the function’s name and version (<code>ETag</code> value)
19
- * along with the event object. To get the function’s name and version, you can use
20
- * <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
12
+ * <p>To test a function, you provide an <i>event object</i> that represents
13
+ * an HTTP request or response that your CloudFront distribution could receive in production.
14
+ * CloudFront runs the function, passing it the event object that you provided, and returns the
15
+ * function’s result (the modified event object) in the response. The response also
16
+ * contains function logs and error messages, if any exist. For more information about
17
+ * testing functions, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function">Testing functions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>
18
+ * <p>To test a function, you provide the function’s name and version (<code>ETag</code>
19
+ * value) along with the event object. To get the function’s name and version, you can use
20
+ * <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
23
23
  * ```javascript
@@ -8,9 +8,10 @@ export interface UpdateContinuousDeploymentPolicyCommandInput extends UpdateCont
8
8
  export interface UpdateContinuousDeploymentPolicyCommandOutput extends UpdateContinuousDeploymentPolicyResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Updates a continuous deployment policy. You can update a continuous deployment policy to
12
- * enable or disable it, to change the percentage of traffic that it sends to the staging
13
- * distribution, or to change the staging distribution that it sends traffic to.</p>
11
+ * <p>Updates a continuous deployment policy. You can update a continuous deployment policy
12
+ * to enable or disable it, to change the percentage of traffic that it sends to the
13
+ * staging distribution, or to change the staging distribution that it sends traffic
14
+ * to.</p>
14
15
  * <p>When you update a continuous deployment policy configuration, all the fields are
15
16
  * updated with the values that are provided in the request. You cannot update some fields
16
17
  * independent of others. To update a continuous deployment policy configuration:</p>
@@ -9,21 +9,22 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul
9
9
  }
10
10
  /**
11
11
  * <p>Updates the configuration for a CloudFront distribution.</p>
12
- * <p>The update process includes getting the current distribution configuration, updating it to
13
- * make your changes, and then submitting an <code>UpdateDistribution</code> request to
14
- * make the updates.</p>
12
+ * <p>The update process includes getting the current distribution configuration, updating
13
+ * it to make your changes, and then submitting an <code>UpdateDistribution</code> request
14
+ * to make the updates.</p>
15
15
  *
16
16
  * <p>
17
- * <b>To update a web distribution using the CloudFront API</b>
17
+ * <b>To update a web distribution using the CloudFront
18
+ * API</b>
18
19
  * </p>
19
20
  * <ol>
20
21
  * <li>
21
- * <p>Use <code>GetDistributionConfig</code> to get the current configuration, including the version
22
- * identifier (<code>ETag</code>).</p>
22
+ * <p>Use <code>GetDistributionConfig</code> to get the current configuration,
23
+ * including the version identifier (<code>ETag</code>).</p>
23
24
  * </li>
24
25
  * <li>
25
- * <p>Update the distribution configuration that was returned in the response. Note the following
26
- * important requirements and restrictions:</p>
26
+ * <p>Update the distribution configuration that was returned in the response. Note
27
+ * the following important requirements and restrictions:</p>
27
28
  * <ul>
28
29
  * <li>
29
30
  * <p>You must rename the <code>ETag</code> field to <code>IfMatch</code>,
@@ -37,11 +38,11 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul
37
38
  * </ul>
38
39
  * </li>
39
40
  * <li>
40
- * <p>Submit an <code>UpdateDistribution</code> request, providing the distribution configuration.
41
- * The new configuration replaces the existing configuration. The values that you
42
- * specify in an <code>UpdateDistribution</code> request are not merged into your
43
- * existing configuration. Make sure to include all fields: the ones that you
44
- * modified and also the ones that you didn’t.</p>
41
+ * <p>Submit an <code>UpdateDistribution</code> request, providing the distribution
42
+ * configuration. The new configuration replaces the existing configuration. The
43
+ * values that you specify in an <code>UpdateDistribution</code> request are not
44
+ * merged into your existing configuration. Make sure to include all fields: the
45
+ * ones that you modified and also the ones that you didn’t.</p>
45
46
  * </li>
46
47
  * </ol>
47
48
  * @example
@@ -0,0 +1,46 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CloudFrontClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFrontClient";
5
+ import { UpdateDistributionWithStagingConfigRequest, UpdateDistributionWithStagingConfigResult } from "../models/models_1";
6
+ export interface UpdateDistributionWithStagingConfigCommandInput extends UpdateDistributionWithStagingConfigRequest {
7
+ }
8
+ export interface UpdateDistributionWithStagingConfigCommandOutput extends UpdateDistributionWithStagingConfigResult, __MetadataBearer {
9
+ }
10
+ /**
11
+ * <p>Copies the staging distribution's configuration to its corresponding primary
12
+ * distribution. The primary distribution retains its <code>Aliases</code> (also known as
13
+ * alternate domain names or CNAMEs) and <code>ContinuousDeploymentPolicyId</code> value,
14
+ * but otherwise its configuration is overwritten to match the staging distribution.</p>
15
+ * <p>You can use this operation in a continuous deployment workflow after you have tested
16
+ * configuration changes on the staging distribution. After using a continuous deployment
17
+ * policy to move a portion of your domain name’s traffic to the staging distribution and
18
+ * verifying that it works as intended, you can use this operation to copy the staging
19
+ * distribution’s configuration to the primary distribution. This action will disable the
20
+ * continuous deployment policy and move your domain’s traffic back to the primary distribution.</p>
21
+ * @example
22
+ * Use a bare-bones client and the command you need to make an API call.
23
+ * ```javascript
24
+ * import { CloudFrontClient, UpdateDistributionWithStagingConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import
25
+ * // const { CloudFrontClient, UpdateDistributionWithStagingConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import
26
+ * const client = new CloudFrontClient(config);
27
+ * const command = new UpdateDistributionWithStagingConfigCommand(input);
28
+ * const response = await client.send(command);
29
+ * ```
30
+ *
31
+ * @see {@link UpdateDistributionWithStagingConfigCommandInput} for command's `input` shape.
32
+ * @see {@link UpdateDistributionWithStagingConfigCommandOutput} for command's `response` shape.
33
+ * @see {@link CloudFrontClientResolvedConfig | config} for CloudFrontClient's `config` shape.
34
+ *
35
+ */
36
+ export declare class UpdateDistributionWithStagingConfigCommand extends $Command<UpdateDistributionWithStagingConfigCommandInput, UpdateDistributionWithStagingConfigCommandOutput, CloudFrontClientResolvedConfig> {
37
+ readonly input: UpdateDistributionWithStagingConfigCommandInput;
38
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
39
+ constructor(input: UpdateDistributionWithStagingConfigCommandInput);
40
+ /**
41
+ * @internal
42
+ */
43
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFrontClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDistributionWithStagingConfigCommandInput, UpdateDistributionWithStagingConfigCommandOutput>;
44
+ private serialize;
45
+ private deserialize;
46
+ }
@@ -11,9 +11,9 @@ export interface UpdateFunctionCommandOutput extends UpdateFunctionResult, __Met
11
11
  * <p>Updates a CloudFront function.</p>
12
12
  * <p>You can update a function’s code or the comment that describes the function. You
13
13
  * cannot update a function’s name.</p>
14
- * <p>To update a function, you provide the function’s name and version (<code>ETag</code> value)
15
- * along with the updated function code. To get the name and version, you can use
16
- * <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
14
+ * <p>To update a function, you provide the function’s name and version (<code>ETag</code>
15
+ * value) along with the updated function code. To get the name and version, you can use
16
+ * <code>ListFunctions</code> and <code>DescribeFunction</code>.</p>
17
17
  * @example
18
18
  * Use a bare-bones client and the command you need to make an API call.
19
19
  * ```javascript
@@ -15,7 +15,7 @@ export interface UpdateKeyGroupCommandOutput extends UpdateKeyGroupResult, __Met
15
15
  * <ol>
16
16
  * <li>
17
17
  * <p>Get the current key group with <code>GetKeyGroup</code> or
18
- * <code>GetKeyGroupConfig</code>.</p>
18
+ * <code>GetKeyGroupConfig</code>.</p>
19
19
  * </li>
20
20
  * <li>
21
21
  * <p>Locally modify the fields in the key group that you want to update. For
@@ -14,7 +14,8 @@ export interface UpdateOriginRequestPolicyCommandOutput extends UpdateOriginRequ
14
14
  * others. To update an origin request policy configuration:</p>
15
15
  * <ol>
16
16
  * <li>
17
- * <p>Use <code>GetOriginRequestPolicyConfig</code> to get the current configuration.</p>
17
+ * <p>Use <code>GetOriginRequestPolicyConfig</code> to get the current
18
+ * configuration.</p>
18
19
  * </li>
19
20
  * <li>
20
21
  * <p>Locally modify the fields in the origin request policy configuration that you
@@ -8,7 +8,8 @@ export interface UpdatePublicKeyCommandInput extends UpdatePublicKeyRequest {
8
8
  export interface UpdatePublicKeyCommandOutput extends UpdatePublicKeyResult, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Update public key information. Note that the only value you can change is the comment.</p>
11
+ * <p>Update public key information. Note that the only value you can change is the
12
+ * comment.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -28,7 +28,7 @@ export interface UpdateRealtimeLogConfigCommandOutput extends UpdateRealtimeLogC
28
28
  * </li>
29
29
  * </ol>
30
30
  * <p>You cannot update a real-time log configuration’s <code>Name</code> or
31
- * <code>ARN</code>.</p>
31
+ * <code>ARN</code>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -93,6 +93,7 @@ export * from "./UpdateCachePolicyCommand";
93
93
  export * from "./UpdateCloudFrontOriginAccessIdentityCommand";
94
94
  export * from "./UpdateContinuousDeploymentPolicyCommand";
95
95
  export * from "./UpdateDistributionCommand";
96
+ export * from "./UpdateDistributionWithStagingConfigCommand";
96
97
  export * from "./UpdateFieldLevelEncryptionConfigCommand";
97
98
  export * from "./UpdateFieldLevelEncryptionProfileCommand";
98
99
  export * from "./UpdateFunctionCommand";