CloudFront
Service object for interacting with AWS CloudFront service.
public struct CloudFront: AWSService
This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
Inheritance
AWSService
Initializers
init(client:partition:endpoint:timeout:byteBufferAllocator:options:)
Initialize the CloudFront client
public init(
client: AWSClient,
partition: AWSPartition = .aws,
endpoint: String? = nil,
timeout: TimeAmount? = nil,
byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
options: AWSServiceConfig.Options = []
)
Parameters
- client: AWSClient used to process requests
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
init(from:patch:)
Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options)
. You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch
. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options)
instead.
public init(from: CloudFront, patch: AWSServiceConfig.Patch)
Properties
client
Client used for communication with AWS
public let client: AWSClient
config
Service configuration
public let config: AWSServiceConfig
Methods
associateAlias(_:logger:on:)
@discardableResult public func associateAlias(_ input: AssociateAliasRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
createCachePolicy(_:logger:on:)
public func createCachePolicy(_ input: CreateCachePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCachePolicyResult>
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:
-
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
-
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are automatically
included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t
find an object in its cache that matches the request’s cache key. If you want to send
values to the origin but not include them in the cache key, use
OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
createCloudFrontOriginAccessIdentity(_:logger:on:)
public func createCloudFrontOriginAccessIdentity(_ input: CreateCloudFrontOriginAccessIdentityRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCloudFrontOriginAccessIdentityResult>
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
createDistribution(_:logger:on:)
public func createDistribution(_ input: CreateDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDistributionResult>
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you
want content to be delivered from, and the details about how to track and manage content delivery. Send a POST
request to the
/CloudFront API version/distribution
/distribution ID
resource.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
createDistributionWithTags(_:logger:on:)
public func createDistributionWithTags(_ input: CreateDistributionWithTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateDistributionWithTagsResult>
Create a new distribution with tags.
createFieldLevelEncryptionConfig(_:logger:on:)
public func createFieldLevelEncryptionConfig(_ input: CreateFieldLevelEncryptionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateFieldLevelEncryptionConfigResult>
Create a new field-level encryption configuration.
createFieldLevelEncryptionProfile(_:logger:on:)
public func createFieldLevelEncryptionProfile(_ input: CreateFieldLevelEncryptionProfileRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateFieldLevelEncryptionProfileResult>
Create a field-level encryption profile.
createFunction(_:logger:on:)
public func createFunction(_ input: CreateFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateFunctionResult>
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it’s in the DEVELOPMENT
stage. In this stage, you
can test the function with TestFunction
, and update it with
UpdateFunction
.
When you’re ready to use your function with a CloudFront distribution, use
PublishFunction
to copy the function from the DEVELOPMENT
stage to LIVE
. When it’s live, you can attach the function to a
distribution’s cache behavior, using the function’s ARN.
createInvalidation(_:logger:on:)
public func createInvalidation(_ input: CreateInvalidationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateInvalidationResult>
Create a new invalidation.
createKeyGroup(_:logger:on:)
public func createKeyGroup(_ input: CreateKeyGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateKeyGroupResult>
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
createMonitoringSubscription(_:logger:on:)
public func createMonitoringSubscription(_ input: CreateMonitoringSubscriptionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateMonitoringSubscriptionResult>
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
createOriginRequestPolicy(_:logger:on:)
public func createOriginRequestPolicy(_ input: CreateOriginRequestPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateOriginRequestPolicyResult>
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
-
The request body and the URL path (without the domain name) from the viewer request.
-
The headers that CloudFront automatically includes in every origin request, including
Host
,User-Agent
, andX-Amz-Cf-Id
. -
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find a valid object in its cache that matches the
request. If you want to send values to the origin and also include them in the cache
key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
createPublicKey(_:logger:on:)
public func createPublicKey(_ input: CreatePublicKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreatePublicKeyResult>
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
createRealtimeLogConfig(_:logger:on:)
public func createRealtimeLogConfig(_ input: CreateRealtimeLogConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateRealtimeLogConfigResult>
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
createResponseHeadersPolicy(_:logger:on:)
public func createResponseHeadersPolicy(_ input: CreateResponseHeadersPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateResponseHeadersPolicyResult>
Creates a response headers policy.
A response headers policy contains information about a set of HTTP response headers and their values. To create a response headers policy, you provide some metadata about the policy, and a set of configurations that specify the response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it’s attached to a cache behavior, CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match the cache behavior.
createStreamingDistribution(_:logger:on:)
public func createStreamingDistribution(_ input: CreateStreamingDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateStreamingDistributionResult>
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
createStreamingDistributionWithTags(_:logger:on:)
public func createStreamingDistributionWithTags(_ input: CreateStreamingDistributionWithTagsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateStreamingDistributionWithTagsResult>
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
deleteCachePolicy(_:logger:on:)
@discardableResult public func deleteCachePolicy(_ input: DeleteCachePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a cache policy.
You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy’s identifier and version. To get these
values, you can use ListCachePolicies
or
GetCachePolicy
.
deleteCloudFrontOriginAccessIdentity(_:logger:on:)
@discardableResult public func deleteCloudFrontOriginAccessIdentity(_ input: DeleteCloudFrontOriginAccessIdentityRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Delete an origin access identity.
deleteDistribution(_:logger:on:)
@discardableResult public func deleteDistribution(_ input: DeleteDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Delete a distribution.
deleteFieldLevelEncryptionConfig(_:logger:on:)
@discardableResult public func deleteFieldLevelEncryptionConfig(_ input: DeleteFieldLevelEncryptionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Remove a field-level encryption configuration.
deleteFieldLevelEncryptionProfile(_:logger:on:)
@discardableResult public func deleteFieldLevelEncryptionProfile(_ input: DeleteFieldLevelEncryptionProfileRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Remove a field-level encryption profile.
deleteFunction(_:logger:on:)
@discardableResult public func deleteFunction(_ input: DeleteFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a CloudFront function.
You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function’s name and version
(ETag
value). To get these values, you can use ListFunctions
and DescribeFunction
.
deleteKeyGroup(_:logger:on:)
@discardableResult public func deleteKeyGroup(_ input: DeleteKeyGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group’s identifier and version. To get
these values, use ListKeyGroups
followed by GetKeyGroup
or
GetKeyGroupConfig
.
deleteMonitoringSubscription(_:logger:on:)
public func deleteMonitoringSubscription(_ input: DeleteMonitoringSubscriptionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteMonitoringSubscriptionResult>
Disables additional CloudWatch metrics for the specified CloudFront distribution.
deleteOriginRequestPolicy(_:logger:on:)
@discardableResult public func deleteOriginRequestPolicy(_ input: DeleteOriginRequestPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes an origin request policy.
You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy’s identifier and version. To
get the identifier, you can use ListOriginRequestPolicies
or
GetOriginRequestPolicy
.
deletePublicKey(_:logger:on:)
@discardableResult public func deletePublicKey(_ input: DeletePublicKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Remove a public key you previously added to CloudFront.
deleteRealtimeLogConfig(_:logger:on:)
@discardableResult public func deleteRealtimeLogConfig(_ input: DeleteRealtimeLogConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
deleteResponseHeadersPolicy(_:logger:on:)
@discardableResult public func deleteResponseHeadersPolicy(_ input: DeleteResponseHeadersPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Deletes a response headers policy.
You cannot delete a response headers policy if it’s attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy’s identifier and
version. To get these values, you can use ListResponseHeadersPolicies
or
GetResponseHeadersPolicy
.
deleteStreamingDistribution(_:logger:on:)
@discardableResult public func deleteStreamingDistribution(_ input: DeleteStreamingDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
<p>
<b>To delete an RTMP distribution using the CloudFront
API</b>:</p>
<ol>
<li>
<p>Disable the RTMP distribution.</p>
</li>
<li>
<p>Submit a <code>GET Streaming Distribution Config</code> request to get the current
configuration and the <code>Etag</code> header for the distribution. </p>
</li>
<li>
<p>Update the XML document that was returned in the response to your <code>GET
Streaming Distribution Config</code> request to change the value of <code>Enabled</code>
to <code>false</code>.</p>
</li>
<li>
<p>Submit a <code>PUT Streaming Distribution Config</code> request to update the
configuration for your distribution. In the request body, include the XML document that
you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the
value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET
Streaming Distribution Config</code> request in Step 2.</p>
</li>
<li>
<p>Review the response to the <code>PUT Streaming Distribution Config</code> request
to confirm that the distribution was successfully disabled.</p>
</li>
<li>
<p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that
your changes have propagated. When propagation is complete, the value of
<code>Status</code> is <code>Deployed</code>.</p>
</li>
<li>
<p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the
HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront
returned when you submitted the <code>GET Streaming Distribution Config</code> request in
Step 2.</p>
</li>
<li>
<p>Review the response to your <code>DELETE Streaming Distribution</code> request to
confirm that the distribution was successfully deleted.</p>
</li>
</ol>
<p>For information about deleting a distribution using the CloudFront console, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html">Deleting a Distribution</a> in the
<i>Amazon CloudFront Developer Guide</i>.</p>
describeFunction(_:logger:on:)
public func describeFunction(_ input: DescribeFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeFunctionResult>
Gets configuration information and metadata about a CloudFront function, but not the function’s
code. To get a function’s code, use GetFunction
.
To get configuration information and metadata about a function, you must provide the
function’s name and stage. To get these values, you can use
ListFunctions
.
getCachePolicy(_:logger:on:)
public func getCachePolicy(_ input: GetCachePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCachePolicyResult>
Gets a cache policy, including the following metadata:
-
The policy’s identifier.
-
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy’s identifier. If the cache policy is
attached to a distribution’s cache behavior, you can get the policy’s identifier using
ListDistributions
or GetDistribution
. If the cache policy is
not attached to a cache behavior, you can get the identifier using
ListCachePolicies
.
getCachePolicyConfig(_:logger:on:)
public func getCachePolicyConfig(_ input: GetCachePolicyConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCachePolicyConfigResult>
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy’s identifier. If the cache
policy is attached to a distribution’s cache behavior, you can get the policy’s
identifier using ListDistributions
or GetDistribution
. If the
cache policy is not attached to a cache behavior, you can get the identifier using
ListCachePolicies
.
getCloudFrontOriginAccessIdentity(_:logger:on:)
public func getCloudFrontOriginAccessIdentity(_ input: GetCloudFrontOriginAccessIdentityRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCloudFrontOriginAccessIdentityResult>
Get the information about an origin access identity.
getCloudFrontOriginAccessIdentityConfig(_:logger:on:)
public func getCloudFrontOriginAccessIdentityConfig(_ input: GetCloudFrontOriginAccessIdentityConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCloudFrontOriginAccessIdentityConfigResult>
Get the configuration information about an origin access identity.
getDistribution(_:logger:on:)
public func getDistribution(_ input: GetDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDistributionResult>
Get the information about a distribution.
getDistributionConfig(_:logger:on:)
public func getDistributionConfig(_ input: GetDistributionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetDistributionConfigResult>
Get the configuration information about a distribution.
getFieldLevelEncryption(_:logger:on:)
public func getFieldLevelEncryption(_ input: GetFieldLevelEncryptionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetFieldLevelEncryptionResult>
Get the field-level encryption configuration information.
getFieldLevelEncryptionConfig(_:logger:on:)
public func getFieldLevelEncryptionConfig(_ input: GetFieldLevelEncryptionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetFieldLevelEncryptionConfigResult>
Get the field-level encryption configuration information.
getFieldLevelEncryptionProfile(_:logger:on:)
public func getFieldLevelEncryptionProfile(_ input: GetFieldLevelEncryptionProfileRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetFieldLevelEncryptionProfileResult>
Get the field-level encryption profile information.
getFieldLevelEncryptionProfileConfig(_:logger:on:)
public func getFieldLevelEncryptionProfileConfig(_ input: GetFieldLevelEncryptionProfileConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetFieldLevelEncryptionProfileConfigResult>
Get the field-level encryption profile configuration information.
getFunction(_:logger:on:)
public func getFunction(_ input: GetFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetFunctionResult>
Gets the code of a CloudFront function. To get configuration information and metadata about
a function, use DescribeFunction
.
To get a function’s code, you must provide the function’s name and stage. To get these
values, you can use ListFunctions
.
getInvalidation(_:logger:on:)
public func getInvalidation(_ input: GetInvalidationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetInvalidationResult>
Get the information about an invalidation.
getKeyGroup(_:logger:on:)
public func getKeyGroup(_ input: GetKeyGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetKeyGroupResult>
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group’s identifier. If the key group is
referenced in a distribution’s cache behavior, you can get the key group’s identifier
using ListDistributions
or GetDistribution
. If the key group
is not referenced in a cache behavior, you can get the identifier using
ListKeyGroups
.
getKeyGroupConfig(_:logger:on:)
public func getKeyGroupConfig(_ input: GetKeyGroupConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetKeyGroupConfigResult>
Gets a key group configuration.
To get a key group configuration, you must provide the key group’s identifier. If the
key group is referenced in a distribution’s cache behavior, you can get the key group’s
identifier using ListDistributions
or GetDistribution
. If the
key group is not referenced in a cache behavior, you can get the identifier using
ListKeyGroups
.
getMonitoringSubscription(_:logger:on:)
public func getMonitoringSubscription(_ input: GetMonitoringSubscriptionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetMonitoringSubscriptionResult>
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
getOriginRequestPolicy(_:logger:on:)
public func getOriginRequestPolicy(_ input: GetOriginRequestPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetOriginRequestPolicyResult>
Gets an origin request policy, including the following metadata:
-
The policy’s identifier.
-
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy’s identifier. If the origin
request policy is attached to a distribution’s cache behavior, you can get the policy’s
identifier using ListDistributions
or GetDistribution
. If the
origin request policy is not attached to a cache behavior, you can get the identifier
using ListOriginRequestPolicies
.
getOriginRequestPolicyConfig(_:logger:on:)
public func getOriginRequestPolicyConfig(_ input: GetOriginRequestPolicyConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetOriginRequestPolicyConfigResult>
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy’s identifier. If
the origin request policy is attached to a distribution’s cache behavior, you can get
the policy’s identifier using ListDistributions
or
GetDistribution
. If the origin request policy is not attached to a cache
behavior, you can get the identifier using
ListOriginRequestPolicies
.
getPublicKey(_:logger:on:)
public func getPublicKey(_ input: GetPublicKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPublicKeyResult>
Gets a public key.
getPublicKeyConfig(_:logger:on:)
public func getPublicKeyConfig(_ input: GetPublicKeyConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetPublicKeyConfigResult>
Gets a public key configuration.
getRealtimeLogConfig(_:logger:on:)
public func getRealtimeLogConfig(_ input: GetRealtimeLogConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRealtimeLogConfigResult>
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
getResponseHeadersPolicy(_:logger:on:)
public func getResponseHeadersPolicy(_ input: GetResponseHeadersPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetResponseHeadersPolicyResult>
Gets a response headers policy, including metadata (the policy’s identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy’s identifier. If the
response headers policy is attached to a distribution’s cache behavior, you can get the
policy’s identifier using ListDistributions
or
GetDistribution
. If the response headers policy is not attached to a cache
behavior, you can get the identifier using
ListResponseHeadersPolicies
.
getResponseHeadersPolicyConfig(_:logger:on:)
public func getResponseHeadersPolicyConfig(_ input: GetResponseHeadersPolicyConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetResponseHeadersPolicyConfigResult>
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy’s
identifier. If the response headers policy is attached to a distribution’s cache
behavior, you can get the policy’s identifier using ListDistributions
or
GetDistribution
. If the response headers policy is not attached to a
cache behavior, you can get the identifier using
ListResponseHeadersPolicies
.
getStreamingDistribution(_:logger:on:)
public func getStreamingDistribution(_ input: GetStreamingDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetStreamingDistributionResult>
Gets information about a specified RTMP distribution, including the distribution configuration.
getStreamingDistributionConfig(_:logger:on:)
public func getStreamingDistributionConfig(_ input: GetStreamingDistributionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetStreamingDistributionConfigResult>
Get the configuration information about a streaming distribution.
listCachePolicies(_:logger:on:)
public func listCachePolicies(_ input: ListCachePoliciesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListCachePoliciesResult>
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listCloudFrontOriginAccessIdentities(_:logger:on:)
public func listCloudFrontOriginAccessIdentities(_ input: ListCloudFrontOriginAccessIdentitiesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListCloudFrontOriginAccessIdentitiesResult>
Lists origin access identities.
listConflictingAliases(_:logger:on:)
public func listConflictingAliases(_ input: ListConflictingAliasesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListConflictingAliasesResult>
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don’t own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap
with the provided alias. For example, if you provide www.example.com
as
input, the returned list can include www.example.com
and the overlapping
wildcard alternate domain name (*.example.com
), if they exist. If you
provide *.example.com
as input, the returned list can include
*.example.com
and any alternate domain names covered by that wildcard (for
example, www.example.com
, test.example.com
,
dev.example.com
, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributions(_:logger:on:)
public func listDistributions(_ input: ListDistributionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsResult>
List CloudFront distributions.
listDistributionsByCachePolicyId(_:logger:on:)
public func listDistributionsByCachePolicyId(_ input: ListDistributionsByCachePolicyIdRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByCachePolicyIdResult>
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByKeyGroup(_:logger:on:)
public func listDistributionsByKeyGroup(_ input: ListDistributionsByKeyGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByKeyGroupResult>
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByOriginRequestPolicyId(_:logger:on:)
public func listDistributionsByOriginRequestPolicyId(_ input: ListDistributionsByOriginRequestPolicyIdRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByOriginRequestPolicyIdResult>
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByRealtimeLogConfig(_:logger:on:)
public func listDistributionsByRealtimeLogConfig(_ input: ListDistributionsByRealtimeLogConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByRealtimeLogConfigResult>
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByResponseHeadersPolicyId(_:logger:on:)
public func listDistributionsByResponseHeadersPolicyId(_ input: ListDistributionsByResponseHeadersPolicyIdRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByResponseHeadersPolicyIdResult>
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listDistributionsByWebACLId(_:logger:on:)
public func listDistributionsByWebACLId(_ input: ListDistributionsByWebACLIdRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListDistributionsByWebACLIdResult>
List the distributions that are associated with a specified WAF web ACL.
listFieldLevelEncryptionConfigs(_:logger:on:)
public func listFieldLevelEncryptionConfigs(_ input: ListFieldLevelEncryptionConfigsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListFieldLevelEncryptionConfigsResult>
List all field-level encryption configurations that have been created in CloudFront for this account.
listFieldLevelEncryptionProfiles(_:logger:on:)
public func listFieldLevelEncryptionProfiles(_ input: ListFieldLevelEncryptionProfilesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListFieldLevelEncryptionProfilesResult>
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
listFunctions(_:logger:on:)
public func listFunctions(_ input: ListFunctionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListFunctionsResult>
Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the
specified stage, either DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listInvalidations(_:logger:on:)
public func listInvalidations(_ input: ListInvalidationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListInvalidationsResult>
Lists invalidation batches.
listKeyGroups(_:logger:on:)
public func listKeyGroups(_ input: ListKeyGroupsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListKeyGroupsResult>
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listOriginRequestPolicies(_:logger:on:)
public func listOriginRequestPolicies(_ input: ListOriginRequestPoliciesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListOriginRequestPoliciesResult>
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listPublicKeys(_:logger:on:)
public func listPublicKeys(_ input: ListPublicKeysRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListPublicKeysResult>
List all public keys that have been added to CloudFront for this account.
listRealtimeLogConfigs(_:logger:on:)
public func listRealtimeLogConfigs(_ input: ListRealtimeLogConfigsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListRealtimeLogConfigsResult>
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listResponseHeadersPolicies(_:logger:on:)
public func listResponseHeadersPolicies(_ input: ListResponseHeadersPoliciesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListResponseHeadersPoliciesResult>
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If
the total number of items in the list exceeds the maximum that you specify, or the
default maximum, the response is paginated. To get the next page of items, send a
subsequent request that specifies the NextMarker
value from the current
response as the Marker
value in the subsequent request.
listStreamingDistributions(_:logger:on:)
public func listStreamingDistributions(_ input: ListStreamingDistributionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListStreamingDistributionsResult>
List streaming distributions.
listTagsForResource(_:logger:on:)
public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResult>
List tags for a CloudFront resource.
publishFunction(_:logger:on:)
public func publishFunction(_ input: PublishFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<PublishFunctionResult>
Publishes a CloudFront function by copying the function code from the DEVELOPMENT
stage to LIVE
. This automatically updates all cache behaviors that are
using this function to use the newly published copy in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the function to
a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).
To publish a function, you must provide the function’s name and version (ETag
value). To get these values, you can use ListFunctions
and
DescribeFunction
.
tagResource(_:logger:on:)
@discardableResult public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Add tags to a CloudFront resource.
testFunction(_:logger:on:)
public func testFunction(_ input: TestFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TestFunctionResult>
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function’s name and version (ETag
value)
along with the event object. To get the function’s name and version, you can use
ListFunctions
and DescribeFunction
.
untagResource(_:logger:on:)
@discardableResult public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void>
Remove tags from a CloudFront resource.
updateCachePolicy(_:logger:on:)
public func updateCachePolicy(_ input: UpdateCachePolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateCachePolicyResult>
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
-
Use
GetCachePolicyConfig
to get the current configuration. -
Locally modify the fields in the cache policy configuration that you want to update.
-
Call
UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.
updateCloudFrontOriginAccessIdentity(_:logger:on:)
public func updateCloudFrontOriginAccessIdentity(_ input: UpdateCloudFrontOriginAccessIdentityRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateCloudFrontOriginAccessIdentityResult>
Update an origin access identity.
updateDistribution(_:logger:on:)
public func updateDistribution(_ input: UpdateDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateDistributionResult>
Updates the configuration for a web distribution.
When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
The update process includes getting the current distribution configuration, updating the XML document that is
returned to make your changes, and then submitting an UpdateDistribution
request to make the updates.
For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.
<p>
<b>To update a web distribution using the CloudFront API</b>
</p>
<ol>
<li>
<p>Submit a
<a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistributionConfig.html">GetDistributionConfig</a>
request to get the current configuration and an <code>Etag</code> header
for the distribution.</p>
<note>
<p>If you update the distribution again, you must get a new <code>Etag</code> header.</p>
</note>
</li>
<li>
<p>Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include
your changes. </p>
<important>
<p>When you edit the XML file, be aware of the following:</p>
<ul>
<li>
<p>You must strip out the ETag parameter that is returned.</p>
</li>
<li>
<p>Additional fields are required when you update a distribution. There may be fields included in the
XML file for features that you haven't configured for your distribution. This is expected and required to
successfully update the distribution.</p>
</li>
<li>
<p>You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an
<code>IllegalUpdate</code> error. </p>
</li>
<li>
<p>The new configuration replaces the existing configuration; the values that you specify in an
<code>UpdateDistribution</code> request are not merged into your existing configuration. When you add, delete, or
replace values in an element that allows multiple values (for example, <code>CNAME</code>), you must specify all of the
values that you want to appear in the updated distribution. In addition,
you must update the corresponding <code>Quantity</code> element.</p>
</li>
</ul>
</important>
</li>
<li>
<p>Submit an <code>UpdateDistribution</code> request to update the configuration for your distribution:</p>
<ul>
<li>
<p>In the request body, include the XML document that you updated in Step 2. The request body must include an
XML document with a <code>DistributionConfig</code> element.</p>
</li>
<li>
<p>Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned
when you submitted the <code>GetDistributionConfig</code> request in Step 1.</p>
</li>
</ul>
</li>
<li>
<p>Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was
successfully updated.</p>
</li>
<li>
<p>Optional: Submit a
<a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html">GetDistribution</a>
request to confirm that your changes have propagated.
When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p>
</li>
</ol>
updateFieldLevelEncryptionConfig(_:logger:on:)
public func updateFieldLevelEncryptionConfig(_ input: UpdateFieldLevelEncryptionConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateFieldLevelEncryptionConfigResult>
Update a field-level encryption configuration.
updateFieldLevelEncryptionProfile(_:logger:on:)
public func updateFieldLevelEncryptionProfile(_ input: UpdateFieldLevelEncryptionProfileRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateFieldLevelEncryptionProfileResult>
Update a field-level encryption profile.
updateFunction(_:logger:on:)
public func updateFunction(_ input: UpdateFunctionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateFunctionResult>
Updates a CloudFront function.
You can update a function’s code or the comment that describes the function. You cannot update a function’s name.
To update a function, you provide the function’s name and version (ETag
value)
along with the updated function code. To get the name and version, you can use
ListFunctions
and DescribeFunction
.
updateKeyGroup(_:logger:on:)
public func updateKeyGroup(_ input: UpdateKeyGroupRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateKeyGroupResult>
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
-
Get the current key group with
GetKeyGroup
orGetKeyGroupConfig
. -
Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
-
Call
UpdateKeyGroup
with the entire key group object, including the fields that you modified and those that you didn’t.
updateOriginRequestPolicy(_:logger:on:)
public func updateOriginRequestPolicy(_ input: UpdateOriginRequestPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateOriginRequestPolicyResult>
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
-
Use
GetOriginRequestPolicyConfig
to get the current configuration. -
Locally modify the fields in the origin request policy configuration that you want to update.
-
Call
UpdateOriginRequestPolicy
by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.
updatePublicKey(_:logger:on:)
public func updatePublicKey(_ input: UpdatePublicKeyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdatePublicKeyResult>
Update public key information. Note that the only value you can change is the comment.
updateRealtimeLogConfig(_:logger:on:)
public func updateRealtimeLogConfig(_ input: UpdateRealtimeLogConfigRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateRealtimeLogConfigResult>
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
-
Call
GetRealtimeLogConfig
to get the current real-time log configuration. -
Locally modify the parameters in the real-time log configuration that you want to update.
-
Call this API (
UpdateRealtimeLogConfig
) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.
You cannot update a real-time log configuration’s Name
or
ARN
.
updateResponseHeadersPolicy(_:logger:on:)
public func updateResponseHeadersPolicy(_ input: UpdateResponseHeadersPolicyRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateResponseHeadersPolicyResult>
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
-
Use
GetResponseHeadersPolicyConfig
to get the current policy’s configuration. -
Modify the fields in the response headers policy configuration that you want to update.
-
Call
UpdateResponseHeadersPolicy
, providing the entire response headers policy configuration, including the fields that you modified and those that you didn’t.
updateStreamingDistribution(_:logger:on:)
public func updateStreamingDistribution(_ input: UpdateStreamingDistributionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateStreamingDistributionResult>
Update a streaming distribution.
listCloudFrontOriginAccessIdentitiesPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listCloudFrontOriginAccessIdentitiesPaginator( _ input: ListCloudFrontOriginAccessIdentitiesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListCloudFrontOriginAccessIdentitiesRequest, ListCloudFrontOriginAccessIdentitiesResult>
Lists origin access identities.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listDistributionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listDistributionsPaginator( _ input: ListDistributionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListDistributionsRequest, ListDistributionsResult>
List CloudFront distributions.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listInvalidationsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listInvalidationsPaginator( _ input: ListInvalidationsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListInvalidationsRequest, ListInvalidationsResult>
Lists invalidation batches.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listStreamingDistributionsPaginator(_:logger:on:)
compiler(>=5.5.2) && canImport(_Concurrency)
public func listStreamingDistributionsPaginator( _ input: ListStreamingDistributionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil ) -> AWSClient.PaginatorSequence<ListStreamingDistributionsRequest, ListStreamingDistributionsResult>
List streaming distributions.
Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on
listCloudFrontOriginAccessIdentitiesPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listCloudFrontOriginAccessIdentitiesPaginator<Result>(
_ input: ListCloudFrontOriginAccessIdentitiesRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListCloudFrontOriginAccessIdentitiesResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists origin access identities.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listCloudFrontOriginAccessIdentitiesPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listCloudFrontOriginAccessIdentitiesPaginator(
_ input: ListCloudFrontOriginAccessIdentitiesRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListCloudFrontOriginAccessIdentitiesResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listDistributionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listDistributionsPaginator<Result>(
_ input: ListDistributionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListDistributionsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
List CloudFront distributions.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listDistributionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listDistributionsPaginator(
_ input: ListDistributionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListDistributionsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listInvalidationsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listInvalidationsPaginator<Result>(
_ input: ListInvalidationsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListInvalidationsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
Lists invalidation batches.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listInvalidationsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listInvalidationsPaginator(
_ input: ListInvalidationsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListInvalidationsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
listStreamingDistributionsPaginator(_:_:logger:on:onPage:)
Provide paginated results to closure onPage
for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result
.
public func listStreamingDistributionsPaginator<Result>(
_ input: ListStreamingDistributionsRequest,
_ initialValue: Result,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (Result, ListStreamingDistributionsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
) -> EventLoopFuture<Result>
List streaming distributions.
Parameters:
- input: Input for request
- initialValue: The value to use as the initial accumulating value.
initialValue
is passed toonPage
the first time it is called.
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.
listStreamingDistributionsPaginator(_:logger:on:onPage:)
Provide paginated results to closure onPage
.
public func listStreamingDistributionsPaginator(
_ input: ListStreamingDistributionsRequest,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil,
onPage: @escaping (ListStreamingDistributionsResult, EventLoop) -> EventLoopFuture<Bool>
) -> EventLoopFuture<Void>
Parameters
- input: Input for request
- logger: Logger used flot logging
- eventLoop: EventLoop to run this process on
- onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.
waitUntilDistributionDeployed(_:maxWaitTime:logger:on:)
Wait until a distribution is deployed.
public func waitUntilDistributionDeployed(
_ input: GetDistributionRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilInvalidationCompleted(_:maxWaitTime:logger:on:)
Wait until an invalidation has completed.
public func waitUntilInvalidationCompleted(
_ input: GetInvalidationRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>
waitUntilStreamingDistributionDeployed(_:maxWaitTime:logger:on:)
Wait until a streaming distribution is deployed.
public func waitUntilStreamingDistributionDeployed(
_ input: GetStreamingDistributionRequest,
maxWaitTime: TimeAmount? = nil,
logger: Logger = AWSClient.loggingDisabled,
on eventLoop: EventLoop? = nil
) -> EventLoopFuture<Void>