2026/10/26 - Amazon Lightsail - 4 updated api methods
Changes This release adds Web Application Firewall (WAF) support for Lightsail distribution.
{'enableWaf': 'boolean',
'wafRules': [{'acfpConfig': {'creationPath': 'string',
'payloadType': 'JSON | FORM_ENCODED',
'registrationPagePath': 'string',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']}},
'atpConfig': {'loginPath': 'string',
'passwordField': 'string',
'payloadType': 'JSON | FORM_ENCODED',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']},
'usernameField': 'string'},
'botControlConfig': {'inspectionLevel': 'COMMON | TARGETED'},
'name': 'string'}]}
Response {'distribution': {'waf': {'isWafEnabled': 'boolean',
'wafRules': [{'acfpConfig': {'creationPath': 'string',
'payloadType': 'JSON | '
'FORM_ENCODED',
'registrationPagePath': 'string',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']}},
'atpConfig': {'loginPath': 'string',
'passwordField': 'string',
'payloadType': 'JSON | '
'FORM_ENCODED',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']},
'usernameField': 'string'},
'botControlConfig': {'inspectionLevel': 'COMMON '
'| '
'TARGETED'},
'name': 'string'}]}}}
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
See also: AWS API Documentation
Request Syntax
client.create_distribution(
distributionName='string',
origin={
'name': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1',
'protocolPolicy': 'http-only'|'https-only',
'responseTimeout': 123,
'ipAddressType': 'ipv4'|'ipv6'|'dualstack'
},
defaultCacheBehavior={
'behavior': 'dont-cache'|'cache'
},
cacheBehaviorSettings={
'defaultTTL': 123,
'minimumTTL': 123,
'maximumTTL': 123,
'allowedHTTPMethods': 'string',
'cachedHTTPMethods': 'string',
'forwardedCookies': {
'option': 'none'|'allow-list'|'all',
'cookiesAllowList': [
'string',
]
},
'forwardedHeaders': {
'option': 'none'|'allow-list'|'all',
'headersAllowList': [
'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
]
},
'forwardedQueryStrings': {
'option': True|False,
'queryStringsAllowList': [
'string',
]
}
},
cacheBehaviors=[
{
'path': 'string',
'behavior': 'dont-cache'|'cache'
},
],
bundleId='string',
ipAddressType='dualstack'|'ipv4'|'ipv6',
tags=[
{
'key': 'string',
'value': 'string'
},
],
certificateName='string',
viewerMinimumTlsProtocolVersion='TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
enablePrivateOriginAccess=True|False,
defaultRootObject='string',
customErrorResponses=[
{
'errorCode': 123,
'responseCode': 'string',
'responsePagePath': 'string',
'errorCachingMinTTL': 123
},
],
enableWaf=True|False,
wafRules=[
{
'name': 'string',
'atpConfig': {
'loginPath': 'string',
'payloadType': 'JSON'|'FORM_ENCODED',
'usernameField': 'string',
'passwordField': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'acfpConfig': {
'payloadType': 'JSON'|'FORM_ENCODED',
'creationPath': 'string',
'registrationPagePath': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'botControlConfig': {
'inspectionLevel': 'COMMON'|'TARGETED'
}
},
]
)
string
[REQUIRED]
The name for the distribution.
dict
[REQUIRED]
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
name (string) --
The name of the origin resource.
regionName (string) --
The AWS Region name of the origin resource.
protocolPolicy (string) --
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
responseTimeout (integer) --
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
ipAddressType (string) --
The IP address type that the distribution uses when connecting to the origin.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
dict
[REQUIRED]
An object that describes the default cache behavior for the distribution.
behavior (string) --
The cache behavior of the distribution.
The following cache behaviors can be specified:
cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
dict
An object that describes the cache behavior settings for the distribution.
defaultTTL (integer) --
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
minimumTTL (integer) --
The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --
The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
allowedHTTPMethods (string) --
The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD - The distribution forwards the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD - The distribution caches responses to the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
forwardedCookies (dict) --
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option (string) --
Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
cookiesAllowList (list) --
The specific cookies to forward to your distribution's origin.
(string) --
forwardedHeaders (dict) --
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option (string) --
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all - Forward all headers to your origin.
none - Forward only the default headers.
allow-list - Forward only the headers you specify using the headersAllowList parameter.
headersAllowList (list) --
The specific headers to forward to your distribution's origin.
(string) --
forwardedQueryStrings (dict) --
An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option (boolean) --
Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList (list) --
The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
(string) --
list
An array of objects that describe the per-path cache behavior for the distribution.
(dict) --
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
path (string) --
The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
behavior (string) --
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache - This behavior caches the specified path.
dont-cache - This behavior doesn't cache the specified path.
string
[REQUIRED]
The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
string
The IP address type for the distribution.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
list
The tag keys and optional values to add to the distribution during create.
Use the TagResource action to tag a resource after it's created.
(dict) --
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
key (string) --
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value (string) --
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
string
The name of the SSL/TLS certificate that you want to attach to the distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
string
The minimum TLS protocol version for the SSL/TLS certificate.
boolean
Specifies whether to enable private origin access for the distribution. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.
Lightsail grants the distribution permission to read the bucket's objects. Enabling private origin access doesn't change the bucket's access settings, and you can still retrieve publicly accessible objects directly from the bucket's endpoint.
string
The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution ( /) instead of a specific object. The object that you specify must be available from the origin.
list
An array of objects that describe the custom error responses for the distribution. With a custom error response, you can specify the page to return when the origin responds with a given HTTP error code. You can also specify the HTTP status code to send to the viewer.
(dict) --
Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.
errorCode (integer) --
The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).
responseCode (string) --
The HTTP status code that the distribution returns to the viewer for the custom error response.
responsePagePath (string) --
The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash ( /) and reference an object that is available from the origin.
errorCachingMinTTL (integer) --
The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.
boolean
Specifies whether to enable Web Application Firewall (WAF) for the distribution. WAF inspects viewer requests and blocks requests that match the WAF rule groups that you enable.
When you enable WAF without specifying the wafRules parameter, the distribution has no WAF rule groups enabled and doesn't block any requests.
list
An array of objects that describe the WAF rule groups to enable for the distribution.
The WAF rule groups that you can specify depend on the bundle of the distribution:
medium_1_0 – Supports the AWSManagedRulesCommonRuleSet, AWSManagedRulesKnownBadInputsRuleSet, and AWSManagedRulesAnonymousIpList rule groups.
large_1_0 – Supports the rule groups for medium_1_0, plus AWSManagedRulesAdminProtectionRuleSet, AWSManagedRulesSQLiRuleSet, AWSManagedRulesLinuxRuleSet, AWSManagedRulesUnixRuleSet, AWSManagedRulesWindowsRuleSet, AWSManagedRulesPHPRuleSet, AWSManagedRulesWordPressRuleSet, AWSManagedRulesAmazonIpReputationList, AWSManagedRulesATPRuleSet, AWSManagedRulesACFPRuleSet, and AWSManagedRulesBotControlRuleSet rule groups.
(dict) --
Describes a Web Application Firewall (WAF) rule group for a Lightsail distribution. A WAF rule group is a set of rules managed by AWS. The rules inspect viewer requests and block requests that match them.
name (string) -- [REQUIRED]
The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).
For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.
atpConfig (dict) --
An object that describes the configuration of the account takeover prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesATPRuleSet.
This parameter is required when the name is AWSManagedRulesATPRuleSet.
loginPath (string) --
The path of the login endpoint of your application (for example, /login). Login paths that start with the path that you specify are a match.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
payloadType (string) --
The content type of the request body of login requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
usernameField (string) --
The name of the field in the request body that contains the username (for example, /username for JSON or username for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
passwordField (string) --
The name of the field in the request body that contains the password (for example, /password for JSON or password for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed login attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
acfpConfig (dict) --
An object that describes the configuration of the account creation fraud prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesACFPRuleSet.
This parameter is required when the name is AWSManagedRulesACFPRuleSet.
payloadType (string) --
The content type of the request body of account creation requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
creationPath (string) --
The path of the endpoint that accepts completed account creation forms (for example, /signup/submit). This endpoint must accept POST requests.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
registrationPagePath (string) --
The path of the page that displays the account creation form (for example, /signup).
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed account creation attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
botControlConfig (dict) --
An object that describes the configuration of the bot control rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.
This parameter is required when the name is AWSManagedRulesBotControlRuleSet.
inspectionLevel (string) --
The inspection level of the bot control rule group.
The following inspection levels are possible:
COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.
TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.
dict
Response Syntax
{
'distribution': {
'name': 'string',
'arn': 'string',
'supportCode': 'string',
'createdAt': datetime(2015, 1, 1),
'location': {
'availabilityZone': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1'
},
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'alternativeDomainNames': [
'string',
],
'status': 'string',
'isEnabled': True|False,
'domainName': 'string',
'bundleId': 'string',
'certificateName': 'string',
'origin': {
'name': 'string',
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1',
'protocolPolicy': 'http-only'|'https-only',
'responseTimeout': 123,
'ipAddressType': 'ipv4'|'ipv6'|'dualstack',
'isPrivateOriginAccessEnabled': True|False
},
'originPublicDNS': 'string',
'defaultCacheBehavior': {
'behavior': 'dont-cache'|'cache'
},
'cacheBehaviorSettings': {
'defaultTTL': 123,
'minimumTTL': 123,
'maximumTTL': 123,
'allowedHTTPMethods': 'string',
'cachedHTTPMethods': 'string',
'forwardedCookies': {
'option': 'none'|'allow-list'|'all',
'cookiesAllowList': [
'string',
]
},
'forwardedHeaders': {
'option': 'none'|'allow-list'|'all',
'headersAllowList': [
'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
]
},
'forwardedQueryStrings': {
'option': True|False,
'queryStringsAllowList': [
'string',
]
}
},
'cacheBehaviors': [
{
'path': 'string',
'behavior': 'dont-cache'|'cache'
},
],
'ableToUpdateBundle': True|False,
'ipAddressType': 'dualstack'|'ipv4'|'ipv6',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'viewerMinimumTlsProtocolVersion': 'string',
'defaultRootObject': 'string',
'customErrorResponses': [
{
'errorCode': 123,
'responseCode': 'string',
'responsePagePath': 'string',
'errorCachingMinTTL': 123
},
],
'waf': {
'isWafEnabled': True|False,
'wafRules': [
{
'name': 'string',
'atpConfig': {
'loginPath': 'string',
'payloadType': 'JSON'|'FORM_ENCODED',
'usernameField': 'string',
'passwordField': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'acfpConfig': {
'payloadType': 'JSON'|'FORM_ENCODED',
'creationPath': 'string',
'registrationPagePath': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'botControlConfig': {
'inspectionLevel': 'COMMON'|'TARGETED'
}
},
]
}
},
'operation': {
'id': 'string',
'resourceName': 'string',
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'createdAt': datetime(2015, 1, 1),
'location': {
'availabilityZone': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1'
},
'isTerminal': True|False,
'operationDetails': 'string',
'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps'|'GetProfile',
'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
'statusChangedAt': datetime(2015, 1, 1),
'errorCode': 'string',
'errorDetails': 'string'
}
}
Response Structure
(dict) --
distribution (dict) --
An object that describes the distribution created.
name (string) --
The name of the distribution.
arn (string) --
The Amazon Resource Name (ARN) of the distribution.
supportCode (string) --
The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
createdAt (datetime) --
The timestamp when the distribution was created.
location (dict) --
An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
availabilityZone (string) --
The Availability Zone. Follows the format us-east-2a (case-sensitive).
regionName (string) --
The Amazon Web Services Region name.
resourceType (string) --
The Lightsail resource type ( Distribution).
alternativeDomainNames (list) --
The alternate domain names of the distribution.
(string) --
status (string) --
The status of the distribution.
isEnabled (boolean) --
Indicates whether the distribution is enabled.
domainName (string) --
The domain name of the distribution.
bundleId (string) --
The ID of the bundle currently applied to the distribution.
certificateName (string) --
The name of the SSL/TLS certificate attached to the distribution, if any.
origin (dict) --
An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
name (string) --
The name of the origin resource.
resourceType (string) --
The resource type of the origin resource (Instance).
regionName (string) --
The AWS Region name of the origin resource.
protocolPolicy (string) --
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
responseTimeout (integer) --
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
ipAddressType (string) --
The IP address type that the distribution uses when connecting to the origin.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
isPrivateOriginAccessEnabled (boolean) --
Specifies whether private origin access is enabled for the distribution's origin. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.
This applies when you set the bucket's getObject access rule to private. It also applies when you set getObject to public but set individual objects to private.
originPublicDNS (string) --
The public DNS of the origin.
defaultCacheBehavior (dict) --
An object that describes the default cache behavior of the distribution.
behavior (string) --
The cache behavior of the distribution.
The following cache behaviors can be specified:
cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
cacheBehaviorSettings (dict) --
An object that describes the cache behavior settings of the distribution.
defaultTTL (integer) --
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
minimumTTL (integer) --
The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --
The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
allowedHTTPMethods (string) --
The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD - The distribution forwards the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD - The distribution caches responses to the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
forwardedCookies (dict) --
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option (string) --
Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
cookiesAllowList (list) --
The specific cookies to forward to your distribution's origin.
(string) --
forwardedHeaders (dict) --
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option (string) --
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all - Forward all headers to your origin.
none - Forward only the default headers.
allow-list - Forward only the headers you specify using the headersAllowList parameter.
headersAllowList (list) --
The specific headers to forward to your distribution's origin.
(string) --
forwardedQueryStrings (dict) --
An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option (boolean) --
Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList (list) --
The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
(string) --
cacheBehaviors (list) --
An array of objects that describe the per-path cache behavior of the distribution.
(dict) --
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
path (string) --
The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
behavior (string) --
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache - This behavior caches the specified path.
dont-cache - This behavior doesn't cache the specified path.
ableToUpdateBundle (boolean) --
Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
Use the UpdateDistributionBundle action to change your distribution's bundle.
ipAddressType (string) --
The IP address type of the distribution.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
tags (list) --
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
(dict) --
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
key (string) --
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value (string) --
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
viewerMinimumTlsProtocolVersion (string) --
The minimum TLS protocol version that the distribution can use to communicate with viewers.
defaultRootObject (string) --
The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution ( /) instead of a specific object.
customErrorResponses (list) --
An array of objects that describe the custom error responses configured for the distribution.
(dict) --
Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.
errorCode (integer) --
The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).
responseCode (string) --
The HTTP status code that the distribution returns to the viewer for the custom error response.
responsePagePath (string) --
The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash ( /) and reference an object that is available from the origin.
errorCachingMinTTL (integer) --
The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.
waf (dict) --
An object that describes the Web Application Firewall (WAF) configuration of the distribution.
isWafEnabled (boolean) --
Specifies whether WAF is enabled for the distribution.
wafRules (list) --
An array of objects that describe the WAF rule groups enabled for the distribution.
(dict) --
Describes a Web Application Firewall (WAF) rule group for a Lightsail distribution. A WAF rule group is a set of rules managed by AWS. The rules inspect viewer requests and block requests that match them.
name (string) --
The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).
For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.
atpConfig (dict) --
An object that describes the configuration of the account takeover prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesATPRuleSet.
This parameter is required when the name is AWSManagedRulesATPRuleSet.
loginPath (string) --
The path of the login endpoint of your application (for example, /login). Login paths that start with the path that you specify are a match.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
payloadType (string) --
The content type of the request body of login requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
usernameField (string) --
The name of the field in the request body that contains the username (for example, /username for JSON or username for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
passwordField (string) --
The name of the field in the request body that contains the password (for example, /password for JSON or password for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed login attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
acfpConfig (dict) --
An object that describes the configuration of the account creation fraud prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesACFPRuleSet.
This parameter is required when the name is AWSManagedRulesACFPRuleSet.
payloadType (string) --
The content type of the request body of account creation requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
creationPath (string) --
The path of the endpoint that accepts completed account creation forms (for example, /signup/submit). This endpoint must accept POST requests.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
registrationPagePath (string) --
The path of the page that displays the account creation form (for example, /signup).
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed account creation attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
botControlConfig (dict) --
An object that describes the configuration of the bot control rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.
This parameter is required when the name is AWSManagedRulesBotControlRuleSet.
inspectionLevel (string) --
The inspection level of the bot control rule group.
The following inspection levels are possible:
COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.
TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.
operation (dict) --
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id (string) --
The ID of the operation.
resourceName (string) --
The resource name.
resourceType (string) --
The resource type.
createdAt (datetime) --
The timestamp when the operation was initialized ( 1479816991.349).
location (dict) --
The Amazon Web Services Region and Availability Zone.
availabilityZone (string) --
The Availability Zone. Follows the format us-east-2a (case-sensitive).
regionName (string) --
The Amazon Web Services Region name.
isTerminal (boolean) --
A Boolean value indicating whether the operation is terminal.
operationDetails (string) --
Details about the operation ( Debian-1GB-Ohio-1).
operationType (string) --
The type of operation.
status (string) --
The status of the operation.
statusChangedAt (datetime) --
The timestamp when the status was changed ( 1479816991.349).
errorCode (string) --
The error code.
errorDetails (string) --
The error details.
{'metricName': {'WafBlockedRequests', 'WafAllowedRequests'}}
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
See also: AWS API Documentation
Request Syntax
client.get_distribution_metric_data(
distributionName='string',
metricName='Requests'|'BytesDownloaded'|'BytesUploaded'|'TotalErrorRate'|'Http4xxErrorRate'|'Http5xxErrorRate'|'WafAllowedRequests'|'WafBlockedRequests',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
period=123,
unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
statistics=[
'Minimum'|'Maximum'|'Sum'|'Average'|'SampleCount',
]
)
string
[REQUIRED]
The name of the distribution for which to get metric data.
Use the GetDistributions action to get a list of distribution names that you can specify.
string
[REQUIRED]
The metric for which you want to return information.
Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
WafAllowedRequests - The number of viewer requests that Web Application Firewall (WAF) allowed. This metric is available only when WAF is enabled for the distribution. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
WafBlockedRequests - The number of viewer requests that WAF blocked. This metric is available only when WAF is enabled for the distribution. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
datetime
[REQUIRED]
The start of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
datetime
[REQUIRED]
The end of the time interval for which to get metric data.
Constraints:
Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
integer
[REQUIRED]
The granularity, in seconds, for the metric data points that will be returned.
string
[REQUIRED]
The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.
list
[REQUIRED]
The statistic for the metric.
The following statistics are available:
Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.
(string) --
dict
Response Syntax
{
'metricName': 'Requests'|'BytesDownloaded'|'BytesUploaded'|'TotalErrorRate'|'Http4xxErrorRate'|'Http5xxErrorRate'|'WafAllowedRequests'|'WafBlockedRequests',
'metricData': [
{
'average': 123.0,
'maximum': 123.0,
'minimum': 123.0,
'sampleCount': 123.0,
'sum': 123.0,
'timestamp': datetime(2015, 1, 1),
'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
]
}
Response Structure
(dict) --
metricName (string) --
The name of the metric returned.
metricData (list) --
An array of objects that describe the metric data returned.
(dict) --
Describes the metric data point.
average (float) --
The average.
maximum (float) --
The maximum.
minimum (float) --
The minimum.
sampleCount (float) --
The sample count.
sum (float) --
The sum.
timestamp (datetime) --
The timestamp ( 1479816991.349).
unit (string) --
The unit.
{'distributions': {'waf': {'isWafEnabled': 'boolean',
'wafRules': [{'acfpConfig': {'creationPath': 'string',
'payloadType': 'JSON | '
'FORM_ENCODED',
'registrationPagePath': 'string',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']}},
'atpConfig': {'loginPath': 'string',
'passwordField': 'string',
'payloadType': 'JSON | '
'FORM_ENCODED',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']},
'usernameField': 'string'},
'botControlConfig': {'inspectionLevel': 'COMMON '
'| '
'TARGETED'},
'name': 'string'}]}}}
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
See also: AWS API Documentation
Request Syntax
client.get_distributions(
distributionName='string',
pageToken='string'
)
string
The name of the distribution for which to return information.
When omitted, the response includes all of your distributions in the Amazon Web Services Region where the request is made.
string
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
dict
Response Syntax
{
'distributions': [
{
'name': 'string',
'arn': 'string',
'supportCode': 'string',
'createdAt': datetime(2015, 1, 1),
'location': {
'availabilityZone': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1'
},
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'alternativeDomainNames': [
'string',
],
'status': 'string',
'isEnabled': True|False,
'domainName': 'string',
'bundleId': 'string',
'certificateName': 'string',
'origin': {
'name': 'string',
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1',
'protocolPolicy': 'http-only'|'https-only',
'responseTimeout': 123,
'ipAddressType': 'ipv4'|'ipv6'|'dualstack',
'isPrivateOriginAccessEnabled': True|False
},
'originPublicDNS': 'string',
'defaultCacheBehavior': {
'behavior': 'dont-cache'|'cache'
},
'cacheBehaviorSettings': {
'defaultTTL': 123,
'minimumTTL': 123,
'maximumTTL': 123,
'allowedHTTPMethods': 'string',
'cachedHTTPMethods': 'string',
'forwardedCookies': {
'option': 'none'|'allow-list'|'all',
'cookiesAllowList': [
'string',
]
},
'forwardedHeaders': {
'option': 'none'|'allow-list'|'all',
'headersAllowList': [
'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
]
},
'forwardedQueryStrings': {
'option': True|False,
'queryStringsAllowList': [
'string',
]
}
},
'cacheBehaviors': [
{
'path': 'string',
'behavior': 'dont-cache'|'cache'
},
],
'ableToUpdateBundle': True|False,
'ipAddressType': 'dualstack'|'ipv4'|'ipv6',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'viewerMinimumTlsProtocolVersion': 'string',
'defaultRootObject': 'string',
'customErrorResponses': [
{
'errorCode': 123,
'responseCode': 'string',
'responsePagePath': 'string',
'errorCachingMinTTL': 123
},
],
'waf': {
'isWafEnabled': True|False,
'wafRules': [
{
'name': 'string',
'atpConfig': {
'loginPath': 'string',
'payloadType': 'JSON'|'FORM_ENCODED',
'usernameField': 'string',
'passwordField': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'acfpConfig': {
'payloadType': 'JSON'|'FORM_ENCODED',
'creationPath': 'string',
'registrationPagePath': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'botControlConfig': {
'inspectionLevel': 'COMMON'|'TARGETED'
}
},
]
}
},
],
'nextPageToken': 'string'
}
Response Structure
(dict) --
distributions (list) --
An array of objects that describe your distributions.
(dict) --
Describes an Amazon Lightsail content delivery network (CDN) distribution.
name (string) --
The name of the distribution.
arn (string) --
The Amazon Resource Name (ARN) of the distribution.
supportCode (string) --
The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
createdAt (datetime) --
The timestamp when the distribution was created.
location (dict) --
An object that describes the location of the distribution, such as the Amazon Web Services Region and Availability Zone.
availabilityZone (string) --
The Availability Zone. Follows the format us-east-2a (case-sensitive).
regionName (string) --
The Amazon Web Services Region name.
resourceType (string) --
The Lightsail resource type ( Distribution).
alternativeDomainNames (list) --
The alternate domain names of the distribution.
(string) --
status (string) --
The status of the distribution.
isEnabled (boolean) --
Indicates whether the distribution is enabled.
domainName (string) --
The domain name of the distribution.
bundleId (string) --
The ID of the bundle currently applied to the distribution.
certificateName (string) --
The name of the SSL/TLS certificate attached to the distribution, if any.
origin (dict) --
An object that describes the origin resource of the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
name (string) --
The name of the origin resource.
resourceType (string) --
The resource type of the origin resource (Instance).
regionName (string) --
The AWS Region name of the origin resource.
protocolPolicy (string) --
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
responseTimeout (integer) --
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
ipAddressType (string) --
The IP address type that the distribution uses when connecting to the origin.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
isPrivateOriginAccessEnabled (boolean) --
Specifies whether private origin access is enabled for the distribution's origin. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.
This applies when you set the bucket's getObject access rule to private. It also applies when you set getObject to public but set individual objects to private.
originPublicDNS (string) --
The public DNS of the origin.
defaultCacheBehavior (dict) --
An object that describes the default cache behavior of the distribution.
behavior (string) --
The cache behavior of the distribution.
The following cache behaviors can be specified:
cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
cacheBehaviorSettings (dict) --
An object that describes the cache behavior settings of the distribution.
defaultTTL (integer) --
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
minimumTTL (integer) --
The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --
The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
allowedHTTPMethods (string) --
The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD - The distribution forwards the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD - The distribution caches responses to the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
forwardedCookies (dict) --
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option (string) --
Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
cookiesAllowList (list) --
The specific cookies to forward to your distribution's origin.
(string) --
forwardedHeaders (dict) --
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option (string) --
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all - Forward all headers to your origin.
none - Forward only the default headers.
allow-list - Forward only the headers you specify using the headersAllowList parameter.
headersAllowList (list) --
The specific headers to forward to your distribution's origin.
(string) --
forwardedQueryStrings (dict) --
An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option (boolean) --
Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList (list) --
The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
(string) --
cacheBehaviors (list) --
An array of objects that describe the per-path cache behavior of the distribution.
(dict) --
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
path (string) --
The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
behavior (string) --
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache - This behavior caches the specified path.
dont-cache - This behavior doesn't cache the specified path.
ableToUpdateBundle (boolean) --
Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle.
Use the UpdateDistributionBundle action to change your distribution's bundle.
ipAddressType (string) --
The IP address type of the distribution.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
tags (list) --
The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
(dict) --
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
key (string) --
The key of the tag.
Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
value (string) --
The value of the tag.
Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
viewerMinimumTlsProtocolVersion (string) --
The minimum TLS protocol version that the distribution can use to communicate with viewers.
defaultRootObject (string) --
The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution ( /) instead of a specific object.
customErrorResponses (list) --
An array of objects that describe the custom error responses configured for the distribution.
(dict) --
Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.
errorCode (integer) --
The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).
responseCode (string) --
The HTTP status code that the distribution returns to the viewer for the custom error response.
responsePagePath (string) --
The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash ( /) and reference an object that is available from the origin.
errorCachingMinTTL (integer) --
The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.
waf (dict) --
An object that describes the Web Application Firewall (WAF) configuration of the distribution.
isWafEnabled (boolean) --
Specifies whether WAF is enabled for the distribution.
wafRules (list) --
An array of objects that describe the WAF rule groups enabled for the distribution.
(dict) --
Describes a Web Application Firewall (WAF) rule group for a Lightsail distribution. A WAF rule group is a set of rules managed by AWS. The rules inspect viewer requests and block requests that match them.
name (string) --
The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).
For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.
atpConfig (dict) --
An object that describes the configuration of the account takeover prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesATPRuleSet.
This parameter is required when the name is AWSManagedRulesATPRuleSet.
loginPath (string) --
The path of the login endpoint of your application (for example, /login). Login paths that start with the path that you specify are a match.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
payloadType (string) --
The content type of the request body of login requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
usernameField (string) --
The name of the field in the request body that contains the username (for example, /username for JSON or username for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
passwordField (string) --
The name of the field in the request body that contains the password (for example, /password for JSON or password for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed login attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
acfpConfig (dict) --
An object that describes the configuration of the account creation fraud prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesACFPRuleSet.
This parameter is required when the name is AWSManagedRulesACFPRuleSet.
payloadType (string) --
The content type of the request body of account creation requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
creationPath (string) --
The path of the endpoint that accepts completed account creation forms (for example, /signup/submit). This endpoint must accept POST requests.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
registrationPagePath (string) --
The path of the page that displays the account creation form (for example, /signup).
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed account creation attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
botControlConfig (dict) --
An object that describes the configuration of the bot control rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.
This parameter is required when the name is AWSManagedRulesBotControlRuleSet.
inspectionLevel (string) --
The inspection level of the bot control rule group.
The following inspection levels are possible:
COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.
TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.
nextPageToken (string) --
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.
{'enableWaf': 'boolean',
'wafRules': [{'acfpConfig': {'creationPath': 'string',
'payloadType': 'JSON | FORM_ENCODED',
'registrationPagePath': 'string',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']}},
'atpConfig': {'loginPath': 'string',
'passwordField': 'string',
'payloadType': 'JSON | FORM_ENCODED',
'responseInspection': {'failureCodes': ['integer'],
'successCodes': ['integer']},
'usernameField': 'string'},
'botControlConfig': {'inspectionLevel': 'COMMON | TARGETED'},
'name': 'string'}]}
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
See also: AWS API Documentation
Request Syntax
client.update_distribution(
distributionName='string',
origin={
'name': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1',
'protocolPolicy': 'http-only'|'https-only',
'responseTimeout': 123,
'ipAddressType': 'ipv4'|'ipv6'|'dualstack'
},
defaultCacheBehavior={
'behavior': 'dont-cache'|'cache'
},
cacheBehaviorSettings={
'defaultTTL': 123,
'minimumTTL': 123,
'maximumTTL': 123,
'allowedHTTPMethods': 'string',
'cachedHTTPMethods': 'string',
'forwardedCookies': {
'option': 'none'|'allow-list'|'all',
'cookiesAllowList': [
'string',
]
},
'forwardedHeaders': {
'option': 'none'|'allow-list'|'all',
'headersAllowList': [
'Accept'|'Accept-Charset'|'Accept-Datetime'|'Accept-Encoding'|'Accept-Language'|'Authorization'|'CloudFront-Forwarded-Proto'|'CloudFront-Is-Desktop-Viewer'|'CloudFront-Is-Mobile-Viewer'|'CloudFront-Is-SmartTV-Viewer'|'CloudFront-Is-Tablet-Viewer'|'CloudFront-Viewer-Country'|'Host'|'Origin'|'Referer',
]
},
'forwardedQueryStrings': {
'option': True|False,
'queryStringsAllowList': [
'string',
]
}
},
cacheBehaviors=[
{
'path': 'string',
'behavior': 'dont-cache'|'cache'
},
],
isEnabled=True|False,
viewerMinimumTlsProtocolVersion='TLSv1.1_2016'|'TLSv1.2_2018'|'TLSv1.2_2019'|'TLSv1.2_2021',
certificateName='string',
useDefaultCertificate=True|False,
enablePrivateOriginAccess=True|False,
defaultRootObject='string',
customErrorResponses=[
{
'errorCode': 123,
'responseCode': 'string',
'responsePagePath': 'string',
'errorCachingMinTTL': 123
},
],
enableWaf=True|False,
wafRules=[
{
'name': 'string',
'atpConfig': {
'loginPath': 'string',
'payloadType': 'JSON'|'FORM_ENCODED',
'usernameField': 'string',
'passwordField': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'acfpConfig': {
'payloadType': 'JSON'|'FORM_ENCODED',
'creationPath': 'string',
'registrationPagePath': 'string',
'responseInspection': {
'successCodes': [
123,
],
'failureCodes': [
123,
]
}
},
'botControlConfig': {
'inspectionLevel': 'COMMON'|'TARGETED'
}
},
]
)
string
[REQUIRED]
The name of the distribution to update.
Use the GetDistributions action to get a list of distribution names that you can specify.
dict
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
name (string) --
The name of the origin resource.
regionName (string) --
The AWS Region name of the origin resource.
protocolPolicy (string) --
The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
responseTimeout (integer) --
The amount of time, in seconds, that the distribution waits for a response after forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds.
ipAddressType (string) --
The IP address type that the distribution uses when connecting to the origin.
The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.
dict
An object that describes the default cache behavior for the distribution.
behavior (string) --
The cache behavior of the distribution.
The following cache behaviors can be specified:
cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content.
dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
dict
An object that describes the cache behavior settings for the distribution.
defaultTTL (integer) --
The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.
minimumTTL (integer) --
The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
maximumTTL (integer) --
The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.
The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
allowedHTTPMethods (string) --
The HTTP methods that are processed and forwarded to the distribution's origin.
You can specify the following options:
GET,HEAD - The distribution forwards the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.
If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
cachedHTTPMethods (string) --
The HTTP method responses that are cached by your distribution.
You can specify the following options:
GET,HEAD - The distribution caches responses to the GET and HEAD methods.
GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
forwardedCookies (dict) --
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
option (string) --
Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
cookiesAllowList (list) --
The specific cookies to forward to your distribution's origin.
(string) --
forwardedHeaders (dict) --
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
option (string) --
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
all - Forward all headers to your origin.
none - Forward only the default headers.
allow-list - Forward only the headers you specify using the headersAllowList parameter.
headersAllowList (list) --
The specific headers to forward to your distribution's origin.
(string) --
forwardedQueryStrings (dict) --
An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
option (boolean) --
Indicates whether the distribution forwards and caches based on query strings.
queryStringsAllowList (list) --
The specific query strings that the distribution forwards to the origin.
Your distribution will cache content based on the specified query strings.
If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
(string) --
list
An array of objects that describe the per-path cache behavior for the distribution.
(dict) --
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.
A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.
path (string) --
The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types ( *.html, *jpg, *js). Directories and file paths are case-sensitive.
Examples:
Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/
Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html
Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html
Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
behavior (string) --
The cache behavior for the specified path.
You can specify one of the following per-path cache behaviors:
cache - This behavior caches the specified path.
dont-cache - This behavior doesn't cache the specified path.
boolean
Indicates whether to enable the distribution.
string
Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
string
The name of the SSL/TLS certificate that you want to attach to the distribution.
Only certificates with a status of ISSUED can be attached to a distribution.
Use the GetCertificates action to get a list of certificate names that you can specify.
boolean
Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is true. When true, the distribution uses the default domain name such as d111111abcdef8.cloudfront.net.
Set this value to false to attach a new certificate to the distribution.
boolean
Specifies whether to enable private origin access for the distribution. With private origin access, the distribution can serve objects that aren't publicly accessible from a Lightsail bucket.
Lightsail grants the distribution permission to read the bucket's objects. Enabling private origin access doesn't change the bucket's access settings, and you can still retrieve publicly accessible objects directly from the bucket's endpoint.
string
The object (for example, index.html) that the distribution returns when a viewer requests the root URL of the distribution ( /) instead of a specific object. The object that you specify must be available from the origin.
list
An array of objects that describe the custom error responses for the distribution. With a custom error response, you can specify the page to return when the origin responds with a given HTTP error code. You can also specify the HTTP status code to send to the viewer.
(dict) --
Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.
errorCode (integer) --
The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).
responseCode (string) --
The HTTP status code that the distribution returns to the viewer for the custom error response.
responsePagePath (string) --
The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash ( /) and reference an object that is available from the origin.
errorCachingMinTTL (integer) --
The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.
boolean
Specifies whether to enable Web Application Firewall (WAF) for the distribution. WAF inspects viewer requests and blocks requests that match the WAF rule groups that you enable.
When you enable WAF without specifying the wafRules parameter, the distribution has no WAF rule groups enabled and doesn't block any requests.
list
An array of objects that describe the WAF rule groups to enable for the distribution.
The array that you specify replaces the existing WAF rule groups of the distribution. To keep a WAF rule group enabled, include it in the array. To disable all WAF rule groups, specify an empty array.
You can specify this parameter only when WAF is enabled for the distribution.
The WAF rule groups that you can specify depend on the bundle of the distribution:
medium_1_0 – Supports the AWSManagedRulesCommonRuleSet, AWSManagedRulesKnownBadInputsRuleSet, and AWSManagedRulesAnonymousIpList rule groups.
large_1_0 – Supports the rule groups for medium_1_0, plus AWSManagedRulesAdminProtectionRuleSet, AWSManagedRulesSQLiRuleSet, AWSManagedRulesLinuxRuleSet, AWSManagedRulesUnixRuleSet, AWSManagedRulesWindowsRuleSet, AWSManagedRulesPHPRuleSet, AWSManagedRulesWordPressRuleSet, AWSManagedRulesAmazonIpReputationList, AWSManagedRulesATPRuleSet, AWSManagedRulesACFPRuleSet, and AWSManagedRulesBotControlRuleSet rule groups.
(dict) --
Describes a Web Application Firewall (WAF) rule group for a Lightsail distribution. A WAF rule group is a set of rules managed by AWS. The rules inspect viewer requests and block requests that match them.
name (string) -- [REQUIRED]
The name of the WAF rule group (for example, AWSManagedRulesCommonRuleSet).
For the WAF rule groups that you can specify for each bundle, see the wafRules parameter of the CreateDistribution action.
atpConfig (dict) --
An object that describes the configuration of the account takeover prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesATPRuleSet.
This parameter is required when the name is AWSManagedRulesATPRuleSet.
loginPath (string) --
The path of the login endpoint of your application (for example, /login). Login paths that start with the path that you specify are a match.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
payloadType (string) --
The content type of the request body of login requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
usernameField (string) --
The name of the field in the request body that contains the username (for example, /username for JSON or username for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
passwordField (string) --
The name of the field in the request body that contains the password (for example, /password for JSON or password for FORM_ENCODED).
Constraints:
For a JSON payload, must be a JSON pointer that starts with a forward slash ( /).
Must contain from 1 to 512 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed login attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
acfpConfig (dict) --
An object that describes the configuration of the account creation fraud prevention rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesACFPRuleSet.
This parameter is required when the name is AWSManagedRulesACFPRuleSet.
payloadType (string) --
The content type of the request body of account creation requests.
The following content types are possible:
JSON – The request body is in JSON format.
FORM_ENCODED – The request body is form encoded.
creationPath (string) --
The path of the endpoint that accepts completed account creation forms (for example, /signup/submit). This endpoint must accept POST requests.
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
registrationPagePath (string) --
The path of the page that displays the account creation form (for example, /signup).
Constraints:
Must start with a forward slash ( /).
Must contain from 1 to 256 characters.
responseInspection (dict) --
An object that describes the HTTP status codes that your application returns for successful and failed account creation attempts.
successCodes (list) --
The HTTP status codes that indicate a successful attempt (for example, 200).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in failureCodes.
(integer) --
failureCodes (list) --
The HTTP status codes that indicate a failed attempt (for example, 401).
Constraints:
Must contain from 1 to 10 status codes.
Each status code must be from 0 to 999.
Can't contain a status code that is also in successCodes.
(integer) --
botControlConfig (dict) --
An object that describes the configuration of the bot control rule group.
Constraints:
Define this parameter only when the name is AWSManagedRulesBotControlRuleSet.
This parameter is required when the name is AWSManagedRulesBotControlRuleSet.
inspectionLevel (string) --
The inspection level of the bot control rule group.
The following inspection levels are possible:
COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.
TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.
dict
Response Syntax
{
'operation': {
'id': 'string',
'resourceName': 'string',
'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
'createdAt': datetime(2015, 1, 1),
'location': {
'availabilityZone': 'string',
'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'eu-north-1'|'eu-south-2'|'ca-central-1'|'ap-east-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-southeast-3'|'ap-southeast-5'|'sa-east-1'
},
'isTerminal': True|False,
'operationDetails': 'string',
'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps'|'GetProfile',
'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
'statusChangedAt': datetime(2015, 1, 1),
'errorCode': 'string',
'errorDetails': 'string'
}
}
Response Structure
(dict) --
operation (dict) --
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id (string) --
The ID of the operation.
resourceName (string) --
The resource name.
resourceType (string) --
The resource type.
createdAt (datetime) --
The timestamp when the operation was initialized ( 1479816991.349).
location (dict) --
The Amazon Web Services Region and Availability Zone.
availabilityZone (string) --
The Availability Zone. Follows the format us-east-2a (case-sensitive).
regionName (string) --
The Amazon Web Services Region name.
isTerminal (boolean) --
A Boolean value indicating whether the operation is terminal.
operationDetails (string) --
Details about the operation ( Debian-1GB-Ohio-1).
operationType (string) --
The type of operation.
status (string) --
The status of the operation.
statusChangedAt (datetime) --
The timestamp when the status was changed ( 1479816991.349).
errorCode (string) --
The error code.
errorDetails (string) --
The error details.