{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.lightsail#AccessDeniedException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when the user cannot be authenticated or uses invalid\n credentials to access a resource.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.lightsail#AccessDirection": { "type": "enum", "members": { "inbound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "inbound" } }, "outbound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "outbound" } } } }, "com.amazonaws.lightsail#AccessKey": { "type": "structure", "members": { "accessKeyId": { "target": "com.amazonaws.lightsail#IAMAccessKeyId", "traits": { "smithy.api#documentation": "

The ID of the access key.

" } }, "secretAccessKey": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The secret access key used to sign requests.

\n

You should store the secret access key in a safe location. We recommend that you delete\n the access key if the secret access key is compromised.

" } }, "status": { "target": "com.amazonaws.lightsail#StatusType", "traits": { "smithy.api#documentation": "

The status of the access key.

\n

A status of Active means that the key is valid, while Inactive\n means it is not.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the access key was created.

" } }, "lastUsed": { "target": "com.amazonaws.lightsail#AccessKeyLastUsed", "traits": { "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes an access key for an Amazon Lightsail bucket.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n
" } }, "com.amazonaws.lightsail#AccessKeyLastUsed": { "type": "structure", "members": { "lastUsedDate": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" } }, "region": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" } }, "serviceName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the Amazon Web Services service with which this access key was most recently\n used.

\n

This value is N/A if the access key has not been used.

" } } }, "traits": { "smithy.api#documentation": "

Describes the last time an access key was used.

\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n
" } }, "com.amazonaws.lightsail#AccessKeyList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AccessKey" } }, "com.amazonaws.lightsail#AccessReceiverList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ResourceReceivingAccess" } }, "com.amazonaws.lightsail#AccessRules": { "type": "structure", "members": { "getObject": { "target": "com.amazonaws.lightsail#AccessType", "traits": { "smithy.api#documentation": "

Specifies the anonymous access to all objects in a bucket.

\n

The following options can be specified:

\n " } }, "allowPublicOverrides": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether the access control list (ACL) permissions that are\n applied to individual objects override the getObject option that is currently\n specified.

\n

When this is true, you can use the PutObjectAcl Amazon S3 API action to set\n individual objects to public (read-only) using the public-read ACL, or to private\n using the private ACL.

" } } }, "traits": { "smithy.api#documentation": "

Describes the anonymous access permissions for an Amazon Lightsail bucket and its\n objects.

\n

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

\n

\n Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#AccessType": { "type": "enum", "members": { "Public": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "public" } }, "Private": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "private" } } } }, "com.amazonaws.lightsail#AccountLevelBpaSync": { "type": "structure", "members": { "status": { "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", "traits": { "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n
" } }, "lastSyncedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" } }, "message": { "target": "com.amazonaws.lightsail#BPAStatusMessage", "traits": { "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n

The following messages are possible:

\n " } }, "bpaImpactsLightsail": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

" } } }, "traits": { "smithy.api#documentation": "

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { "type": "enum", "members": { "InSync": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InSync" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "NeverSynced": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NeverSynced" } }, "Defaulted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Defaulted" } } } }, "com.amazonaws.lightsail#AccountSetupInProgressException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when an account is still in the setup in progress\n state.

", "smithy.api#error": "client", "smithy.api#httpError": 428 } }, "com.amazonaws.lightsail#AddOn": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the add-on.

" } }, "status": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The status of the add-on.

" } }, "snapshotTimeOfDay": { "target": "com.amazonaws.lightsail#TimeOfDay", "traits": { "smithy.api#documentation": "

The daily time when an automatic snapshot is created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" } }, "nextSnapshotTimeOfDay": { "target": "com.amazonaws.lightsail#TimeOfDay", "traits": { "smithy.api#documentation": "

The next daily time an automatic snapshot will be created.

\n

The time shown is in HH:00 format, and in Coordinated Universal Time\n (UTC).

\n

The snapshot is automatically created between the time shown and up to 45 minutes\n after.

" } }, "threshold": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The trigger threshold of the action.

\n \n

This add-on only applies to Lightsail for Research resources.

\n
" } }, "duration": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically\n stop.

\n \n

This add-on only applies to Lightsail for Research resources.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes an add-on that is enabled for an Amazon Lightsail resource.

" } }, "com.amazonaws.lightsail#AddOnList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AddOn" } }, "com.amazonaws.lightsail#AddOnRequest": { "type": "structure", "members": { "addOnType": { "target": "com.amazonaws.lightsail#AddOnType", "traits": { "smithy.api#documentation": "

The add-on type.

", "smithy.api#required": {} } }, "autoSnapshotAddOnRequest": { "target": "com.amazonaws.lightsail#AutoSnapshotAddOnRequest", "traits": { "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the automatic\n snapshot add-on.

" } }, "stopInstanceOnIdleRequest": { "target": "com.amazonaws.lightsail#StopInstanceOnIdleRequest", "traits": { "smithy.api#documentation": "

An object that represents additional parameters when enabling or modifying the\n StopInstanceOnIdle add-on.

\n \n

This object only applies to Lightsail for Research resources.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail\n resource.

\n \n

An additional cost may be associated with enabling add-ons. For more information, see\n the Lightsail pricing\n page.

\n
" } }, "com.amazonaws.lightsail#AddOnRequestList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AddOnRequest" } }, "com.amazonaws.lightsail#AddOnType": { "type": "enum", "members": { "AutoSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AutoSnapshot" } }, "StopInstanceOnIdle": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StopInstanceOnIdle" } } } }, "com.amazonaws.lightsail#Alarm": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the alarm was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

An object that lists information about the location of the alarm.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type of the alarm.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail alarm. This code enables our support team to look up your Lightsail\n information more easily.

" } }, "monitoredResourceInfo": { "target": "com.amazonaws.lightsail#MonitoredResourceInfo", "traits": { "smithy.api#documentation": "

An object that lists information about the resource monitored by the alarm.

" } }, "comparisonOperator": { "target": "com.amazonaws.lightsail#ComparisonOperator", "traits": { "smithy.api#documentation": "

The arithmetic operation used when comparing the specified statistic and threshold.

" } }, "evaluationPeriods": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.

" } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied.

" } }, "threshold": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The value against which the specified statistic is compared.

" } }, "datapointsToAlarm": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of data points that must not within the specified threshold to trigger the\n alarm.

" } }, "treatMissingData": { "target": "com.amazonaws.lightsail#TreatMissingData", "traits": { "smithy.api#documentation": "

Specifies how the alarm handles missing data points.

\n

An alarm can treat missing data in the following ways:

\n " } }, "statistic": { "target": "com.amazonaws.lightsail#MetricStatistic", "traits": { "smithy.api#documentation": "

The statistic for the metric associated with the alarm.

\n

The following statistics are available:

\n " } }, "metricName": { "target": "com.amazonaws.lightsail#MetricName", "traits": { "smithy.api#documentation": "

The name of the metric associated with the alarm.

" } }, "state": { "target": "com.amazonaws.lightsail#AlarmState", "traits": { "smithy.api#documentation": "

The current state of the alarm.

\n

An alarm has the following possible states:

\n " } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit of the metric associated with the alarm.

" } }, "contactProtocols": { "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { "smithy.api#documentation": "

The contact protocols for the alarm, such as Email, SMS (text\n messaging), or both.

" } }, "notificationTriggers": { "target": "com.amazonaws.lightsail#NotificationTriggerList", "traits": { "smithy.api#documentation": "

The alarm states that trigger a notification.

" } }, "notificationEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the alarm is enabled.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#documentation": "

Describes an alarm.

\n

An alarm is a way to monitor your Lightsail resource metrics. For more information, see\n Alarms in Amazon Lightsail.

" } }, "com.amazonaws.lightsail#AlarmState": { "type": "enum", "members": { "OK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OK" } }, "ALARM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALARM" } }, "INSUFFICIENT_DATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSUFFICIENT_DATA" } } } }, "com.amazonaws.lightsail#AlarmsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Alarm" } }, "com.amazonaws.lightsail#AllocateStaticIp": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AllocateStaticIpRequest" }, "output": { "target": "com.amazonaws.lightsail#AllocateStaticIpResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Allocates a static IP address.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AllocateStaticIp", "code": 200 } } }, "com.amazonaws.lightsail#AllocateStaticIpRequest": { "type": "structure", "members": { "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP address.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AllocateStaticIpResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AppCategory": { "type": "enum", "members": { "LfR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LfR" } } } }, "com.amazonaws.lightsail#AppCategoryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AppCategory" } }, "com.amazonaws.lightsail#AttachCertificateToDistribution": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AttachCertificateToDistributionRequest" }, "output": { "target": "com.amazonaws.lightsail#AttachCertificateToDistributionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", "code": 200 } } }, "com.amazonaws.lightsail#AttachCertificateToDistributionRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution that the certificate will be attached to.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", "smithy.api#required": {} } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the certificate to attach to a distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

\n \n

This is the name of the certificate resource type and is used only to reference the\n certificate in other API actions. It can be different than the domain name of the\n certificate. For example, your certificate name might be\n WordPress-Blog-Certificate and the domain name of the certificate might be\n example.com.

\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AttachCertificateToDistributionResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachDisk": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AttachDiskRequest" }, "output": { "target": "com.amazonaws.lightsail#AttachDiskResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it\n to the instance with the specified disk name.

\n

The attach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachDisk", "code": 200 } } }, "com.amazonaws.lightsail#AttachDiskRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique Lightsail disk name (my-disk).

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance where you want to utilize the storage disk.

", "smithy.api#required": {} } }, "diskPath": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The disk path to expose to the instance (/dev/xvdf).

", "smithy.api#required": {} } }, "autoMounting": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value used to determine the automatic mounting of a storage volume to a virtual\n computer. The default value is False.

\n \n

This value only applies to Lightsail for Research resources.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AttachDiskResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest" }, "output": { "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Attaches one or more Lightsail instances to a load balancer.

\n

After some time, the instances are attached to the load balancer and the health check\n status is available.

\n

The attach instances to load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachInstancesToLoadBalancer", "code": 200 } } }, "com.amazonaws.lightsail#AttachInstancesToLoadBalancerRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, "instanceNames": { "target": "com.amazonaws.lightsail#ResourceNameList", "traits": { "smithy.api#documentation": "

An array of strings representing the instance name(s) you want to attach to your load\n balancer.

\n

An instance must be running before you can attach it to your load\n balancer.

\n

There are no additional limits on the number of instances you can attach to your load\n balancer, aside from the limit of Lightsail instances you can create in your account\n (20).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AttachInstancesToLoadBalancerResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest" }, "output": { "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just\n an updated, more secure version of Secure Socket Layer (SSL).

\n

Once you create and validate your certificate, you can attach it to your load balancer.\n You can also use this API to rotate the certificates on your account. Use the\n AttachLoadBalancerTlsCertificate action with the non-attached certificate, and\n it will replace the existing one and become the attached certificate.

\n

The AttachLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachLoadBalancerTlsCertificate", "code": 200 } } }, "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer to which you want to associate the SSL/TLS\n certificate.

", "smithy.api#required": {} } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your SSL/TLS certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificateResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

\n

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachStaticIp": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#AttachStaticIpRequest" }, "output": { "target": "com.amazonaws.lightsail#AttachStaticIpResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Attaches a static IP address to a specific Amazon Lightsail instance.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachStaticIp", "code": 200 } } }, "com.amazonaws.lightsail#AttachStaticIpRequest": { "type": "structure", "members": { "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The instance name to which you want to attach the static IP address.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#AttachStaticIpResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachedDisk": { "type": "structure", "members": { "path": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path of the disk (/dev/xvdf).

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB.

" } } }, "traits": { "smithy.api#documentation": "

Describes a block storage disk that is attached to an instance, and is included in an\n automatic snapshot.

" } }, "com.amazonaws.lightsail#AttachedDiskList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AttachedDisk" } }, "com.amazonaws.lightsail#AttachedDiskMap": { "type": "map", "key": { "target": "com.amazonaws.lightsail#ResourceName" }, "value": { "target": "com.amazonaws.lightsail#DiskMapList" } }, "com.amazonaws.lightsail#AutoMountStatus": { "type": "enum", "members": { "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "Mounted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Mounted" } }, "NotMounted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotMounted" } } } }, "com.amazonaws.lightsail#AutoSnapshotAddOnRequest": { "type": "structure", "members": { "snapshotTimeOfDay": { "target": "com.amazonaws.lightsail#TimeOfDay", "traits": { "smithy.api#documentation": "

The daily time when an automatic snapshot will be created.

\n

Constraints:

\n " } } }, "traits": { "smithy.api#documentation": "

Describes a request to enable or modify the automatic snapshot add-on for an\n Amazon Lightsail instance or disk.

\n

When you modify the automatic snapshot time for a resource, it is typically effective\n immediately except under the following conditions:

\n " } }, "com.amazonaws.lightsail#AutoSnapshotDate": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, "com.amazonaws.lightsail#AutoSnapshotDetails": { "type": "structure", "members": { "date": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The date of the automatic snapshot in YYYY-MM-DD format.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the automatic snapshot was created.

" } }, "status": { "target": "com.amazonaws.lightsail#AutoSnapshotStatus", "traits": { "smithy.api#documentation": "

The status of the automatic snapshot.

" } }, "fromAttachedDisks": { "target": "com.amazonaws.lightsail#AttachedDiskList", "traits": { "smithy.api#documentation": "

An array of objects that describe the block storage disks attached to the instance when\n the automatic snapshot was created.

" } } }, "traits": { "smithy.api#documentation": "

Describes an automatic snapshot.

" } }, "com.amazonaws.lightsail#AutoSnapshotDetailsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AutoSnapshotDetails" } }, "com.amazonaws.lightsail#AutoSnapshotStatus": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Success" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotFound" } } } }, "com.amazonaws.lightsail#AvailabilityZone": { "type": "structure", "members": { "zoneName": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the Availability Zone. The format is us-east-2a\n (case-sensitive).

" } }, "state": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The state of the Availability Zone.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Availability Zone. This is returned only as part of a GetRegions\n request.

" } }, "com.amazonaws.lightsail#AvailabilityZoneList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AvailabilityZone" } }, "com.amazonaws.lightsail#BPAStatusMessage": { "type": "enum", "members": { "DEFAULTED_FOR_SLR_MISSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING" } }, "SYNC_ON_HOLD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SYNC_ON_HOLD" } }, "DEFAULTED_FOR_SLR_MISSING_ON_HOLD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unknown" } } } }, "com.amazonaws.lightsail#Base64": { "type": "string" }, "com.amazonaws.lightsail#BehaviorEnum": { "type": "enum", "members": { "DontCacheSetting": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dont-cache" } }, "CacheSetting": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cache" } } } }, "com.amazonaws.lightsail#Blueprint": { "type": "structure", "members": { "blueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID for the virtual private server image (app_wordpress_x_x or\n app_lamp_x_x).

" } }, "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The friendly name of the blueprint (Amazon Linux).

" } }, "group": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The group name of the blueprint (amazon-linux).

" } }, "type": { "target": "com.amazonaws.lightsail#BlueprintType", "traits": { "smithy.api#documentation": "

The type of the blueprint (os or app).

" } }, "description": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The description of the blueprint.

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed\n to support customers with existing instances but are not necessarily available for launch of\n new instances. Blueprints are marked inactive when they become outdated due to operating\n system updates or new application releases.

" } }, "minPower": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The minimum bundle power required to run this blueprint. For example, you need a bundle\n with a power value of 500 or more to create an instance that uses a blueprint with a minimum\n power value of 500. 0 indicates that the blueprint runs on all instance sizes.\n

" } }, "version": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The version number of the operating system, application, or stack (\n 2016.03.0).

" } }, "versionCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The version code.

" } }, "productUrl": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The product URL to learn more about the image or blueprint.

" } }, "licenseUrl": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The end-user license agreement URL for the image or blueprint.

" } }, "platform": { "target": "com.amazonaws.lightsail#InstancePlatform", "traits": { "smithy.api#documentation": "

The operating system platform (either Linux/Unix-based or Windows Server-based) of the\n blueprint.

" } }, "appCategory": { "target": "com.amazonaws.lightsail#AppCategory", "traits": { "smithy.api#documentation": "

Virtual computer blueprints that are supported by Lightsail for Research.

\n \n

This parameter only applies to Lightsail for Research resources.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes a blueprint (a virtual private server image).

" } }, "com.amazonaws.lightsail#BlueprintList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Blueprint" } }, "com.amazonaws.lightsail#BlueprintType": { "type": "enum", "members": { "os": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "os" } }, "app": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "app" } } } }, "com.amazonaws.lightsail#Bucket": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Lightsail resource type of the bucket.

" } }, "accessRules": { "target": "com.amazonaws.lightsail#AccessRules", "traits": { "smithy.api#documentation": "

An object that describes the access rules of the bucket.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the bucket.

" } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the bundle currently applied to the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to change the\n bundle of a bucket.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the distribution was created.

" } }, "url": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The URL of the bucket.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" } }, "name": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The support code for a bucket. Include this code in your email to support when you have\n questions about a Lightsail bucket. This code enables our support team to look up your\n Lightsail information more easily.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the bucket. For more information, see Tags in\n Amazon Lightsail in the Amazon Lightsail Developer Guide.

" } }, "objectVersioning": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Indicates whether object versioning is enabled for the bucket.

\n

The following options can be configured:

\n " } }, "ableToUpdateBundle": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" } }, "readonlyAccessAccounts": { "target": "com.amazonaws.lightsail#PartnerIdList", "traits": { "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" } }, "resourcesReceivingAccess": { "target": "com.amazonaws.lightsail#AccessReceiverList", "traits": { "smithy.api#documentation": "

An array of objects that describe Lightsail instances that have access to the\n bucket.

\n

Use the SetResourceAccessForBucket\n action to update the instances that have access to a bucket.

" } }, "state": { "target": "com.amazonaws.lightsail#BucketState", "traits": { "smithy.api#documentation": "

An object that describes the state of the bucket.

" } }, "accessLogConfig": { "target": "com.amazonaws.lightsail#BucketAccessLogConfig", "traits": { "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" } }, "cors": { "target": "com.amazonaws.lightsail#BucketCorsConfig", "traits": { "smithy.api#documentation": "

An array of cross-origin resource sharing (CORS) rules that identify origins and the HTTP methods that can be executed on your bucket. This field is only included in the response when CORS configuration is requested or when updating CORS configuration. For more information, see Configuring cross-origin resource sharing (CORS).

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Lightsail bucket.

" } }, "com.amazonaws.lightsail#BucketAccessLogConfig": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether bucket access logging is enabled for the\n bucket.

", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n
" } }, "prefix": { "target": "com.amazonaws.lightsail#BucketAccessLogPrefix", "traits": { "smithy.api#documentation": "

The optional object prefix for the bucket access log.

\n

The prefix is an optional addition to the object key that organizes your access log files\n in the destination bucket. For example, if you specify a logs/ prefix, then each\n log object will begin with the logs/ prefix in its key (for example,\n logs/2021-11-01-21-32-16-E568B2907131C0C0).

\n \n

This parameter can be optionally specified when enabling the access log for a bucket,\n and should be omitted when disabling the access log.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes the access log configuration for a bucket in the Amazon Lightsail object storage\n service.

\n

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#BucketAccessLogPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[\\w/!.*')(-]+$" } }, "com.amazonaws.lightsail#BucketBundle": { "type": "structure", "members": { "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the bundle.

" } }, "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the bundle.

" } }, "price": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The monthly price of the bundle, in US dollars.

" } }, "storagePerMonthInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The storage size of the bundle, in GB.

" } }, "transferPerMonthInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the bundle is active. Use for a new or existing bucket.

" } } }, "traits": { "smithy.api#documentation": "

Describes the specifications of a bundle that can be applied to an Amazon Lightsail\n bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

" } }, "com.amazonaws.lightsail#BucketBundleList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#BucketBundle" } }, "com.amazonaws.lightsail#BucketCorsAllowedHeaders": { "type": "list", "member": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#BucketCorsAllowedMethod": { "type": "string", "traits": { "smithy.api#pattern": "^(DELETE|GET|HEAD|POST|PUT)$" } }, "com.amazonaws.lightsail#BucketCorsAllowedMethods": { "type": "list", "member": { "target": "com.amazonaws.lightsail#BucketCorsAllowedMethod" } }, "com.amazonaws.lightsail#BucketCorsAllowedOrigins": { "type": "list", "member": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#BucketCorsConfig": { "type": "structure", "members": { "rules": { "target": "com.amazonaws.lightsail#BucketCorsRules", "traits": { "smithy.api#documentation": "

A set of origins and methods (cross-origin access that you want to allow). You can add up to 20 rules to the configuration. The total size is limited to 64 KB.

" } } }, "traits": { "smithy.api#documentation": "

Describes the cross-origin resource sharing (CORS) configuration for a Lightsail bucket. CORS defines a way for client web applications that are loaded in one domain to interact with resources in a different domain.\n For more information, see Configuring cross-origin resource sharing (CORS).

" } }, "com.amazonaws.lightsail#BucketCorsExposeHeaders": { "type": "list", "member": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#BucketCorsRule": { "type": "structure", "members": { "id": { "target": "com.amazonaws.lightsail#BucketCorsRuleId", "traits": { "smithy.api#documentation": "

A unique identifier for the CORS rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.

" } }, "allowedMethods": { "target": "com.amazonaws.lightsail#BucketCorsAllowedMethods", "traits": { "smithy.api#documentation": "

The HTTP methods that are allowed when accessing the bucket from the specified origin. Each CORS rule must identify at least one origin and one method.

\n

You can use the following HTTP methods:

\n ", "smithy.api#required": {} } }, "allowedOrigins": { "target": "com.amazonaws.lightsail#BucketCorsAllowedOrigins", "traits": { "smithy.api#documentation": "

One or more origins you want customers to be able to access the bucket from. Each CORS rule must identify at least one origin and one method.

", "smithy.api#required": {} } }, "allowedHeaders": { "target": "com.amazonaws.lightsail#BucketCorsAllowedHeaders", "traits": { "smithy.api#documentation": "

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

" } }, "exposeHeaders": { "target": "com.amazonaws.lightsail#BucketCorsExposeHeaders", "traits": { "smithy.api#documentation": "

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

" } }, "maxAgeSeconds": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The time in seconds that your browser is to cache the preflight response for the specified resource. A CORS rule can have only one maxAgeSeconds element.

" } } }, "traits": { "smithy.api#documentation": "

Describes a cross-origin resource sharing (CORS) rule for a Lightsail bucket. CORS rules specify which origins are allowed to access the bucket, which HTTP methods are allowed, and other access control information. For more information, see Configuring cross-origin resource sharing (CORS).

" } }, "com.amazonaws.lightsail#BucketCorsRuleId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.lightsail#BucketCorsRules": { "type": "list", "member": { "target": "com.amazonaws.lightsail#BucketCorsRule" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.lightsail#BucketList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Bucket" } }, "com.amazonaws.lightsail#BucketMetricName": { "type": "enum", "members": { "BucketSizeBytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BucketSizeBytes" } }, "NumberOfObjects": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NumberOfObjects" } } } }, "com.amazonaws.lightsail#BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 54 }, "smithy.api#pattern": "^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$" } }, "com.amazonaws.lightsail#BucketState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The state code of the bucket.

\n

The following codes are possible:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A message that describes the state of the bucket.

" } } }, "traits": { "smithy.api#documentation": "

Describes the state of an Amazon Lightsail bucket.

" } }, "com.amazonaws.lightsail#Bundle": { "type": "structure", "members": { "price": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The price in US dollars (5.0) of the bundle.

" } }, "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of vCPUs included in the bundle (2).

" } }, "diskSizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the SSD (30).

" } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle ID (micro_x_x).

" } }, "instanceType": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The instance type (micro).

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the bundle is active.

" } }, "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A friendly name for the bundle (Micro).

" } }, "power": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

A numeric value that represents the power of the bundle (500). You can use\n the bundle's power value in conjunction with a blueprint's minimum power value to determine\n whether the blueprint will run on the bundle. For example, you need a bundle with a power\n value of 500 or more to create an instance that uses a blueprint with a minimum power value of\n 500.

" } }, "ramSizeInGb": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The amount of RAM in GB (2.0).

" } }, "transferPerMonthInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The data transfer rate per month in GB (2000).

" } }, "supportedPlatforms": { "target": "com.amazonaws.lightsail#InstancePlatformList", "traits": { "smithy.api#documentation": "

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle\n supports. You can only launch a WINDOWS bundle on a blueprint that supports the\n WINDOWS platform. LINUX_UNIX blueprints require a\n LINUX_UNIX bundle.

" } }, "supportedAppCategories": { "target": "com.amazonaws.lightsail#AppCategoryList", "traits": { "smithy.api#documentation": "

Virtual computer blueprints that are supported by a Lightsail for Research bundle.

\n \n

This parameter only applies to Lightsail for Research resources.

\n
" } }, "publicIpv4AddressCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

An integer that indicates the public ipv4 address count included in the bundle, the value\n is either 0 or 1.

" } } }, "traits": { "smithy.api#documentation": "

Describes a bundle, which is a set of specs describing your virtual private server (or\n instance).

" } }, "com.amazonaws.lightsail#BundleList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Bundle" } }, "com.amazonaws.lightsail#CacheBehavior": { "type": "structure", "members": { "behavior": { "target": "com.amazonaws.lightsail#BehaviorEnum", "traits": { "smithy.api#documentation": "

The cache behavior of the distribution.

\n

The following cache behaviors can be specified:

\n " } } }, "traits": { "smithy.api#documentation": "

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

" } }, "com.amazonaws.lightsail#CacheBehaviorList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CacheBehaviorPerPath" } }, "com.amazonaws.lightsail#CacheBehaviorPerPath": { "type": "structure", "members": { "path": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify\n wildcard directories (path/to/assets/*), and file types (*.html, *jpg,\n *js). Directories and file paths are case-sensitive.

\n

Examples:

\n " } }, "behavior": { "target": "com.amazonaws.lightsail#BehaviorEnum", "traits": { "smithy.api#documentation": "

The cache behavior for the specified path.

\n

You can specify one of the following per-path cache behaviors:

\n " } } }, "traits": { "smithy.api#documentation": "

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A per-path cache behavior is used to override, or add an exception to, the default cache\n behavior of a distribution. For example, if the cacheBehavior is set to\n cache, then a per-path cache behavior can be used to specify a directory, file,\n or file type that your distribution will cache. Alternately, if the distribution's\n cacheBehavior is dont-cache, then a per-path cache behavior can be\n used to specify a directory, file, or file type that your distribution will not cache.

" } }, "com.amazonaws.lightsail#CacheSettings": { "type": "structure", "members": { "defaultTTL": { "target": "com.amazonaws.lightsail#long", "traits": { "smithy.api#documentation": "

The default amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the content has been\n updated.

\n \n

The value specified applies only when the origin does not add HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

\n
" } }, "minimumTTL": { "target": "com.amazonaws.lightsail#long", "traits": { "smithy.api#documentation": "

The minimum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

A value of 0 must be specified for minimumTTL if the\n distribution is configured to forward all headers to the origin.

" } }, "maximumTTL": { "target": "com.amazonaws.lightsail#long", "traits": { "smithy.api#documentation": "

The maximum amount of time that objects stay in the distribution's cache before the\n distribution forwards another request to the origin to determine whether the object has been\n updated.

\n

The value specified applies only when the origin adds HTTP headers such as\n Cache-Control max-age, Cache-Control s-maxage, and\n Expires to objects.

" } }, "allowedHTTPMethods": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The HTTP methods that are processed and forwarded to the distribution's origin.

\n

You can specify the following options:

\n \n

If you specify the third option, you might need to restrict access to your distribution's\n origin so users can't perform operations that you don't want them to. For example, you might\n not want users to have permission to delete objects from your origin.

" } }, "cachedHTTPMethods": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The HTTP method responses that are cached by your distribution.

\n

You can specify the following options:

\n " } }, "forwardedCookies": { "target": "com.amazonaws.lightsail#CookieObject", "traits": { "smithy.api#documentation": "

An object that describes the cookies that are forwarded to the origin. Your content is\n cached based on the cookies that are forwarded.

" } }, "forwardedHeaders": { "target": "com.amazonaws.lightsail#HeaderObject", "traits": { "smithy.api#documentation": "

An object that describes the headers that are forwarded to the origin. Your content is\n cached based on the headers that are forwarded.

" } }, "forwardedQueryStrings": { "target": "com.amazonaws.lightsail#QueryStringObject", "traits": { "smithy.api#documentation": "

An object that describes the query strings that are forwarded to the origin. Your content\n is cached based on the query strings that are forwarded.

" } } }, "traits": { "smithy.api#documentation": "

Describes the cache settings of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

These settings apply only to your distribution's cacheBehaviors (including\n the defaultCacheBehavior) that have a behavior of\n cache.

" } }, "com.amazonaws.lightsail#Certificate": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, "name": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { "smithy.api#documentation": "

The name of the certificate (my-certificate).

" } }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name of the certificate.

" } }, "status": { "target": "com.amazonaws.lightsail#CertificateStatus", "traits": { "smithy.api#documentation": "

The validation status of the certificate.

" } }, "serialNumber": { "target": "com.amazonaws.lightsail#SerialNumber", "traits": { "smithy.api#documentation": "

The serial number of the certificate.

" } }, "subjectAlternativeNames": { "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", "traits": { "smithy.api#documentation": "

An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) of the certificate.

" } }, "domainValidationRecords": { "target": "com.amazonaws.lightsail#DomainValidationRecordList", "traits": { "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" } }, "requestFailureReason": { "target": "com.amazonaws.lightsail#RequestFailureReason", "traits": { "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " } }, "inUseResourceCount": { "target": "com.amazonaws.lightsail#InUseResourceCount", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of Lightsail resources that the certificate is attached to.

" } }, "keyAlgorithm": { "target": "com.amazonaws.lightsail#KeyAlgorithm", "traits": { "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key) of the\n certificate.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate was created.

" } }, "issuedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate was issued.

" } }, "issuerCA": { "target": "com.amazonaws.lightsail#IssuerCA", "traits": { "smithy.api#documentation": "

The certificate authority that issued the certificate.

" } }, "notBefore": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate is first valid.

" } }, "notAfter": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate expires.

" } }, "eligibleToRenew": { "target": "com.amazonaws.lightsail#EligibleToRenew", "traits": { "smithy.api#documentation": "

The renewal eligibility of the certificate.

" } }, "renewalSummary": { "target": "com.amazonaws.lightsail#RenewalSummary", "traits": { "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" } }, "revokedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" } }, "revocationReason": { "target": "com.amazonaws.lightsail#RevocationReason", "traits": { "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail certificate. This code enables our support team to look up your Lightsail\n information more easily.

" } } }, "traits": { "smithy.api#documentation": "

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

\n \n

To get a summary of a certificate, use the GetCertificates action and omit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

\n
" } }, "com.amazonaws.lightsail#CertificateDomainValidationStatus": { "type": "enum", "members": { "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VALIDATION" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } } } }, "com.amazonaws.lightsail#CertificateName": { "type": "string" }, "com.amazonaws.lightsail#CertificateProvider": { "type": "enum", "members": { "LetsEncrypt": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LetsEncrypt" } } } }, "com.amazonaws.lightsail#CertificateStatus": { "type": "enum", "members": { "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VALIDATION" } }, "Issued": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISSUED" } }, "Inactive": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "Expired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "ValidationTimedOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_TIMED_OUT" } }, "Revoked": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKED" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.lightsail#CertificateStatusList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CertificateStatus" } }, "com.amazonaws.lightsail#CertificateSummary": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { "smithy.api#documentation": "

The name of the certificate.

" } }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name of the certificate.

" } }, "certificateDetail": { "target": "com.amazonaws.lightsail#Certificate", "traits": { "smithy.api#documentation": "

An object that describes a certificate in detail.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Lightsail SSL/TLS certificate.

" } }, "com.amazonaws.lightsail#CertificateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CertificateSummary" } }, "com.amazonaws.lightsail#CloseInstancePublicPorts": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CloseInstancePublicPortsRequest" }, "output": { "target": "com.amazonaws.lightsail#CloseInstancePublicPortsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Closes ports for a specific Amazon Lightsail instance.

\n

The CloseInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CloseInstancePublicPorts", "code": 200 } } }, "com.amazonaws.lightsail#CloseInstancePublicPortsRequest": { "type": "structure", "members": { "portInfo": { "target": "com.amazonaws.lightsail#PortInfo", "traits": { "smithy.api#documentation": "

An object to describe the ports to close for the specified instance.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which to close ports.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CloseInstancePublicPortsResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CloudFormationStackRecord": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the CloudFormation stack record. It starts with\n CloudFormationStackRecord followed by a GUID.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudFormation stack record.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the CloudFormation stack record was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (CloudFormationStackRecord).

" } }, "state": { "target": "com.amazonaws.lightsail#RecordState", "traits": { "smithy.api#documentation": "

The current state of the CloudFormation stack record.

" } }, "sourceInfo": { "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList", "traits": { "smithy.api#documentation": "

A list of objects describing the source of the CloudFormation stack record.

" } }, "destinationInfo": { "target": "com.amazonaws.lightsail#DestinationInfo", "traits": { "smithy.api#documentation": "

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon\n Resource Name (ARN) of the AWS CloudFormation stack.

" } } }, "traits": { "smithy.api#documentation": "

Describes a CloudFormation stack record created as a result of the create cloud\n formation stack action.

\n

A CloudFormation stack record provides information about the AWS CloudFormation stack used to\n create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" } }, "com.amazonaws.lightsail#CloudFormationStackRecordList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CloudFormationStackRecord" } }, "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (ExportSnapshotRecord).

" } }, "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the record.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" } } }, "traits": { "smithy.api#documentation": "

Describes the source of a CloudFormation stack record (i.e., the export snapshot\n record).

" } }, "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfoList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CloudFormationStackRecordSourceInfo" } }, "com.amazonaws.lightsail#CloudFormationStackRecordSourceType": { "type": "enum", "members": { "ExportSnapshotRecord": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ExportSnapshotRecord" } } } }, "com.amazonaws.lightsail#ComparisonOperator": { "type": "enum", "members": { "GreaterThanOrEqualToThreshold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" } }, "GreaterThanThreshold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GreaterThanThreshold" } }, "LessThanThreshold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LessThanThreshold" } }, "LessThanOrEqualToThreshold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LessThanOrEqualToThreshold" } } } }, "com.amazonaws.lightsail#ContactMethod": { "type": "structure", "members": { "contactEndpoint": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

" } }, "status": { "target": "com.amazonaws.lightsail#ContactMethodStatus", "traits": { "smithy.api#documentation": "

The current status of the contact method.

\n

A contact method has the following possible status:

\n " } }, "protocol": { "target": "com.amazonaws.lightsail#ContactProtocol", "traits": { "smithy.api#documentation": "

The protocol of the contact method, such as email or SMS (text messaging).

" } }, "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the contact method.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact method.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the contact method was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type of the contact method.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail contact method. This code enables our support team to look up your\n Lightsail information more easily.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#documentation": "

Describes a contact method.

\n

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

" } }, "com.amazonaws.lightsail#ContactMethodStatus": { "type": "enum", "members": { "PendingVerification": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingVerification" } }, "Valid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Valid" } }, "Invalid": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Invalid" } } } }, "com.amazonaws.lightsail#ContactMethodVerificationProtocol": { "type": "enum", "members": { "Email": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Email" } } } }, "com.amazonaws.lightsail#ContactMethodsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContactMethod" } }, "com.amazonaws.lightsail#ContactProtocol": { "type": "enum", "members": { "Email": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Email" } }, "SMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS" } } } }, "com.amazonaws.lightsail#ContactProtocolsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContactProtocol" } }, "com.amazonaws.lightsail#Container": { "type": "structure", "members": { "image": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the image used for the container.

\n

Container images sourced from your Lightsail container service, that are registered and\n stored on your service, start with a colon (:). For example, if your container\n service name is container-service-1, the container image label is\n mystaticsite, and you want to use the third (3) version of the\n registered container image, then you should specify\n :container-service-1.mystaticsite.3. To use the latest version of a container\n image, specify latest instead of a version number (for example,\n :container-service-1.mystaticsite.latest). Lightsail will automatically use\n the highest numbered version of the registered container image.

\n

Container images sourced from a public registry like Docker Hub don't start with a colon.\n For example, nginx:latest or nginx.

" } }, "command": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The launch command for the container.

" } }, "environment": { "target": "com.amazonaws.lightsail#Environment", "traits": { "smithy.api#documentation": "

The environment variables of the container.

" } }, "ports": { "target": "com.amazonaws.lightsail#PortMap", "traits": { "smithy.api#documentation": "

The open firewall ports of the container.

" } } }, "traits": { "smithy.api#documentation": "

Describes the settings of a container that will be launched, or that is launched, to an\n Amazon Lightsail container service.

" } }, "com.amazonaws.lightsail#ContainerImage": { "type": "structure", "members": { "image": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the container image.

" } }, "digest": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The digest of the container image.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the container image was created.

" } } }, "traits": { "smithy.api#documentation": "

Describes a container image that is registered to an Amazon Lightsail container\n service.

" } }, "com.amazonaws.lightsail#ContainerImageList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerImage" } }, "com.amazonaws.lightsail#ContainerLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 53 }, "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" } }, "com.amazonaws.lightsail#ContainerMap": { "type": "map", "key": { "target": "com.amazonaws.lightsail#ContainerName" }, "value": { "target": "com.amazonaws.lightsail#Container" } }, "com.amazonaws.lightsail#ContainerName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 53 }, "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" } }, "com.amazonaws.lightsail#ContainerService": { "type": "structure", "members": { "containerServiceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container service.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the container service was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type of the container service.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "power": { "target": "com.amazonaws.lightsail#ContainerServicePowerName", "traits": { "smithy.api#documentation": "

The power specification of the container service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" } }, "powerId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID of the power of the container service.

" } }, "state": { "target": "com.amazonaws.lightsail#ContainerServiceState", "traits": { "smithy.api#documentation": "

The current state of the container service.

\n

The following container service states are possible:

\n " } }, "stateDetail": { "target": "com.amazonaws.lightsail#ContainerServiceStateDetail", "traits": { "smithy.api#documentation": "

An object that describes the current state of the container service.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n
" } }, "scale": { "target": "com.amazonaws.lightsail#ContainerServiceScale", "traits": { "smithy.api#documentation": "

The scale specification of the container service.

\n

The scale specifies the allocated compute nodes of the container service.

" } }, "currentDeployment": { "target": "com.amazonaws.lightsail#ContainerServiceDeployment", "traits": { "smithy.api#documentation": "

An object that describes the current container deployment of the container service.

" } }, "nextDeployment": { "target": "com.amazonaws.lightsail#ContainerServiceDeployment", "traits": { "smithy.api#documentation": "

An object that describes the next deployment of the container service.

\n

This value is null when there is no deployment in a pending\n state.

" } }, "isDisabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the container service is disabled.

" } }, "principalArn": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The principal ARN of the container service.

\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" } }, "privateDomainName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The private domain name of the container service.

\n

The private domain name is accessible only by other resources within the default virtual\n private cloud (VPC) of your Lightsail account.

" } }, "publicDomainNames": { "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", "traits": { "smithy.api#documentation": "

The public domain name of the container service, such as example.com and\n www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n
\n

See CreateContainerService or UpdateContainerService for\n information about how to specify public domain names for your Lightsail container\n service.

" } }, "url": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The publicly accessible URL of the container service.

\n

If no public endpoint is specified in the currentDeployment, this URL returns\n a 404 response.

" } }, "privateRegistryAccess": { "target": "com.amazonaws.lightsail#PrivateRegistryAccess", "traits": { "smithy.api#documentation": "

An object that describes the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Lightsail container service.

" } }, "com.amazonaws.lightsail#ContainerServiceDeployment": { "type": "structure", "members": { "version": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The version number of the deployment.

" } }, "state": { "target": "com.amazonaws.lightsail#ContainerServiceDeploymentState", "traits": { "smithy.api#documentation": "

The state of the deployment.

\n

A deployment can be in one of the following states:

\n " } }, "containers": { "target": "com.amazonaws.lightsail#ContainerMap", "traits": { "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" } }, "publicEndpoint": { "target": "com.amazonaws.lightsail#ContainerServiceEndpoint", "traits": { "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the deployment was created.

" } } }, "traits": { "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" } }, "com.amazonaws.lightsail#ContainerServiceDeploymentList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerServiceDeployment" } }, "com.amazonaws.lightsail#ContainerServiceDeploymentRequest": { "type": "structure", "members": { "containers": { "target": "com.amazonaws.lightsail#ContainerMap", "traits": { "smithy.api#documentation": "

An object that describes the configuration for the containers of the deployment.

" } }, "publicEndpoint": { "target": "com.amazonaws.lightsail#EndpointRequest", "traits": { "smithy.api#documentation": "

An object that describes the endpoint of the deployment.

" } } }, "traits": { "smithy.api#documentation": "

Describes a container deployment configuration of an Amazon Lightsail container\n service.

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

" } }, "com.amazonaws.lightsail#ContainerServiceDeploymentState": { "type": "enum", "members": { "ACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole": { "type": "structure", "members": { "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether the role is activated.

" } }, "principalArn": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role, if it is activated.

" } } }, "traits": { "smithy.api#documentation": "

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR)\n private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest": { "type": "structure", "members": { "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to activate the role.

" } } }, "traits": { "smithy.api#documentation": "

Describes a request to activate or deactivate the role that you can use to grant an\n Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

When activated, Lightsail creates an Identity and Access Management (IAM) role\n for the specified Lightsail container service. You can use the ARN of the role to create a\n trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container\n service to pull images from Amazon ECR private repositories. For more information, see\n Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#ContainerServiceEndpoint": { "type": "structure", "members": { "containerName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the container entry of the deployment that the endpoint configuration applies\n to.

" } }, "containerPort": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The port of the specified container to which traffic is forwarded to.

" } }, "healthCheck": { "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", "traits": { "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" } } }, "traits": { "smithy.api#documentation": "

Describes the public endpoint configuration of a deployment of an Amazon Lightsail\n container service.

" } }, "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig": { "type": "structure", "members": { "healthyThreshold": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of consecutive health checks successes required before moving the container to\n the Healthy state. The default value is 2.

" } }, "unhealthyThreshold": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of consecutive health check failures required before moving the container to\n the Unhealthy state. The default value is 2.

" } }, "timeoutSeconds": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, during which no response means a failed health check. You\n can specify between 2 and 60 seconds. The default value is 2.

" } }, "intervalSeconds": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The approximate interval, in seconds, between health checks of an individual container.\n You can specify between 5 and 300 seconds. The default value is 5.

" } }, "path": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path on the container on which to perform the health check. The default value is\n /.

" } }, "successCodes": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The HTTP codes to use when checking for a successful response from a container. You can\n specify values between 200 and 499. You can specify multiple values\n (for example, 200,202) or a range of values (for example,\n 200-299).

" } } }, "traits": { "smithy.api#documentation": "

Describes the health check configuration of an Amazon Lightsail container service.

" } }, "com.amazonaws.lightsail#ContainerServiceList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerService" } }, "com.amazonaws.lightsail#ContainerServiceLogEvent": { "type": "structure", "members": { "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the container service log event was created.

" } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message of the container service log event.

" } } }, "traits": { "smithy.api#documentation": "

Describes the log events of a container of an Amazon Lightsail container service.

" } }, "com.amazonaws.lightsail#ContainerServiceLogEventList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerServiceLogEvent" } }, "com.amazonaws.lightsail#ContainerServiceMetadataEntry": { "type": "map", "key": { "target": "com.amazonaws.lightsail#string" }, "value": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#ContainerServiceMetadataEntryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntry" } }, "com.amazonaws.lightsail#ContainerServiceMetricName": { "type": "enum", "members": { "CPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CPUUtilization" } }, "MemoryUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MemoryUtilization" } } } }, "com.amazonaws.lightsail#ContainerServiceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$" } }, "com.amazonaws.lightsail#ContainerServicePower": { "type": "structure", "members": { "powerId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID of the power (nano-1).

" } }, "price": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The monthly price of the power in USD.

" } }, "cpuCount": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The number of vCPUs included in the power.

" } }, "ramSizeInGb": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The amount of RAM (in GB) of the power.

" } }, "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The friendly name of the power (nano).

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the power is active and can be specified for container\n services.

" } } }, "traits": { "smithy.api#documentation": "

Describes the powers that can be specified for an Amazon Lightsail container\n service.

\n

The power specifies the amount of RAM, the number of vCPUs, and the base price of the\n container service.

" } }, "com.amazonaws.lightsail#ContainerServicePowerList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ContainerServicePower" } }, "com.amazonaws.lightsail#ContainerServicePowerName": { "type": "enum", "members": { "nano": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "nano" } }, "micro": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "micro" } }, "small": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "small" } }, "medium": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "medium" } }, "large": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "large" } }, "xlarge": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "xlarge" } } } }, "com.amazonaws.lightsail#ContainerServiceProtocol": { "type": "enum", "members": { "HTTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP" } }, "HTTPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPS" } }, "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TCP" } }, "UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UDP" } } } }, "com.amazonaws.lightsail#ContainerServicePublicDomains": { "type": "map", "key": { "target": "com.amazonaws.lightsail#string" }, "value": { "target": "com.amazonaws.lightsail#ContainerServicePublicDomainsList" } }, "com.amazonaws.lightsail#ContainerServicePublicDomainsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#ContainerServiceRegistryLogin": { "type": "structure", "members": { "username": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The container service registry username to use to push container images to the container\n image registry of a Lightsail account.

" } }, "password": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The container service registry password to use to push container images to the container\n image registry of a Lightsail account

" } }, "expiresAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp of when the container image registry sign-in credentials expire.

\n

The log in credentials expire 12 hours after they are created, at which point you will\n need to create a new set of log in credentials using the\n CreateContainerServiceRegistryLogin action.

" } }, "registry": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The address to use to push container images to the container image registry of a\n Lightsail account.

" } } }, "traits": { "smithy.api#documentation": "

Describes the sign-in credentials for the container image registry of an Amazon Lightsail\n account.

" } }, "com.amazonaws.lightsail#ContainerServiceScale": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20 } } }, "com.amazonaws.lightsail#ContainerServiceState": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "READY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READY" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DEPLOYING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYING" } } } }, "com.amazonaws.lightsail#ContainerServiceStateDetail": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#ContainerServiceStateDetailCode", "traits": { "smithy.api#documentation": "

The state code of the container service.

\n

The following state codes are possible:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A message that provides more information for the state code.

\n \n

The state detail is populated only when a container service is in a\n PENDING, DEPLOYING, or UPDATING state.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes the current state of a container service.

" } }, "com.amazonaws.lightsail#ContainerServiceStateDetailCode": { "type": "enum", "members": { "CREATING_SYSTEM_RESOURCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING_SYSTEM_RESOURCES" } }, "CREATING_NETWORK_INFRASTRUCTURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING_NETWORK_INFRASTRUCTURE" } }, "PROVISIONING_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING_CERTIFICATE" } }, "PROVISIONING_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONING_SERVICE" } }, "CREATING_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING_DEPLOYMENT" } }, "EVALUATING_HEALTH_CHECK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVALUATING_HEALTH_CHECK" } }, "ACTIVATING_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING_DEPLOYMENT" } }, "CERTIFICATE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CERTIFICATE_LIMIT_EXCEEDED" } }, "UNKNOWN_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_ERROR" } } } }, "com.amazonaws.lightsail#ContainerServicesListResult": { "type": "structure", "members": { "containerServices": { "target": "com.amazonaws.lightsail#ContainerServiceList", "traits": { "smithy.api#documentation": "

An array of objects that describe one or more container services.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CookieObject": { "type": "structure", "members": { "option": { "target": "com.amazonaws.lightsail#ForwardValues", "traits": { "smithy.api#documentation": "

Specifies which cookies to forward to the distribution's origin for a cache behavior:\n all, none, or allow-list to forward only the cookies\n specified in the cookiesAllowList parameter.

" } }, "cookiesAllowList": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The specific cookies to forward to your distribution's origin.

" } } }, "traits": { "smithy.api#documentation": "

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards\n cookies to the origin and, if so, which ones.

\n

For the cookies that you specify, your distribution caches separate versions of the\n specified content based on the cookie values in viewer\n requests.

" } }, "com.amazonaws.lightsail#CopySnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CopySnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CopySnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CopySnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CopySnapshotRequest": { "type": "structure", "members": { "sourceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source manual snapshot to copy.

\n

Constraint:

\n " } }, "sourceResourceName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the source instance or disk from which the source automatic snapshot was\n created.

\n

Constraint:

\n " } }, "restoreDate": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The date of the source automatic snapshot to copy. Use the get auto snapshots\n operation to identify the dates of the available automatic snapshots.

\n

Constraints:

\n " } }, "useLatestRestorableAutoSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot of the\n specified source instance or disk.

\n

Constraints:

\n " } }, "targetSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the new manual snapshot to be created as a copy.

", "smithy.api#required": {} } }, "sourceRegion": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CopySnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CostEstimate": { "type": "structure", "members": { "usageType": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The types of usage that are included in the estimate, such as costs, usage, or data\n transfer.

" } }, "resultsByTime": { "target": "com.amazonaws.lightsail#EstimatesByTime", "traits": { "smithy.api#documentation": "

The cost estimate result that's associated with a time period.

" } } }, "traits": { "smithy.api#documentation": "

Describes the estimated cost for resources in your Lightsail for Research account.

" } }, "com.amazonaws.lightsail#CostEstimates": { "type": "list", "member": { "target": "com.amazonaws.lightsail#CostEstimate" } }, "com.amazonaws.lightsail#CreateBucket": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateBucketRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateBucketResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Lightsail bucket.

\n

A bucket is a cloud storage resource available in the Lightsail object storage service.\n Use buckets to store objects such as data and its descriptive metadata. For more information\n about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateBucket", "code": 200 } } }, "com.amazonaws.lightsail#CreateBucketAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateBucketAccessKeyRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateBucketAccessKeyResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of\n an access key ID and corresponding secret access key.

\n

Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more\n information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateBucketAccessKey", "code": 200 } } }, "com.amazonaws.lightsail#CreateBucketAccessKeyRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket that the new access key will belong to, and grant access to.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateBucketAccessKeyResult": { "type": "structure", "members": { "accessKey": { "target": "com.amazonaws.lightsail#AccessKey", "traits": { "smithy.api#documentation": "

An object that describes the access key that is created.

" } }, "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateBucketRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name for the bucket.

\n

For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", "smithy.api#required": {} } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the bundle to use for the bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

\n

Use the UpdateBucketBundle action to change the\n bundle after the bucket is created.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the bucket during creation.

\n

Use the TagResource action to tag the bucket after it's\n created.

" } }, "enableObjectVersioning": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateBucketResult": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.lightsail#Bucket", "traits": { "smithy.api#documentation": "

An object that describes the bucket that is created.

" } }, "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateCertificate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateCertificateRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateCertificateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateCertificate", "code": 200 } } }, "com.amazonaws.lightsail#CreateCertificateRequest": { "type": "structure", "members": { "certificateName": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { "smithy.api#documentation": "

The name for the certificate.

", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name (example.com) for the certificate.

", "smithy.api#required": {} } }, "subjectAlternativeNames": { "target": "com.amazonaws.lightsail#SubjectAlternativeNameList", "traits": { "smithy.api#documentation": "

An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) for the certificate.

\n

You can specify a maximum of nine alternate domains (in addition to the primary domain\n name).

\n

Wildcard domain entries (*.example.com) are not supported.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the certificate during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateCertificateResult": { "type": "structure", "members": { "certificate": { "target": "com.amazonaws.lightsail#CertificateSummary", "traits": { "smithy.api#documentation": "

An object that describes the certificate created.

" } }, "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateCloudFormationStack": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateCloudFormationStackRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateCloudFormationStackResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported\n Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be\n used to track the AWS CloudFormation stack created. Use the get cloud formation stack\n records operation to get a list of the CloudFormation stacks created.

\n \n

Wait until after your new Amazon EC2 instance is created before running the create\n cloud formation stack operation again with the same export snapshot record.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateCloudFormationStack", "code": 200 } } }, "com.amazonaws.lightsail#CreateCloudFormationStackRequest": { "type": "structure", "members": { "instances": { "target": "com.amazonaws.lightsail#InstanceEntryList", "traits": { "smithy.api#documentation": "

An array of parameters that will be used to create the new Amazon EC2 instance. You can only\n pass one instance entry at a time in this array. You will get an invalid parameter error if\n you pass more than one instance entry in this array.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateCloudFormationStackResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContactMethod": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateContactMethodRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateContactMethodResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

The create contact method operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateContactMethod", "code": 200 } } }, "com.amazonaws.lightsail#CreateContactMethodRequest": { "type": "structure", "members": { "protocol": { "target": "com.amazonaws.lightsail#ContactProtocol", "traits": { "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

", "smithy.api#required": {} } }, "contactEndpoint": { "target": "com.amazonaws.lightsail#StringMax256", "traits": { "smithy.api#documentation": "

The destination of the contact method, such as an email address or a mobile phone\n number.

\n

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the\n phone number structure used for international telecommunication. Phone numbers that follow\n this format can have a maximum of 15 digits, and they are prefixed with the plus character (+)\n and the country code. For example, a U.S. phone number in E.164 format would be specified as\n +1XXX5550100. For more information, see E.164 on Wikipedia.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the contact method during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateContactMethodResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerService": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateContainerServiceRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateContainerServiceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Lightsail container service.

\n

A Lightsail container service is a compute resource to which you can deploy containers.\n For more information, see Container services in Amazon Lightsail in the Lightsail Dev\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-services", "code": 201 } } }, "com.amazonaws.lightsail#CreateContainerServiceDeployment": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a deployment for your Amazon Lightsail container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", "code": 201 } } }, "com.amazonaws.lightsail#CreateContainerServiceDeploymentRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to create the deployment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "containers": { "target": "com.amazonaws.lightsail#ContainerMap", "traits": { "smithy.api#documentation": "

An object that describes the settings of the containers that will be launched on the\n container service.

" } }, "publicEndpoint": { "target": "com.amazonaws.lightsail#EndpointRequest", "traits": { "smithy.api#documentation": "

An object that describes the settings of the public endpoint for the container\n service.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateContainerServiceDeploymentResult": { "type": "structure", "members": { "containerService": { "target": "com.amazonaws.lightsail#ContainerService", "traits": { "smithy.api#documentation": "

An object that describes a container service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a temporary set of log in credentials that you can use to log in to the Docker\n process on your local machine. After you're logged in, you can use the native Docker commands\n to push your local container images to the container image registry of your Amazon Lightsail\n account so that you can use them with your Lightsail container service. The log in\n credentials expire 12 hours after they are created, at which point you will need to create a\n new set of log in credentials.

\n \n

You can only push container images to the container service registry of your Lightsail\n account. You cannot pull container images or perform any other container image management\n actions on the container service registry.

\n
\n

After you push your container images to the container image registry of your Lightsail\n account, use the RegisterContainerImage action to register the pushed images to a\n specific Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-registry-login", "code": 200 } } }, "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateContainerServiceRegistryLoginResult": { "type": "structure", "members": { "registryLogin": { "target": "com.amazonaws.lightsail#ContainerServiceRegistryLogin", "traits": { "smithy.api#documentation": "

An object that describes the log in information for the container service registry of your\n Lightsail account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerServiceRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name for the container service.

\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for\n your container service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n

The following are the requirements for container service names:

\n ", "smithy.api#required": {} } }, "power": { "target": "com.amazonaws.lightsail#ContainerServicePowerName", "traits": { "smithy.api#documentation": "

The power specification for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to get a list of power options that\n you can specify using this parameter, and their base monthly cost.

", "smithy.api#required": {} } }, "scale": { "target": "com.amazonaws.lightsail#ContainerServiceScale", "traits": { "smithy.api#documentation": "

The scale specification for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the container service during create.

\n

Use the TagResource action to tag a resource after it's created.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "publicDomainNames": { "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", "traits": { "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n
\n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" } }, "deployment": { "target": "com.amazonaws.lightsail#ContainerServiceDeploymentRequest", "traits": { "smithy.api#documentation": "

An object that describes a deployment for the container service.

\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

" } }, "privateRegistryAccess": { "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", "traits": { "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateContainerServiceResult": { "type": "structure", "members": { "containerService": { "target": "com.amazonaws.lightsail#ContainerService", "traits": { "smithy.api#documentation": "

An object that describes a container service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDisk": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDiskRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDiskResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the\n same Availability Zone (us-east-2a).

\n

The create disk operation supports tag-based access control via request tags.\n For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDisk", "code": 200 } } }, "com.amazonaws.lightsail#CreateDiskFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDiskFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting\n disk can be attached to an Amazon Lightsail instance in the same Availability Zone\n (us-east-2a).

\n

The create disk from snapshot operation supports tag-based access control via\n request tags and resource tags applied to the resource identified by disk snapshot\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDiskFromSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateDiskFromSnapshotRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique Lightsail disk name (my-disk).

", "smithy.api#required": {} } }, "diskSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the disk snapshot (my-snapshot) from which to create the new\n storage disk.

\n

Constraint:

\n " } }, "availabilityZone": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Availability Zone where you want to create the disk (us-east-2a). Choose\n the same Availability Zone as the Lightsail instance where you want to create the\n disk.

\n

Use the GetRegions operation to list the Availability Zones where Lightsail is currently\n available.

", "smithy.api#required": {} } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB (32).

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnRequestList", "traits": { "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" } }, "sourceDiskName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the source disk from which the source automatic snapshot was created.

\n

Constraints:

\n " } }, "restoreDate": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The date of the automatic snapshot to use for the new disk. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " } }, "useLatestRestorableAutoSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDiskFromSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDiskRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique Lightsail disk name (my-disk).

", "smithy.api#required": {} } }, "availabilityZone": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Availability Zone where you want to create the disk (us-east-2a). Use the\n same Availability Zone as the Lightsail instance to which you want to attach the\n disk.

\n

Use the get regions operation to list the Availability Zones where\n Lightsail is currently available.

", "smithy.api#required": {} } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB (32).

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnRequestList", "traits": { "smithy.api#documentation": "

An array of objects that represent the add-ons to enable for the new disk.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDiskResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDiskSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDiskSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDiskSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make\n copies of disks, and to save data before shutting down a Lightsail instance.

\n

You can take a snapshot of an attached disk that is in use; however, snapshots only\n capture data that has been written to your disk at the time the snapshot command is issued.\n This may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the disk long enough to take a snapshot, your snapshot\n should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should\n unmount the disk from within the Lightsail instance, issue the create disk snapshot command,\n and then remount the disk to ensure a consistent and complete snapshot. You may remount and\n use your disk while the snapshot status is pending.

\n

You can also use this operation to create a snapshot of an instance's system volume. You\n might want to do this, for example, to recover data from the system volume of a botched\n instance or to create a backup of the system volume like you would for a block storage disk.\n To create a snapshot of a system volume, just define the instance name parameter\n when issuing the snapshot command, and a snapshot of the defined instance's system volume will\n be created. After the snapshot is available, you can create a block storage disk from the\n snapshot and attach it to a running instance to access the data on the disk.

\n

The create disk snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDiskSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateDiskSnapshotRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the source disk (Disk-Virginia-1).

\n \n

This parameter cannot be defined together with the instance name parameter.\n The disk name and instance name parameters are mutually\n exclusive.

\n
" } }, "diskSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the destination disk snapshot (my-disk-snapshot) based on the\n source disk.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the source instance (Amazon_Linux-512MB-Virginia-1). When\n this is defined, a snapshot of the instance's system volume is created.

\n \n

This parameter cannot be defined together with the disk name parameter. The\n instance name and disk name parameters are mutually\n exclusive.

\n
" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDiskSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDistribution": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDistributionRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDistributionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Lightsail content delivery network (CDN) distribution.

\n

A distribution is a globally distributed network of caching servers that improve the\n performance of your website or web application hosted on a Lightsail instance. For more\n information, see Content delivery networks in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDistribution", "code": 200 } } }, "com.amazonaws.lightsail#CreateDistributionRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for the distribution.

", "smithy.api#required": {} } }, "origin": { "target": "com.amazonaws.lightsail#InputOrigin", "traits": { "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

", "smithy.api#required": {} } }, "defaultCacheBehavior": { "target": "com.amazonaws.lightsail#CacheBehavior", "traits": { "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

", "smithy.api#required": {} } }, "cacheBehaviorSettings": { "target": "com.amazonaws.lightsail#CacheSettings", "traits": { "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

" } }, "cacheBehaviors": { "target": "com.amazonaws.lightsail#CacheBehaviorList", "traits": { "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" } }, "bundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID to use for the distribution.

\n

A distribution bundle describes the specifications of your distribution, such as the\n monthly cost and monthly network transfer quota.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

", "smithy.api#required": {} } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type for the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n

The default value is dualstack.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the distribution during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate that you want to attach to the distribution.

\n

Use the GetCertificates\n action to get a list of certificate names that you can specify.

" } }, "viewerMinimumTlsProtocolVersion": { "target": "com.amazonaws.lightsail#ViewerMinimumTlsProtocolVersionEnum", "traits": { "smithy.api#documentation": "

The minimum TLS protocol version for the SSL/TLS certificate.

" } }, "enablePrivateOriginAccess": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies whether to enable private origin access for the distribution. With private\n origin access, the distribution can serve objects that aren't publicly accessible from a\n Lightsail bucket.

\n

Lightsail grants the distribution permission to read the bucket's objects. Enabling\n private origin access doesn't change the bucket's access settings, and you can still\n retrieve publicly accessible objects directly from the bucket's endpoint.

\n \n

You can enable private origin access only when the distribution's origin is a\n Lightsail bucket. If the origin is another resource type, the request fails.

\n
" } }, "defaultRootObject": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The object (for example, index.html) that the distribution returns when a\n viewer requests the root URL of the distribution (/) instead of a specific\n object. The object that you specify must be available from the origin.

" } }, "customErrorResponses": { "target": "com.amazonaws.lightsail#DistributionCustomErrorResponseList", "traits": { "smithy.api#documentation": "

An array of objects that describe the custom error responses for the distribution. With a\n custom error response, you can specify the page to return when the origin responds with a\n given HTTP error code. You can also specify the HTTP status code to send to the viewer.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDistributionResult": { "type": "structure", "members": { "distribution": { "target": "com.amazonaws.lightsail#LightsailDistribution", "traits": { "smithy.api#documentation": "

An object that describes the distribution created.

" } }, "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDomain": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDomainRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDomainResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a domain resource for the specified domain (example.com).

\n

The create domain operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDomain", "code": 200 } } }, "com.amazonaws.lightsail#CreateDomainEntry": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateDomainEntryRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateDomainEntryResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates one of the following domain name system (DNS) records in a domain DNS zone:\n Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority\n (SOA), service locator (SRV), or text (TXT).

\n

The create domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateDomainEntry", "code": 200 } } }, "com.amazonaws.lightsail#CreateDomainEntryRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name (example.com) for which you want to create the domain\n entry.

", "smithy.api#required": {} } }, "domainEntry": { "target": "com.amazonaws.lightsail#DomainEntry", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry request.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDomainEntryResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDomainRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name to manage (example.com).

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateDomainResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateGUISessionAccessDetails": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates two URLs that are used to access a virtual computer\u2019s graphical user interface\n (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual\n computer's application. The secondary URL initiates a web-based Amazon DCV session to the\n virtual computer's operating session.

\n

Use StartGUISession to open the session.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/create-gui-session-access-details", "code": 200 } } }, "com.amazonaws.lightsail#CreateGUISessionAccessDetailsRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateGUISessionAccessDetailsResult": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

" } }, "status": { "target": "com.amazonaws.lightsail#Status", "traits": { "smithy.api#documentation": "

The status of the operation.

" } }, "percentageComplete": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The percentage of completion for the operation.

" } }, "failureReason": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The reason the operation failed.

" } }, "sessions": { "target": "com.amazonaws.lightsail#Sessions", "traits": { "smithy.api#documentation": "

Returns information about the specified Amazon DCV GUI session.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstanceSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateInstanceSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateInstanceSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of a specific virtual private server, or instance.\n You can use a snapshot to create a new instance that is based on that snapshot.

\n

The create instance snapshot operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateInstanceSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateInstanceSnapshotRequest": { "type": "structure", "members": { "instanceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for your new snapshot.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The Lightsail instance on which to base your snapshot.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateInstanceSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstances": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateInstancesRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateInstancesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates one or more Amazon Lightsail instances.

\n

The create instances operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateInstances", "code": 200 } } }, "com.amazonaws.lightsail#CreateInstancesFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates one or more new instances from a manual or automatic snapshot of an\n instance.

\n

The create instances from snapshot operation supports tag-based access\n control via request tags and resource tags applied to the resource identified by\n instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateInstancesFromSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateInstancesFromSnapshotRequest": { "type": "structure", "members": { "instanceNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The names for your new instances.

", "smithy.api#required": {} } }, "attachedDiskMapping": { "target": "com.amazonaws.lightsail#AttachedDiskMap", "traits": { "smithy.api#documentation": "

An object containing information about one or more disk mappings.

" } }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone where you want to create your instances. Use the following\n formatting: us-east-2a (case sensitive). You can get a list of Availability Zones\n by using the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", "smithy.api#required": {} } }, "instanceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance snapshot on which you are basing your new instances. Use the get\n instance snapshots operation to return information about your existing snapshots.

\n

Constraint:

\n " } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (micro_x_x).

", "smithy.api#required": {} } }, "userData": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

You can create a launch script that configures a server with additional user data. For\n example, apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n
" } }, "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for your key pair.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnRequestList", "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

\n

The default value is dualstack.

" } }, "sourceInstanceName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the source instance from which the source automatic snapshot was\n created.

\n

Constraints:

\n " } }, "restoreDate": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The date of the automatic snapshot to use for the new instance. Use the get auto\n snapshots operation to identify the dates of the available automatic\n snapshots.

\n

Constraints:

\n " } }, "useLatestRestorableAutoSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether to use the latest available automatic snapshot.

\n

Constraints:

\n " } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateInstancesFromSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstancesRequest": { "type": "structure", "members": { "instanceNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The names to use for your new Lightsail instances. Separate multiple values using\n quotation marks and commas, for example:\n [\"MyFirstInstance\",\"MySecondInstance\"]\n

", "smithy.api#required": {} } }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone in which to create your instance. Use the following format:\n us-east-2a (case sensitive). You can get a list of Availability Zones by using\n the get\n regions operation. Be sure to add the include Availability Zones\n parameter to your request.

", "smithy.api#required": {} } }, "customImageName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

(Discontinued) The name for your custom image.

\n \n

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now\n discontinued.

\n
" } }, "blueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID for a virtual private server image (app_wordpress_x_x or\n app_lamp_x_x). Use the get blueprints operation to return a list\n of available images (or blueprints).

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n
", "smithy.api#required": {} } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle of specification information for your virtual private server (or\n instance), including the pricing plan (medium_x_x).

", "smithy.api#required": {} } }, "userData": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg. For a complete list, see the\n Amazon Lightsail Developer Guide.

\n
" } }, "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your key pair.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnRequestList", "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons to enable for the new instance.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type for the instance.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

\n

The default value is dualstack.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateInstancesResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateKeyPairRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateKeyPairResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a custom SSH key pair that you can use with an Amazon Lightsail\n instance.

\n \n

Use the DownloadDefaultKeyPair action to create a Lightsail default key\n pair in an Amazon Web Services Region where a default key pair does not currently\n exist.

\n
\n

The create key pair operation supports tag-based access control via request\n tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateKeyPair", "code": 200 } } }, "com.amazonaws.lightsail#CreateKeyPairRequest": { "type": "structure", "members": { "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for your new key pair.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateKeyPairResult": { "type": "structure", "members": { "keyPair": { "target": "com.amazonaws.lightsail#KeyPair", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the new key pair you just\n created.

" } }, "publicKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" } }, "privateKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

A base64-encoded RSA private key.

" } }, "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateLoadBalancerRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateLoadBalancerResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a Lightsail load balancer. To learn more about deciding whether to load balance\n your application, see Configure your Lightsail instances for load balancing. You can create up to 10\n load balancers per AWS Region in your account.

\n

When you create a load balancer, you can specify a unique name and port settings. To\n change additional load balancer settings, use the UpdateLoadBalancerAttribute\n operation.

\n

The create load balancer operation supports tag-based access control via\n request tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateLoadBalancer", "code": 200 } } }, "com.amazonaws.lightsail#CreateLoadBalancerRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your load balancer.

", "smithy.api#required": {} } }, "instancePort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The instance port where you're creating your load balancer.

", "smithy.api#required": {} } }, "healthCheckPath": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path you provided to perform the load balancer health check. If you didn't specify a\n health check path, Lightsail uses the root path of your website (\"/\").

\n

You may want to specify a custom health check path other than the root of your application\n if your home page loads slowly or has a lot of media or scripting on it.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate.

\n

If you specify certificateName, then certificateDomainName is\n required (and vice-versa).

" } }, "certificateDomainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name with which your certificate is associated\n (example.com).

\n

If you specify certificateDomainName, then certificateName is\n required (and vice-versa).

" } }, "certificateAlternativeNames": { "target": "com.amazonaws.lightsail#DomainNameList", "traits": { "smithy.api#documentation": "

The optional alternative domains and subdomains to use with your SSL/TLS certificate\n (www.example.com, example.com, m.example.com,\n blog.example.com).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type for the load balancer.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

\n

The default value is dualstack.

" } }, "tlsPolicyName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateLoadBalancerResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

The CreateLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateLoadBalancerTlsCertificate", "code": 200 } } }, "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The load balancer name where you want to create the SSL/TLS certificate.

", "smithy.api#required": {} } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The SSL/TLS certificate name.

\n

You can have up to 10 certificates in your account at one time. Each Lightsail load\n balancer can have up to 2 certificates associated with it at one time. There is also an\n overall limit to the number of certificates that can be issue in a 365-day period. For more\n information, see Limits.

", "smithy.api#required": {} } }, "certificateDomainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name (example.com) for your SSL/TLS certificate.

", "smithy.api#required": {} } }, "certificateAlternativeNames": { "target": "com.amazonaws.lightsail#DomainNameList", "traits": { "smithy.api#documentation": "

An array of strings listing alternative domains and subdomains for your SSL/TLS\n certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9\n alternative names (in addition to the 1 primary domain). We do not support wildcards\n (*.example.com).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificateResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a new database in Amazon Lightsail.

\n

The create relational database operation supports tag-based access control\n via request tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a new database from an existing database snapshot in Amazon Lightsail.

\n

You can create a new database from a snapshot in if something goes wrong with your\n original database, or to change it to a different plan, such as a high availability or\n standard plan.

\n

The create relational database from snapshot operation supports tag-based\n access control via request tags and resource tags applied to the resource identified by\n relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseFromSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" } }, "publiclyAccessible": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database snapshot from which to create your new database.

" } }, "relationalDatabaseBundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

\n

When creating a new database from a snapshot, you cannot choose a bundle that is smaller\n than the bundle of the source database.

" } }, "sourceRelationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source database.

" } }, "restoreTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date and time to restore your database from.

\n

Constraints:

\n " } }, "useLatestRestorableTime": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies whether your database is restored from the latest backup time. A value of\n true restores from the latest backup time.

\n

Default: false\n

\n

Constraints: Cannot be specified if the restore time parameter is\n provided.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name to use for your new Lightsail database resource.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone in which to create your new database. Use the\n us-east-2a case-sensitive format.

\n

You can get a list of Availability Zones by using the get regions operation.\n Be sure to add the include relational database Availability Zones parameter to\n your request.

" } }, "relationalDatabaseBlueprintId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The blueprint ID for your new database. A blueprint describes the major engine version of\n a database.

\n

You can get a list of database blueprints IDs by using the get relational database\n blueprints operation.

", "smithy.api#required": {} } }, "relationalDatabaseBundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID for your new database. A bundle describes the performance specifications for\n your database.

\n

You can get a list of database bundle IDs by using the get relational database\n bundles operation.

", "smithy.api#required": {} } }, "masterDatabaseName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, no database is created in the database resource.

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

The name of the database to create when the Lightsail database resource is created. If\n this parameter isn't specified, a database named postgres is created in the\n database resource.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "masterUsername": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name for the master user.

\n

\n MySQL\n

\n

Constraints:

\n \n

\n PostgreSQL\n

\n

Constraints:

\n ", "smithy.api#required": {} } }, "masterUserPassword": { "target": "com.amazonaws.lightsail#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\". It cannot contain spaces.

\n

\n MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" } }, "preferredBackupWindow": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created for your new database if\n automated backups are enabled.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region. For more information about the preferred backup window time blocks for each\n region, see the Working With Backups guide in the Amazon Relational Database Service documentation.

\n

Constraints:

\n " } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your new\n database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n AWS Region, occurring on a random day of the week.

\n

Constraints:

\n " } }, "publiclyAccessible": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies the accessibility options for your new database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups,\n to make copies of a database, and to save data before deleting a database.

\n

The create relational database snapshot operation supports tag-based access\n control via request tags. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateRelationalDatabaseSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database on which to base your new snapshot.

", "smithy.api#required": {} } }, "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for your new database snapshot.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the resource during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#Currency": { "type": "enum", "members": { "USD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USD" } } } }, "com.amazonaws.lightsail#DeleteAlarm": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteAlarmRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteAlarmResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", "smithy.api#http": { "method": "DELETE", "uri": "/ls/api/2016-11-28/DeleteAlarm/{alarmName}", "code": 200 } } }, "com.amazonaws.lightsail#DeleteAlarmRequest": { "type": "structure", "members": { "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteAlarmResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteAutoSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteAutoSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteAutoSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteAutoSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#DeleteAutoSnapshotRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source instance or disk from which to delete the automatic\n snapshot.

", "smithy.api#required": {} } }, "date": { "target": "com.amazonaws.lightsail#AutoSnapshotDate", "traits": { "smithy.api#documentation": "

The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the\n get auto snapshots operation to get the available automatic snapshots for a\n resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteAutoSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteBucket": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteBucketRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteBucketResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a Amazon Lightsail bucket.

\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteBucket", "code": 200 } } }, "com.amazonaws.lightsail#DeleteBucketAccessKey": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteBucketAccessKeyResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an access key for the specified Amazon Lightsail bucket.

\n

We recommend that you delete an access key if the secret access key is compromised.

\n

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteBucketAccessKey", "code": 200 } } }, "com.amazonaws.lightsail#DeleteBucketAccessKeyRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket that the access key belongs to.

", "smithy.api#required": {} } }, "accessKeyId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the access key to delete.

\n

Use the GetBucketAccessKeys action to get a\n list of access key IDs that you can specify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteBucketAccessKeyResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteBucketRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket to delete.

\n

Use the GetBuckets action to get a list of bucket names\n that you can specify.

", "smithy.api#required": {} } }, "forceDelete": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to force delete the bucket.

\n

You must force delete the bucket if it has one of the following conditions:

\n \n \n

Force deleting a bucket might impact other resources that rely on the bucket, such as\n instances, distributions, or software that use the issued access keys.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteBucketResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteCertificate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteCertificateRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteCertificateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

Certificates that are currently attached to a distribution cannot be deleted. Use the\n DetachCertificateFromDistribution action to detach a certificate from a\n distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteCertificate", "code": 200 } } }, "com.amazonaws.lightsail#DeleteCertificateRequest": { "type": "structure", "members": { "certificateName": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { "smithy.api#documentation": "

The name of the certificate to delete.

\n

Use the GetCertificates action to get a list of certificate names that you\n can specify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteCertificateResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteContactMethod": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteContactMethodRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteContactMethodResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteContactMethod", "code": 200 } } }, "com.amazonaws.lightsail#DeleteContactMethodRequest": { "type": "structure", "members": { "protocol": { "target": "com.amazonaws.lightsail#ContactProtocol", "traits": { "smithy.api#documentation": "

The protocol that will be deleted, such as Email or SMS (text\n messaging).

\n \n

To delete an Email and an SMS contact method if you added\n both, you must run separate DeleteContactMethod actions to delete each\n protocol.

\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteContactMethodResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteContainerImage": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteContainerImageRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteContainerImageResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a container image that is registered to your Amazon Lightsail container\n service.

", "smithy.api#http": { "method": "DELETE", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images/{image}", "code": 204 } } }, "com.amazonaws.lightsail#DeleteContainerImageRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to delete a registered container image.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "image": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the container image to delete from the container service.

\n

Use the GetContainerImages action to get the name of the container images\n that are registered to a container service.

\n \n

Container images sourced from your Lightsail container service, that are registered\n and stored on your service, start with a colon (:). For example,\n :container-service-1.mystaticwebsite.1. Container images sourced from a\n public registry like Docker Hub don't start with a colon. For example,\n nginx:latest or nginx.

\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteContainerImageResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteContainerService": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteContainerServiceRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteContainerServiceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes your Amazon Lightsail container service.

", "smithy.api#http": { "method": "DELETE", "uri": "/ls/api/2016-11-28/container-services/{serviceName}", "code": 204 } } }, "com.amazonaws.lightsail#DeleteContainerServiceRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteContainerServiceResult": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDisk": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteDiskRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteDiskResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified block storage disk. The disk must be in the available\n state (not attached to a Lightsail instance).

\n \n

The disk may remain in the deleting state for several minutes.

\n
\n

The delete disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteDisk", "code": 200 } } }, "com.amazonaws.lightsail#DeleteDiskRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the disk you want to delete (my-disk).

", "smithy.api#required": {} } }, "forceDeleteAddOns": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the disk.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteDiskResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDiskSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteDiskSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteDiskSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified disk snapshot.

\n

When you make periodic snapshots of a disk, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the disk.

\n

The delete disk snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by disk snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteDiskSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#DeleteDiskSnapshotRequest": { "type": "structure", "members": { "diskSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the disk snapshot you want to delete (my-disk-snapshot).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteDiskSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDistribution": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteDistributionRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteDistributionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteDistribution", "code": 200 } } }, "com.amazonaws.lightsail#DeleteDistributionRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution to delete.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteDistributionResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDomain": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteDomainRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteDomainResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified domain recordset and all of its domain records.

\n

The delete domain operation supports tag-based access control via resource\n tags applied to the resource identified by domain name. For more information, see\n the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteDomain", "code": 200 } } }, "com.amazonaws.lightsail#DeleteDomainEntry": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteDomainEntryRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteDomainEntryResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a specific domain entry.

\n

The delete domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteDomainEntry", "code": 200 } } }, "com.amazonaws.lightsail#DeleteDomainEntryRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain entry to delete.

", "smithy.api#required": {} } }, "domainEntry": { "target": "com.amazonaws.lightsail#DomainEntry", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about your domain entries.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteDomainEntryResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDomainRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The specific domain name to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteDomainResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteInstance": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteInstanceRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteInstanceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an Amazon Lightsail instance.

\n

The delete instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteInstance", "code": 200 } } }, "com.amazonaws.lightsail#DeleteInstanceRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance to delete.

", "smithy.api#required": {} } }, "forceDeleteAddOns": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether to delete all add-ons for the instance.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteInstanceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteInstanceSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteInstanceSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a specific snapshot of a virtual private server (or\n instance).

\n

The delete instance snapshot operation supports tag-based access control via\n resource tags applied to the resource identified by instance snapshot name. For\n more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteInstanceSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#DeleteInstanceSnapshotRequest": { "type": "structure", "members": { "instanceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the snapshot to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteInstanceSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteKeyPairRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteKeyPairResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified key pair by removing the public key from Amazon Lightsail.

\n

You can delete key pairs that were created using the ImportKeyPair and\n CreateKeyPair actions, as well as the Lightsail default key pair. A new default\n key pair will not be created unless you launch an instance without specifying a custom key\n pair, or you call the DownloadDefaultKeyPair API.

\n

The delete key pair operation supports tag-based access control via resource\n tags applied to the resource identified by key pair name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteKeyPair", "code": 200 } } }, "com.amazonaws.lightsail#DeleteKeyPairRequest": { "type": "structure", "members": { "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the key pair to delete.

", "smithy.api#required": {} } }, "expectedFingerprint": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The RSA fingerprint of the Lightsail default key pair to delete.

\n \n

The expectedFingerprint parameter is required only when specifying to\n delete a Lightsail default key pair.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteKeyPairResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteKnownHostKeys": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteKnownHostKeysRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteKnownHostKeysResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or\n RDP clients to authenticate an instance. This operation enables the Lightsail browser-based\n SSH or RDP clients to connect to the instance after a host key mismatch.

\n \n

Perform this operation only if you were expecting the host key or certificate mismatch\n or if you are familiar with the new host key or certificate on the instance. For more\n information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP\n client.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteKnownHostKeys", "code": 200 } } }, "com.amazonaws.lightsail#DeleteKnownHostKeysRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which you want to reset the host key or certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteKnownHostKeysResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteLoadBalancerRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteLoadBalancerResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the\n load balancer is deleted, you will need to create a new load balancer, create a new\n certificate, and verify domain ownership again.

\n

The delete load balancer operation supports tag-based access control via\n resource tags applied to the resource identified by load balancer name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteLoadBalancer", "code": 200 } } }, "com.amazonaws.lightsail#DeleteLoadBalancerRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer you want to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancerResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

\n

The DeleteLoadBalancerTlsCertificate operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteLoadBalancerTlsCertificate", "code": 200 } } }, "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The load balancer name.

", "smithy.api#required": {} } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The SSL/TLS certificate name.

", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, forces the deletion of an SSL/TLS certificate.

\n

There can be two certificates associated with a Lightsail load balancer: the primary and\n the backup. The force parameter is required when the primary SSL/TLS certificate\n is in use by an instance attached to the load balancer.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificateResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a database in Amazon Lightsail.

\n

The delete relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database that you are deleting.

", "smithy.api#required": {} } }, "skipFinalSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Determines whether a final database snapshot is created before your database is deleted.\n If true is specified, no database snapshot is created. If false is\n specified, a database snapshot is created before your database is deleted.

\n

You must specify the final relational database snapshot name parameter if the\n skip final snapshot parameter is false.

\n

Default: false\n

" } }, "finalRelationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database snapshot created if skip final snapshot is\n false, which is the default value for that parameter.

\n \n

Specifying this parameter and also specifying the skip final snapshot\n parameter to true results in an error.

\n
\n

Constraints:

\n " } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a database snapshot in Amazon Lightsail.

\n

The delete relational database snapshot operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteRelationalDatabaseSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotRequest": { "type": "structure", "members": { "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database snapshot that you are deleting.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DestinationInfo": { "type": "structure", "members": { "id": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the resource created at the destination.

" } }, "service": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The destination service of the record.

" } } }, "traits": { "smithy.api#documentation": "

Describes the destination of a record.

" } }, "com.amazonaws.lightsail#DetachCertificateFromDistribution": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest" }, "output": { "target": "com.amazonaws.lightsail#DetachCertificateFromDistributionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is detached, your distribution stops accepting traffic for all of\n the domains that are associated with the certificate.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DetachCertificateFromDistribution", "code": 200 } } }, "com.amazonaws.lightsail#DetachCertificateFromDistributionRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution from which to detach the certificate.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DetachCertificateFromDistributionResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachDisk": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DetachDiskRequest" }, "output": { "target": "com.amazonaws.lightsail#DetachDiskResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount\n any file systems on the device within your operating system before stopping the instance and\n detaching the disk.

\n

The detach disk operation supports tag-based access control via resource tags\n applied to the resource identified by disk name. For more information, see the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DetachDisk", "code": 200 } } }, "com.amazonaws.lightsail#DetachDiskRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the disk you want to detach from your instance\n (my-disk).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DetachDiskResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest" }, "output": { "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Detaches the specified instances from a Lightsail load balancer.

\n

This operation waits until the instances are no longer needed before they are detached\n from the load balancer.

\n

The detach instances from load balancer operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DetachInstancesFromLoadBalancer", "code": 200 } } }, "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail load balancer.

", "smithy.api#required": {} } }, "instanceNames": { "target": "com.amazonaws.lightsail#ResourceNameList", "traits": { "smithy.api#documentation": "

An array of strings containing the names of the instances you want to detach from the load\n balancer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DetachInstancesFromLoadBalancerResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachStaticIp": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DetachStaticIpRequest" }, "output": { "target": "com.amazonaws.lightsail#DetachStaticIpResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DetachStaticIp", "code": 200 } } }, "com.amazonaws.lightsail#DetachStaticIpRequest": { "type": "structure", "members": { "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP to detach from the instance.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DetachStaticIpResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#DisableAddOn": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DisableAddOnRequest" }, "output": { "target": "com.amazonaws.lightsail#DisableAddOnResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DisableAddOn", "code": 200 } } }, "com.amazonaws.lightsail#DisableAddOnRequest": { "type": "structure", "members": { "addOnType": { "target": "com.amazonaws.lightsail#AddOnType", "traits": { "smithy.api#documentation": "

The add-on type to disable.

", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source resource for which to disable the add-on.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DisableAddOnResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#Disk": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the disk.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the disk was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk is located.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (Disk).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnList", "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the disk.

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB.

" } }, "isSystemDisk": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" } }, "iops": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The input/output operations per second (IOPS) of the disk.

" } }, "path": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The disk path.

" } }, "state": { "target": "com.amazonaws.lightsail#DiskState", "traits": { "smithy.api#documentation": "

Describes the status of the disk.

" } }, "attachedTo": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resources to which the disk is attached.

" } }, "isAttached": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the disk is attached.

" } }, "attachmentState": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

(Discontinued) The attachment state of the disk.

\n \n

In releases prior to November 14, 2017, this parameter returned attached\n for system disks in the API response. It is now discontinued, but still included in the\n response. Use isAttached instead.

\n
" } }, "gbInUse": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

(Discontinued) The number of GB in use by the disk.

\n \n

In releases prior to November 14, 2017, this parameter was not included in the API\n response. It is now discontinued.

\n
" } }, "autoMountStatus": { "target": "com.amazonaws.lightsail#AutoMountStatus", "traits": { "smithy.api#documentation": "

The status of automatically mounting a storage disk to a virtual computer.

\n \n

This parameter only applies to Lightsail for Research resources.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes a block storage disk.

" } }, "com.amazonaws.lightsail#DiskInfo": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The disk name.

" } }, "path": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The disk path.

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB (32).

" } }, "isSystemDisk": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether this disk is a system disk (has an operating system\n loaded on it).

" } } }, "traits": { "smithy.api#documentation": "

Describes a disk.

" } }, "com.amazonaws.lightsail#DiskInfoList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DiskInfo" } }, "com.amazonaws.lightsail#DiskList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Disk" } }, "com.amazonaws.lightsail#DiskMap": { "type": "structure", "members": { "originalDiskPath": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The original disk path exposed to the instance (for example,\n /dev/sdh).

" } }, "newDiskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The new disk name (my-new-disk).

" } } }, "traits": { "smithy.api#documentation": "

Describes a block storage disk mapping.

" } }, "com.amazonaws.lightsail#DiskMapList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DiskMap" } }, "com.amazonaws.lightsail#DiskSnapshot": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the disk snapshot (my-disk-snapshot).

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the disk snapshot.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the disk snapshot was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The AWS Region and Availability Zone where the disk snapshot was created.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (DiskSnapshot).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB.

" } }, "state": { "target": "com.amazonaws.lightsail#DiskSnapshotState", "traits": { "smithy.api#documentation": "

The status of the disk snapshot operation.

" } }, "progress": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The progress of the snapshot.

" } }, "fromDiskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the source disk from which the disk snapshot was created.

" } }, "fromDiskArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was\n created.

" } }, "fromInstanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the source instance from which the disk (system volume) snapshot was\n created.

" } }, "fromInstanceArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)\n snapshot was created.

" } }, "isFromAutoSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" } } }, "traits": { "smithy.api#documentation": "

Describes a block storage disk snapshot.

" } }, "com.amazonaws.lightsail#DiskSnapshotInfo": { "type": "structure", "members": { "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB (32).

" } } }, "traits": { "smithy.api#documentation": "

Describes a disk snapshot.

" } }, "com.amazonaws.lightsail#DiskSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DiskSnapshot" } }, "com.amazonaws.lightsail#DiskSnapshotState": { "type": "enum", "members": { "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "Completed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "completed" } }, "Error": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "error" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknown" } } } }, "com.amazonaws.lightsail#DiskState": { "type": "enum", "members": { "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "Error": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "error" } }, "Available": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "available" } }, "InUse": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "in-use" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknown" } } } }, "com.amazonaws.lightsail#DistributionBundle": { "type": "structure", "members": { "bundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID of the bundle.

" } }, "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the distribution bundle.

" } }, "price": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The monthly price, in US dollars, of the bundle.

" } }, "transferPerMonthInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The monthly network transfer quota of the bundle.

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the bundle is active, and can be specified for a new or existing\n distribution.

" } } }, "traits": { "smithy.api#documentation": "

Describes the specifications of a distribution bundle.

" } }, "com.amazonaws.lightsail#DistributionBundleList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DistributionBundle" } }, "com.amazonaws.lightsail#DistributionCustomErrorResponse": { "type": "structure", "members": { "errorCode": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The HTTP error code from the origin that triggers the custom error response (for example,\n 403 or 404).

" } }, "responseCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The HTTP status code that the distribution returns to the viewer for the custom error\n response.

" } }, "responsePagePath": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The path to the custom error page that the distribution returns to the viewer (for\n example, /404.html). The path must begin with a forward slash (/)\n and reference an object that is available from the origin.

" } }, "errorCachingMinTTL": { "target": "com.amazonaws.lightsail#long", "traits": { "smithy.api#documentation": "

The minimum time, in seconds, that the distribution caches the custom error response\n before requesting the object again from the origin. If you don't specify a value, the default\n is 10 seconds.

" } } }, "traits": { "smithy.api#documentation": "

Describes a custom error response for a Lightsail distribution. A custom error response\n specifies the page that the distribution returns to the viewer. It also specifies the HTTP\n status code that the distribution sends when the origin responds with a given HTTP error code.

" } }, "com.amazonaws.lightsail#DistributionCustomErrorResponseList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DistributionCustomErrorResponse" } }, "com.amazonaws.lightsail#DistributionList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LightsailDistribution" } }, "com.amazonaws.lightsail#DistributionMetricName": { "type": "enum", "members": { "Requests": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Requests" } }, "BytesDownloaded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BytesDownloaded" } }, "BytesUploaded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BytesUploaded" } }, "TotalErrorRate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TotalErrorRate" } }, "Http4xxErrorRate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Http4xxErrorRate" } }, "Http5xxErrorRate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Http5xxErrorRate" } } } }, "com.amazonaws.lightsail#DnsRecordCreationState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#DnsRecordCreationStateCode", "traits": { "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message that describes the reason for the status code.

" } } }, "traits": { "smithy.api#documentation": "

Describes the creation state of the canonical name (CNAME) records that are automatically\n added by Amazon Lightsail to the DNS of a domain to validate domain ownership for\n an SSL/TLS certificate.

\n

When you create an SSL/TLS certificate for a Lightsail resource, you must\n add a set of CNAME records to the DNS of the domains for the certificate to validate that you\n own the domains. Lightsail can automatically add the CNAME records to the DNS\n of the domain if the DNS zone for the domain exists within your Lightsail\n account. If automatic record addition fails, or if you manage the DNS of your domain using a\n third-party service, then you must manually add the CNAME records to the DNS of your domain.\n For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#DnsRecordCreationStateCode": { "type": "enum", "members": { "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.lightsail#Domain": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the domain.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the domain recordset\n (arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the domain recordset was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The AWS Region and Availability Zones where the domain recordset was created.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "domainEntries": { "target": "com.amazonaws.lightsail#DomainEntryList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entries.

" } }, "registeredDomainDelegationInfo": { "target": "com.amazonaws.lightsail#RegisteredDomainDelegationInfo", "traits": { "smithy.api#documentation": "

An object that describes the state of the Route\u00a053 domain delegation to a\n Lightsail DNS zone.

" } } }, "traits": { "smithy.api#documentation": "

Describes a domain where you are storing recordsets.

" } }, "com.amazonaws.lightsail#DomainEntry": { "type": "structure", "members": { "id": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the domain recordset entry.

" } }, "name": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

" } }, "target": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The target IP address (192.0.2.0), or AWS name server\n (ns-111.awsdns-22.com.).

\n

For Lightsail load balancers, the value looks like\n ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. For\n Lightsail distributions, the value looks like exampled1182ne.cloudfront.net.\n For Lightsail container services, the value looks like\n container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com. Be sure to\n also set isAlias to true when setting up an A record for a\n Lightsail load balancer, distribution, or container service.

" } }, "isAlias": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services\n resource. You can include an alias (A type) record in your request, which points to the DNS\n name of a load balancer, container service, CDN distribution, or other Amazon Web Services\n resource and routes traffic to that resource.

" } }, "type": { "target": "com.amazonaws.lightsail#DomainEntryType", "traits": { "smithy.api#documentation": "

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical\n name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator\n (SRV), or text (TXT).

\n

The following domain entry types can be used:

\n " } }, "options": { "target": "com.amazonaws.lightsail#DomainEntryOptions", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

(Discontinued) The options for the domain entry.

\n \n

In releases prior to November 29, 2017, this parameter was not included in the API\n response. It is now discontinued.

\n
" } } }, "traits": { "smithy.api#documentation": "

Describes a domain recordset entry.

" } }, "com.amazonaws.lightsail#DomainEntryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DomainEntry" } }, "com.amazonaws.lightsail#DomainEntryOptions": { "type": "map", "key": { "target": "com.amazonaws.lightsail#DomainEntryOptionsKeys" }, "value": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#DomainEntryOptionsKeys": { "type": "string" }, "com.amazonaws.lightsail#DomainEntryType": { "type": "string" }, "com.amazonaws.lightsail#DomainList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Domain" } }, "com.amazonaws.lightsail#DomainName": { "type": "string" }, "com.amazonaws.lightsail#DomainNameList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DomainName" } }, "com.amazonaws.lightsail#DomainValidationRecord": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name of the certificate validation record. For example,\n example.com or www.example.com.

" } }, "resourceRecord": { "target": "com.amazonaws.lightsail#ResourceRecord", "traits": { "smithy.api#documentation": "

An object that describes the DNS records to add to your domain's DNS to validate it for\n the certificate.

" } }, "dnsRecordCreationState": { "target": "com.amazonaws.lightsail#DnsRecordCreationState", "traits": { "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" } }, "validationStatus": { "target": "com.amazonaws.lightsail#CertificateDomainValidationStatus", "traits": { "smithy.api#documentation": "

The validation status of the record.

" } } }, "traits": { "smithy.api#documentation": "

Describes the domain name system (DNS) records that you must add to the DNS of your\n registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

" } }, "com.amazonaws.lightsail#DomainValidationRecordList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DomainValidationRecord" } }, "com.amazonaws.lightsail#DownloadDefaultKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest" }, "output": { "target": "com.amazonaws.lightsail#DownloadDefaultKeyPairResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Downloads the regional Amazon Lightsail default key pair.

\n

This action also creates a Lightsail default key pair if a default key pair\n does not currently exist in the Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DownloadDefaultKeyPair", "code": 200 } } }, "com.amazonaws.lightsail#DownloadDefaultKeyPairRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#DownloadDefaultKeyPairResult": { "type": "structure", "members": { "publicKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

" } }, "privateKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

A base64-encoded RSA private key.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the default key pair was created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#EligibleToRenew": { "type": "string" }, "com.amazonaws.lightsail#EmailAddress": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 254 }, "smithy.api#pattern": "^[\\w!#$%&.'*+\\/=?^_\\x60{|}~\\-]{1,64}@[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$", "smithy.api#sensitive": {} } }, "com.amazonaws.lightsail#EnableAddOn": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#EnableAddOnRequest" }, "output": { "target": "com.amazonaws.lightsail#EnableAddOnResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see\n the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/EnableAddOn", "code": 200 } } }, "com.amazonaws.lightsail#EnableAddOnRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source resource for which to enable or modify the add-on.

", "smithy.api#required": {} } }, "addOnRequest": { "target": "com.amazonaws.lightsail#AddOnRequest", "traits": { "smithy.api#documentation": "

An array of strings representing the add-on to enable or modify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#EnableAddOnResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#EndpointRequest": { "type": "structure", "members": { "containerName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the container for the endpoint.

", "smithy.api#required": {} } }, "containerPort": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The port of the container to which traffic is forwarded to.

", "smithy.api#required": {} } }, "healthCheck": { "target": "com.amazonaws.lightsail#ContainerServiceHealthCheckConfig", "traits": { "smithy.api#documentation": "

An object that describes the health check configuration of the container.

" } } }, "traits": { "smithy.api#documentation": "

Describes the settings of a public endpoint for an Amazon Lightsail container\n service.

" } }, "com.amazonaws.lightsail#Environment": { "type": "map", "key": { "target": "com.amazonaws.lightsail#string" }, "value": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#EstimateByTime": { "type": "structure", "members": { "usageCost": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The amount of cost or usage that's measured for the cost estimate.

" } }, "pricingUnit": { "target": "com.amazonaws.lightsail#PricingUnit", "traits": { "smithy.api#documentation": "

The unit of measurement that's used for the cost estimate.

" } }, "unit": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The number of pricing units used to calculate the total number of hours. For example, 1\n unit equals 1 hour.

" } }, "currency": { "target": "com.amazonaws.lightsail#Currency", "traits": { "smithy.api#documentation": "

The currency of the estimate in USD.

" } }, "timePeriod": { "target": "com.amazonaws.lightsail#TimePeriod", "traits": { "smithy.api#documentation": "

The period of time, in days, that an estimate covers. The period has a start date and an\n end date. The start date must come before the end date.

" } } }, "traits": { "smithy.api#documentation": "

An estimate that's associated with a time period.

" } }, "com.amazonaws.lightsail#EstimatesByTime": { "type": "list", "member": { "target": "com.amazonaws.lightsail#EstimateByTime" } }, "com.amazonaws.lightsail#ExportSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#ExportSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#ExportSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/ExportSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#ExportSnapshotRecord": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The export snapshot record name.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export snapshot record.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the export snapshot record was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The AWS Region and Availability Zone where the export snapshot record is located.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (ExportSnapshotRecord).

" } }, "state": { "target": "com.amazonaws.lightsail#RecordState", "traits": { "smithy.api#documentation": "

The state of the export snapshot record.

" } }, "sourceInfo": { "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo", "traits": { "smithy.api#documentation": "

A list of objects describing the source of the export snapshot record.

" } }, "destinationInfo": { "target": "com.amazonaws.lightsail#DestinationInfo", "traits": { "smithy.api#documentation": "

A list of objects describing the destination of the export snapshot record.

" } } }, "traits": { "smithy.api#documentation": "

Describes an export snapshot record.

" } }, "com.amazonaws.lightsail#ExportSnapshotRecordList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ExportSnapshotRecord" } }, "com.amazonaws.lightsail#ExportSnapshotRecordSourceInfo": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.lightsail#ExportSnapshotRecordSourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (InstanceSnapshot or\n DiskSnapshot).

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when the source instance or disk snapshot was created.

" } }, "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the source instance or disk snapshot.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" } }, "fromResourceName": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the snapshot's source instance or disk.

" } }, "fromResourceArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" } }, "instanceSnapshotInfo": { "target": "com.amazonaws.lightsail#InstanceSnapshotInfo", "traits": { "smithy.api#documentation": "

A list of objects describing an instance snapshot.

" } }, "diskSnapshotInfo": { "target": "com.amazonaws.lightsail#DiskSnapshotInfo", "traits": { "smithy.api#documentation": "

A list of objects describing a disk snapshot.

" } } }, "traits": { "smithy.api#documentation": "

Describes the source of an export snapshot record.

" } }, "com.amazonaws.lightsail#ExportSnapshotRecordSourceType": { "type": "enum", "members": { "InstanceSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InstanceSnapshot" } }, "DiskSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskSnapshot" } } } }, "com.amazonaws.lightsail#ExportSnapshotRequest": { "type": "structure", "members": { "sourceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance or disk snapshot to be exported to Amazon EC2.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#ExportSnapshotResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#ForwardValues": { "type": "enum", "members": { "none": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "none" } }, "allowList": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "allow-list" } }, "all": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "all" } } } }, "com.amazonaws.lightsail#GetActiveNames": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetActiveNamesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetActiveNamesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the names of all active (not deleted) resources.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetActiveNames", "code": 200 }, "smithy.test#smokeTests": [ { "id": "GetActiveNamesSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.lightsail#GetActiveNamesRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetActiveNames request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetActiveNamesResult": { "type": "structure", "members": { "activeNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The list of active names returned by the get active names request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetAlarms": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetAlarmsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetAlarmsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about the configured alarms. Specify an alarm name in your request to\n return information about a specific alarm, or specify a monitored resource name to return\n information about all alarms for a specific resource.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/GetAlarms", "code": 200 } } }, "com.amazonaws.lightsail#GetAlarmsRequest": { "type": "structure", "members": { "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm.

\n

Specify an alarm name to return information about a specific alarm.

", "smithy.api#httpQuery": "alarmName" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetAlarms request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

", "smithy.api#httpQuery": "pageToken" } }, "monitoredResourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail resource being monitored by the alarm.

\n

Specify a monitored resource name to return information about all alarms for a specific\n resource.

", "smithy.api#httpQuery": "monitoredResourceName" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetAlarmsResult": { "type": "structure", "members": { "alarms": { "target": "com.amazonaws.lightsail#AlarmsList", "traits": { "smithy.api#documentation": "

An array of objects that describe the alarms.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetAutoSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetAutoSnapshotsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetAutoSnapshotsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the available automatic snapshots for an instance or disk. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetAutoSnapshots", "code": 200 } } }, "com.amazonaws.lightsail#GetAutoSnapshotsRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source instance or disk from which to get automatic snapshot\n information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetAutoSnapshotsResult": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the source instance or disk for the automatic snapshots.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the automatic snapshot. The possible values are\n Instance, and Disk.

" } }, "autoSnapshots": { "target": "com.amazonaws.lightsail#AutoSnapshotDetailsList", "traits": { "smithy.api#documentation": "

An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBlueprints": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBlueprintsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBlueprintsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the list of available instance images, or blueprints. You can\n use a blueprint to create a new instance already running a specific operating system, as well\n as a preinstalled app or development stack. The software each instance is running depends on\n the blueprint image you choose.

\n \n

Use active blueprints when creating new instances. Inactive blueprints are listed to\n support customers with existing instances and are not necessarily available to create new\n instances. Blueprints are marked inactive when they become outdated due to operating system\n updates or new application releases.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBlueprints", "code": 200 } } }, "com.amazonaws.lightsail#GetBlueprintsRequest": { "type": "structure", "members": { "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) blueprints in the\n response of your request.

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBlueprints request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } }, "appCategory": { "target": "com.amazonaws.lightsail#AppCategory", "traits": { "smithy.api#documentation": "

Returns a list of blueprints that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research blueprints.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBlueprintsResult": { "type": "structure", "members": { "blueprints": { "target": "com.amazonaws.lightsail#BlueprintList", "traits": { "smithy.api#documentation": "

An array of key-value pairs that contains information about the available\n blueprints.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBucketAccessKeys": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBucketAccessKeysRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBucketAccessKeysResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

\n \n

This action does not return the secret access key value of an access key. You can get a\n secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create\n a new access key.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBucketAccessKeys", "code": 200 } } }, "com.amazonaws.lightsail#GetBucketAccessKeysRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket for which to return access keys.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBucketAccessKeysResult": { "type": "structure", "members": { "accessKeys": { "target": "com.amazonaws.lightsail#AccessKeyList", "traits": { "smithy.api#documentation": "

An object that describes the access keys for the specified bucket.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBucketBundles": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBucketBundlesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBucketBundlesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the bundles that you can apply to a Amazon Lightsail bucket.

\n

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a\n bucket.

\n

Use the UpdateBucketBundle action to update the\n bundle for a bucket.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBucketBundles", "code": 200 } } }, "com.amazonaws.lightsail#GetBucketBundlesRequest": { "type": "structure", "members": { "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBucketBundlesResult": { "type": "structure", "members": { "bundles": { "target": "com.amazonaws.lightsail#BucketBundleList", "traits": { "smithy.api#documentation": "

An object that describes bucket bundles.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBucketMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBucketMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBucketMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail bucket.

\n

Metrics report the utilization of a bucket. View and collect metric data regularly to\n monitor the number of objects stored in a bucket (including object versions) and the storage\n space used by those objects.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBucketMetricData", "code": 200 } } }, "com.amazonaws.lightsail#GetBucketMetricDataRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket for which to get metric data.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#BucketMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid bucket metric names are listed below, along with the most useful statistics to\n include in your request, and the published unit value.

\n \n

These bucket metrics are reported once per day.

\n
\n ", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp indicating the earliest data to be returned.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp indicating the latest data to be returned.

", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n \n

Bucket storage metrics are reported once per day. Therefore, you should specify a period\n of 86400 seconds, which is the number of seconds in a day.

\n
", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBucketMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#BucketMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBuckets": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBucketsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBucketsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBuckets", "code": 200 } } }, "com.amazonaws.lightsail#GetBucketsRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket for which to return information.

\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBuckets request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } }, "includeConnectedResources": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail instances that were given\n access to the bucket using the SetResourceAccessForBucket\n action.

" } }, "includeCors": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include Lightsail bucket CORS configuration in the response. For more information, see Configuring cross-origin resource sharing (CORS).

\n \n

This parameter is only supported when getting a single bucket with bucketName specified. The default value for this parameter is False.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBucketsResult": { "type": "structure", "members": { "buckets": { "target": "com.amazonaws.lightsail#BucketList", "traits": { "smithy.api#documentation": "

An array of objects that describe buckets.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" } }, "accountLevelBpaSync": { "target": "com.amazonaws.lightsail#AccountLevelBpaSync", "traits": { "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBundles": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetBundlesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetBundlesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the bundles that you can apply to an Amazon Lightsail instance when you create\n it.

\n

A bundle describes the specifications of an instance, such as the monthly cost, amount of\n memory, the number of vCPUs, amount of storage space, and monthly network data transfer\n quota.

\n \n

Bundles are referred to as instance plans in the Lightsail\n console.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBundles", "code": 200 } } }, "com.amazonaws.lightsail#GetBundlesRequest": { "type": "structure", "members": { "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetBundles request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } }, "appCategory": { "target": "com.amazonaws.lightsail#AppCategory", "traits": { "smithy.api#documentation": "

Returns a list of bundles that are specific to Lightsail for Research.

\n \n

You must use this parameter to view Lightsail for Research bundles.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetBundlesResult": { "type": "structure", "members": { "bundles": { "target": "com.amazonaws.lightsail#BundleList", "traits": { "smithy.api#documentation": "

An array of key-value pairs that contains information about the available bundles.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetCertificates": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetCertificatesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetCertificatesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

\n \n

To get a summary of a certificate, omit includeCertificateDetails from your\n request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetCertificates", "code": 200 } } }, "com.amazonaws.lightsail#GetCertificatesRequest": { "type": "structure", "members": { "certificateStatuses": { "target": "com.amazonaws.lightsail#CertificateStatusList", "traits": { "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" } }, "includeCertificateDetails": { "target": "com.amazonaws.lightsail#IncludeCertificateDetails", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to include detailed information about the certificates in the\n response.

\n

When omitted, the response includes only the certificate names, Amazon Resource Names\n (ARNs), domain names, and tags.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetCertificates request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetCertificatesResult": { "type": "structure", "members": { "certificates": { "target": "com.amazonaws.lightsail#CertificateSummaryList", "traits": { "smithy.api#documentation": "

An object that describes certificates.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

If NextPageToken is returned there are more results available. The value of\n NextPageToken is a unique pagination token for each page. Make the call again\n using the returned token to retrieve the next page. Keep all other arguments unchanged.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetCloudFormationStackRecords": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the CloudFormation stack record created as a result of the create cloud\n formation stack operation.

\n

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail\n snapshot.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetCloudFormationStackRecords", "code": 200 } } }, "com.amazonaws.lightsail#GetCloudFormationStackRecordsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetClouFormationStackRecords request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetCloudFormationStackRecordsResult": { "type": "structure", "members": { "cloudFormationStackRecords": { "target": "com.amazonaws.lightsail#CloudFormationStackRecordList", "traits": { "smithy.api#documentation": "

A list of objects describing the CloudFormation stack records.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContactMethods": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContactMethodsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContactMethodsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/GetContactMethods", "code": 200 } } }, "com.amazonaws.lightsail#GetContactMethodsRequest": { "type": "structure", "members": { "protocols": { "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { "smithy.api#documentation": "

The protocols used to send notifications, such as Email, or SMS\n (text messaging).

\n

Specify a protocol in your request to return information about a specific contact method\n protocol.

", "smithy.api#httpQuery": "protocols" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContactMethodsResult": { "type": "structure", "members": { "contactMethods": { "target": "com.amazonaws.lightsail#ContactMethodsList", "traits": { "smithy.api#documentation": "

An array of objects that describe the contact methods.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerAPIMetadata": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerAPIMetadataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerAPIMetadataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about Amazon Lightsail containers, such as the current version of the\n Lightsail Control (lightsailctl) plugin.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-api-metadata", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerAPIMetadataRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerAPIMetadataResult": { "type": "structure", "members": { "metadata": { "target": "com.amazonaws.lightsail#ContainerServiceMetadataEntryList", "traits": { "smithy.api#documentation": "

Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerImages": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerImagesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerImagesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the container images that are registered to your Amazon Lightsail container\n service.

\n \n

If you created a deployment on your Lightsail container service that uses container\n images from a public registry like Docker Hub, those images are not returned as part of this\n action. Those images are not registered to your Lightsail container service.

\n
", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerImagesRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to return registered container images.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerImagesResult": { "type": "structure", "members": { "containerImages": { "target": "com.amazonaws.lightsail#ContainerImageList", "traits": { "smithy.api#documentation": "

An array of objects that describe container images that are registered to the container\n service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerLog": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerLogRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerLogResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the log events of a container of your Amazon Lightsail container service.

\n

If your container service has more than one node (i.e., a scale greater than 1), then the\n log events that are returned for the specified container are merged from all nodes on your\n container service.

\n \n

Container logs are retained for a certain amount of time. For more information, see\n Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n
", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/containers/{containerName}/log", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerLogRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to get a container log.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "containerName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the container that is either running or previously ran on the container\n service for which to return a log.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The start of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#httpQuery": "startTime" } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The end of the time interval for which to get log data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#httpQuery": "endTime" } }, "filterPattern": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The pattern to use to filter the returned log events to a specific term.

\n

The following are a few examples of filter patterns that you can specify:

\n ", "smithy.api#httpQuery": "filterPattern" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetContainerLog request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

", "smithy.api#httpQuery": "pageToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerLogResult": { "type": "structure", "members": { "logEvents": { "target": "com.amazonaws.lightsail#ContainerServiceLogEventList", "traits": { "smithy.api#documentation": "

An array of objects that describe the log events of a container.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServiceDeployments": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the deployments for your Amazon Lightsail container service

\n

A deployment specifies the settings, such as the ports and launch command, of containers\n that are deployed to your container service.

\n

The deployments are ordered by version in ascending order. The newest version is listed at\n the top of the response.

\n \n

A set number of deployments are kept before the oldest one is replaced with the newest\n one. For more information, see Amazon Lightsail\n endpoints and quotas in the Amazon Web Services General\n Reference.

\n
", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerServiceDeploymentsRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to return deployments.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerServiceDeploymentsResult": { "type": "structure", "members": { "deployments": { "target": "com.amazonaws.lightsail#ContainerServiceDeploymentList", "traits": { "smithy.api#documentation": "

An array of objects that describe deployments for a container service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServiceMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerServiceMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the data points of a specific metric of your Amazon Lightsail container\n service.

\n

Metrics report the utilization of your resources. Monitor and collect metric data\n regularly to maintain the reliability, availability, and performance of your resources.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/metrics", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerServiceMetricDataRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to get metric data.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#ContainerServiceMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid container service metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit value.

\n ", "smithy.api#httpQuery": "metricName", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The start time of the time period.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The end time of the time period.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All container service metric data is available in 5-minute (300 seconds)\n granularity.

", "smithy.api#httpQuery": "period", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#httpQuery": "statistics", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerServiceMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#ContainerServiceMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServicePowers": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerServicePowersRequest" }, "output": { "target": "com.amazonaws.lightsail#GetContainerServicePowersResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the list of powers that can be specified for your Amazon Lightsail container\n services.

\n

The power specifies the amount of memory, the number of vCPUs, and the base price of the\n container service.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-service-powers", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerServicePowersRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetContainerServicePowersResult": { "type": "structure", "members": { "powers": { "target": "com.amazonaws.lightsail#ContainerServicePowerList", "traits": { "smithy.api#documentation": "

An array of objects that describe the powers that can be specified for a container\n service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServices": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetContainerServicesRequest" }, "output": { "target": "com.amazonaws.lightsail#ContainerServicesListResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail container services.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/container-services", "code": 200 } } }, "com.amazonaws.lightsail#GetContainerServicesRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to return information.

\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", "smithy.api#httpQuery": "serviceName" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetCostEstimate": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetCostEstimateRequest" }, "output": { "target": "com.amazonaws.lightsail#GetCostEstimateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about the cost estimate for a specified resource. A cost estimate\n will not generate for a resource that has been deleted.

", "smithy.api#http": { "method": "POST", "uri": "/budgettracker/getCostEstimate", "code": 200 } } }, "com.amazonaws.lightsail#GetCostEstimateRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The cost estimate start time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The cost estimate end time.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetCostEstimateResult": { "type": "structure", "members": { "resourcesBudgetEstimate": { "target": "com.amazonaws.lightsail#ResourcesBudgetEstimate", "traits": { "smithy.api#documentation": "

Returns the estimate's forecasted cost or usage.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDisk": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDiskRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDiskResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific block storage disk.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDisk", "code": 200 } } }, "com.amazonaws.lightsail#GetDiskRequest": { "type": "structure", "members": { "diskName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the disk (my-disk).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDiskResult": { "type": "structure", "members": { "disk": { "target": "com.amazonaws.lightsail#Disk", "traits": { "smithy.api#documentation": "

An object containing information about the disk.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDiskSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDiskSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDiskSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific block storage disk snapshot.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDiskSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#GetDiskSnapshotRequest": { "type": "structure", "members": { "diskSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the disk snapshot (my-disk-snapshot).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDiskSnapshotResult": { "type": "structure", "members": { "diskSnapshot": { "target": "com.amazonaws.lightsail#DiskSnapshot", "traits": { "smithy.api#documentation": "

An object containing information about the disk snapshot.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDiskSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDiskSnapshotsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDiskSnapshotsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all block storage disk snapshots in your AWS account and\n region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDiskSnapshots", "code": 200 } } }, "com.amazonaws.lightsail#GetDiskSnapshotsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDiskSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDiskSnapshotsResult": { "type": "structure", "members": { "diskSnapshots": { "target": "com.amazonaws.lightsail#DiskSnapshotList", "traits": { "smithy.api#documentation": "

An array of objects containing information about all block storage disk snapshots.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDisks": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDisksRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDisksResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all block storage disks in your AWS account and region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDisks", "code": 200 } } }, "com.amazonaws.lightsail#GetDisksRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDisks request. If your results are\n paginated, the response will return a next page token that you can specify as the page token\n in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDisksResult": { "type": "structure", "members": { "disks": { "target": "com.amazonaws.lightsail#DiskList", "traits": { "smithy.api#documentation": "

An array of objects containing information about all block storage disks.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributionBundles": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDistributionBundlesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDistributionBundlesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributionBundles", "code": 200 } } }, "com.amazonaws.lightsail#GetDistributionBundlesRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDistributionBundlesResult": { "type": "structure", "members": { "bundles": { "target": "com.amazonaws.lightsail#DistributionBundleList", "traits": { "smithy.api#documentation": "

An object that describes a distribution bundle.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail\n content delivery network (CDN) distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributionLatestCacheReset", "code": 200 } } }, "com.amazonaws.lightsail#GetDistributionLatestCacheResetRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to return the timestamp of the last cache\n reset.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

\n

When omitted, the response includes the latest cache reset timestamp of all your\n distributions.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDistributionLatestCacheResetResult": { "type": "structure", "members": { "status": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The status of the last cache reset.

" } }, "createTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp of the last cache reset (1479734909.17) in Unix time\n format.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributionMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDistributionMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDistributionMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the data points of a specific metric for an Amazon Lightsail content delivery\n network (CDN) distribution.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributionMetricData", "code": 200 } } }, "com.amazonaws.lightsail#GetDistributionMetricDataRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to get metric data.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#DistributionMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid distribution metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The start of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The end of the time interval for which to get metric data.

\n

Constraints:

\n \n

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, for the metric data points that will be returned.

", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit for the metric data request.

\n

Valid units depend on the metric data being requested. For the valid units with each\n available metric, see the metricName parameter.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDistributionMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#DistributionMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributions": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDistributionsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDistributionsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about one or more of your Amazon Lightsail content delivery network\n (CDN) distributions.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributions", "code": 200 } } }, "com.amazonaws.lightsail#GetDistributionsRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to return information.

\n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDistributions request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDistributionsResult": { "type": "structure", "members": { "distributions": { "target": "com.amazonaws.lightsail#DistributionList", "traits": { "smithy.api#documentation": "

An array of objects that describe your distributions.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDomain": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDomainRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDomainResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific domain recordset.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDomain", "code": 200 } } }, "com.amazonaws.lightsail#GetDomainRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name for which your want to return information about.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDomainResult": { "type": "structure", "members": { "domain": { "target": "com.amazonaws.lightsail#Domain", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about your get domain request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDomains": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetDomainsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetDomainsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of all domains in the user's account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDomains", "code": 200 } } }, "com.amazonaws.lightsail#GetDomainsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetDomains request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetDomainsResult": { "type": "structure", "members": { "domains": { "target": "com.amazonaws.lightsail#DomainList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about each of the domain entries in the\n user's account.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetExportSnapshotRecords": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetExportSnapshotRecordsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns all export snapshot records created as a result of the export\n snapshot operation.

\n

An export snapshot record can be used to create a new Amazon EC2 instance and its related\n resources with the CreateCloudFormationStack\n action.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetExportSnapshotRecords", "code": 200 } } }, "com.amazonaws.lightsail#GetExportSnapshotRecordsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetExportSnapshotRecords request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetExportSnapshotRecordsResult": { "type": "structure", "members": { "exportSnapshotRecords": { "target": "com.amazonaws.lightsail#ExportSnapshotRecordList", "traits": { "smithy.api#documentation": "

A list of objects describing the export snapshot records.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstance": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific Amazon Lightsail instance, which is a virtual private\n server.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstance", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceAccessDetails": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceAccessDetailsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns temporary SSH keys you can use to connect to a specific virtual private server, or\n instance.

\n

The get instance access details operation supports tag-based access control\n via resource tags applied to the resource identified by instance name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstanceAccessDetails", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceAccessDetailsRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance to access.

", "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.lightsail#InstanceAccessProtocol", "traits": { "smithy.api#documentation": "

The protocol to use to connect to your instance. Defaults to ssh.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceAccessDetailsResult": { "type": "structure", "members": { "accessDetails": { "target": "com.amazonaws.lightsail#InstanceAccessDetails", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about a get instance access\n request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the data points for the specified Amazon Lightsail instance metric, given an\n instance name.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstanceMetricData", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceMetricDataRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which you want to get metrics data.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#InstanceMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid instance metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

The StatusCheckFailed, StatusCheckFailed_Instance, and\n StatusCheckFailed_System instance metric data is available in 1-minute (60\n seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)\n granularity.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The start time of the time period.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The end time of the time period.

", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units to specify with each available metric, see the\n metricName parameter.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#InstanceMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstancePortStates": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstancePortStatesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstancePortStatesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstancePortStates", "code": 200 } } }, "com.amazonaws.lightsail#GetInstancePortStatesRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which to return firewall port states.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstancePortStatesResult": { "type": "structure", "members": { "portStates": { "target": "com.amazonaws.lightsail#InstancePortStateList", "traits": { "smithy.api#documentation": "

An array of objects that describe the firewall port states for the specified\n instance.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceResult": { "type": "structure", "members": { "instance": { "target": "com.amazonaws.lightsail#Instance", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the specified instance.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific instance snapshot.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstanceSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceSnapshotRequest": { "type": "structure", "members": { "instanceSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the snapshot for which you are requesting information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshotResult": { "type": "structure", "members": { "instanceSnapshot": { "target": "com.amazonaws.lightsail#InstanceSnapshot", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshot request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceSnapshotsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceSnapshotsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns all instance snapshots for the user's account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstanceSnapshots", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceSnapshotsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstanceSnapshots request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshotsResult": { "type": "structure", "members": { "instanceSnapshots": { "target": "com.amazonaws.lightsail#InstanceSnapshotList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the results of your get instance\n snapshots request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceState": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstanceStateRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstanceStateResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the state of a specific instance. Works on one instance at a time.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstanceState", "code": 200 } } }, "com.amazonaws.lightsail#GetInstanceStateRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance to get state information about.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstanceStateResult": { "type": "structure", "members": { "state": { "target": "com.amazonaws.lightsail#InstanceState", "traits": { "smithy.api#documentation": "

The state of the instance.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstances": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetInstancesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetInstancesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all Amazon Lightsail virtual private servers, or\n instances.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetInstances", "code": 200 } } }, "com.amazonaws.lightsail#GetInstancesRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetInstances request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetInstancesResult": { "type": "structure", "members": { "instances": { "target": "com.amazonaws.lightsail#InstanceList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about your instances.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetKeyPairRequest" }, "output": { "target": "com.amazonaws.lightsail#GetKeyPairResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific key pair.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetKeyPair", "code": 200 } } }, "com.amazonaws.lightsail#GetKeyPairRequest": { "type": "structure", "members": { "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the key pair for which you are requesting information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetKeyPairResult": { "type": "structure", "members": { "keyPair": { "target": "com.amazonaws.lightsail#KeyPair", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the key pair.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetKeyPairs": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetKeyPairsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetKeyPairsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all key pairs in the user's account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetKeyPairs", "code": 200 } } }, "com.amazonaws.lightsail#GetKeyPairsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetKeyPairs request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } }, "includeDefaultKeyPair": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include the default key pair in the response of\n your request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetKeyPairsResult": { "type": "structure", "members": { "keyPairs": { "target": "com.amazonaws.lightsail#KeyPairList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the key pairs.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancer": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetLoadBalancerRequest" }, "output": { "target": "com.amazonaws.lightsail#GetLoadBalancerResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about the specified Lightsail load balancer.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancer", "code": 200 } } }, "com.amazonaws.lightsail#GetLoadBalancerMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about health metrics for your Lightsail load balancer.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancerMetricData", "code": 200 } } }, "com.amazonaws.lightsail#GetLoadBalancerMetricDataRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#LoadBalancerMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid load balancer metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value.

\n ", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The start time of the period.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The end time of the period.

", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetLoadBalancerMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#LoadBalancerMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetLoadBalancerResult": { "type": "structure", "members": { "loadBalancer": { "target": "com.amazonaws.lightsail#LoadBalancer", "traits": { "smithy.api#documentation": "

An object containing information about your load balancer.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about the TLS certificates that are associated with the specified\n Lightsail load balancer.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

\n

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One\n is active and the other is inactive.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsCertificates", "code": 200 } } }, "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer you associated with your SSL/TLS certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsCertificatesResult": { "type": "structure", "members": { "tlsCertificates": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateList", "traits": { "smithy.api#documentation": "

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", "code": 200 } } }, "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { "type": "structure", "members": { "tlsPolicies": { "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", "traits": { "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancers": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetLoadBalancersRequest" }, "output": { "target": "com.amazonaws.lightsail#GetLoadBalancersResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all load balancers in an account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancers", "code": 200 } } }, "com.amazonaws.lightsail#GetLoadBalancersRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetLoadBalancers request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetLoadBalancersResult": { "type": "structure", "members": { "loadBalancers": { "target": "com.amazonaws.lightsail#LoadBalancerList", "traits": { "smithy.api#documentation": "

An array of LoadBalancer objects describing your load balancers.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetOperation": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetOperationRequest" }, "output": { "target": "com.amazonaws.lightsail#GetOperationResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific operation. Operations include events such as when you\n create an instance, allocate a static IP, attach a static IP, and so on.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetOperation", "code": 200 } } }, "com.amazonaws.lightsail#GetOperationRequest": { "type": "structure", "members": { "operationId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

A GUID used to identify the operation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetOperationResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetOperations": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetOperationsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetOperationsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all operations.

\n

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged\n by making each subsequent call to GetOperations use the maximum (last)\n statusChangedAt value from the previous request.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetOperations", "code": 200 } } }, "com.amazonaws.lightsail#GetOperationsForResource": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetOperationsForResourceRequest" }, "output": { "target": "com.amazonaws.lightsail#GetOperationsForResourceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Gets operations for a specific resource (an instance or a static IP).

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetOperationsForResource", "code": 200 } } }, "com.amazonaws.lightsail#GetOperationsForResourceRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource for which you are requesting information.

", "smithy.api#required": {} } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperationsForResource request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetOperationsForResourceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } }, "nextPageCount": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

(Discontinued) Returns the number of pages of results that remain.

\n \n

In releases prior to June 12, 2017, this parameter returned null by the\n API. It is now discontinued, and the API returns the next page token parameter\n instead.

\n
" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetOperationsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetOperations request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetOperationsResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetProfile": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetProfileRequest" }, "output": { "target": "com.amazonaws.lightsail#GetProfileResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about the profile of the Amazon Lightsail account that makes the\n request. The response includes the profile type and, for accounts enrolled in the Lightsail\n partner program, the partner membership details.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/GetProfile", "code": 200 } } }, "com.amazonaws.lightsail#GetProfileRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetProfileResult": { "type": "structure", "members": { "profileType": { "target": "com.amazonaws.lightsail#ProfileType", "traits": { "smithy.api#documentation": "

The type of the profile.

\n

The following profile types are possible:

\n ", "smithy.api#required": {} } }, "partner": { "target": "com.amazonaws.lightsail#PartnerInfo", "traits": { "smithy.api#documentation": "

An object that describes the partner membership of the account, such as the tier of the\n membership, its status, and when the account was enrolled.

\n

This parameter is returned only for accounts that have a profileType of\n LightsailPartner.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRegions": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRegionsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRegionsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of all valid regions for Amazon Lightsail. Use the include\n availability zones parameter to also return the Availability Zones in a\n region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRegions", "code": 200 } } }, "com.amazonaws.lightsail#GetRegionsRequest": { "type": "structure", "members": { "includeAvailabilityZones": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones in your get regions\n request. Availability Zones are indicated with a letter: us-east-2a.

" } }, "includeRelationalDatabaseAvailabilityZones": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether to also include Availability Zones for databases in\n your get regions request. Availability Zones are indicated with a letter\n (us-east-2a).

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRegionsResult": { "type": "structure", "members": { "regions": { "target": "com.amazonaws.lightsail#RegionList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about your get regions request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific database in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes\n the major engine version of a database.

\n

You can use a blueprint ID to create a new database that runs a specific database\n engine.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBlueprints", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBlueprints\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseBlueprintsResult": { "type": "structure", "members": { "blueprints": { "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprintList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database blueprints request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseBundles": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the\n performance specifications for a database.

\n

You can use a bundle ID to create a new database with explicit performance\n specifications.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseBundles", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseBundlesRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseBundles request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" } }, "includeInactive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether to include inactive (unavailable) bundles in the\n response of your request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseBundlesResult": { "type": "structure", "members": { "bundles": { "target": "com.amazonaws.lightsail#RelationalDatabaseBundleList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database bundles request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseEvents": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of events for a specific database in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseEvents", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseEventsRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database from which to get events.

", "smithy.api#required": {} } }, "durationInMinutes": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of minutes in the past from which to retrieve events. For example, to get all\n events from the past 2 hours, enter 120.

\n

Default: 60\n

\n

The minimum is 1 and the maximum is 14 days (20160 minutes).

" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseEvents request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseEventsResult": { "type": "structure", "members": { "relationalDatabaseEvents": { "target": "com.amazonaws.lightsail#RelationalDatabaseEventList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database events request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of log events for a database in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogEvents", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get log events.

", "smithy.api#required": {} } }, "logStreamName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the log stream.

\n

Use the get relational database log streams operation to get a list of\n available log streams.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The start of the time interval from which to get log events.

\n

Constraints:

\n " } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The end of the time interval from which to get log events.

\n

Constraints:

\n " } }, "startFromHead": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Parameter to specify if the log should start from head or tail. If true is\n specified, the log event starts from the head of the log. If false is specified,\n the log event starts from the tail of the log.

\n \n

For PostgreSQL, the default value of false is the only option\n available.

\n
" } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next or previous page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseLogEvents\n request. If your results are paginated, the response will return a next forward token and/or\n next backward token that you can specify as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogEventsResult": { "type": "structure", "members": { "resourceLogEvents": { "target": "com.amazonaws.lightsail#LogEventList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database log events request.

" } }, "nextBackwardToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A token used for advancing to the previous page of results from your get relational\n database log events request.

" } }, "nextForwardToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A token used for advancing to the next page of results from your get relational database\n log events request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a list of available log streams for a specific database in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseLogStreams", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get log streams.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogStreamsResult": { "type": "structure", "members": { "logStreams": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database log streams\n request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the current, previous, or pending versions of the master user password for a\n Lightsail database.

\n

The GetRelationalDatabaseMasterUserPassword operation supports tag-based\n access control via resource tags applied to the resource identified by\n relationalDatabaseName.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMasterUserPassword", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get the master user password.

", "smithy.api#required": {} } }, "passwordVersion": { "target": "com.amazonaws.lightsail#RelationalDatabasePasswordVersion", "traits": { "smithy.api#documentation": "

The password version to return.

\n

Specifying CURRENT or PREVIOUS returns the current or previous\n passwords respectively. Specifying PENDING returns the newest version of the\n password that will rotate to CURRENT. After the PENDING password\n rotates to CURRENT, the PENDING password is no longer\n available.

\n

Default: CURRENT\n

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPasswordResult": { "type": "structure", "members": { "masterUserPassword": { "target": "com.amazonaws.lightsail#SensitiveString", "traits": { "smithy.api#documentation": "

The master user password for the password version specified.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the specified version of the master user password was created.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns the data points of the specified metric for a database in Amazon Lightsail.

\n

Metrics report the utilization of your resources, and the error counts generated by them.\n Monitor and collect metric data regularly to maintain the reliability, availability, and\n performance of your resources.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseMetricData", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database from which to get metric data.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", "traits": { "smithy.api#documentation": "

The metric for which you want to return information.

\n

Valid relational database metric names are listed below, along with the most useful\n statistics to include in your request, and the published unit\n value. All relational database metric data is available in 1-minute (60 seconds)\n granularity.

\n ", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.lightsail#MetricPeriod", "traits": { "smithy.api#documentation": "

The granularity, in seconds, of the returned data points.

\n

All relational database metric data is available in 1-minute (60 seconds)\n granularity.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The start of the time interval from which to get metric data.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The end of the time interval from which to get metric data.

\n

Constraints:

\n ", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit for the metric data request. Valid units depend on the metric data being\n requested. For the valid units with each available metric, see the metricName\n parameter.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.lightsail#MetricStatisticList", "traits": { "smithy.api#documentation": "

The statistic for the metric.

\n

The following statistics are available:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMetricDataResult": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.lightsail#RelationalDatabaseMetricName", "traits": { "smithy.api#documentation": "

The name of the metric returned.

" } }, "metricData": { "target": "com.amazonaws.lightsail#MetricDatapointList", "traits": { "smithy.api#documentation": "

An array of objects that describe the metric data returned.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns all of the runtime parameters offered by the underlying database software, or\n engine, for a specific database in Amazon Lightsail.

\n

In addition to the parameter names and values, this operation returns other information\n about each parameter. This information includes whether changes require a reboot, whether the\n parameter is modifiable, the allowed values, and the data types.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseParameters", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseParametersRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to get parameters.

", "smithy.api#required": {} } }, "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseParameters\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseParametersResult": { "type": "structure", "members": { "parameters": { "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database parameters request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database that you are looking up.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseResult": { "type": "structure", "members": { "relationalDatabase": { "target": "com.amazonaws.lightsail#RelationalDatabase", "traits": { "smithy.api#documentation": "

An object describing the specified database.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific database snapshot in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshot", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotRequest": { "type": "structure", "members": { "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database snapshot for which to get information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotResult": { "type": "structure", "members": { "relationalDatabaseSnapshot": { "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot", "traits": { "smithy.api#documentation": "

An object describing the specified database snapshot.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all of your database snapshots in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabaseSnapshots", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabaseSnapshots\n request. If your results are paginated, the response will return a next page token that you\n can specify as the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshotsResult": { "type": "structure", "members": { "relationalDatabaseSnapshots": { "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshotList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational database snapshots request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabases": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetRelationalDatabasesRequest" }, "output": { "target": "com.amazonaws.lightsail#GetRelationalDatabasesResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all of your databases in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetRelationalDatabases", "code": 200 } } }, "com.amazonaws.lightsail#GetRelationalDatabasesRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetRelationalDatabases request. If\n your results are paginated, the response will return a next page token that you can specify as\n the page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetRelationalDatabasesResult": { "type": "structure", "members": { "relationalDatabases": { "target": "com.amazonaws.lightsail#RelationalDatabaseList", "traits": { "smithy.api#documentation": "

An object describing the result of your get relational databases request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetSetupHistory": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetSetupHistoryRequest" }, "output": { "target": "com.amazonaws.lightsail#GetSetupHistoryResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns detailed information for five of the most recent SetupInstanceHttps\n requests that were ran on the target instance.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/get-setup-history", "code": 200 } } }, "com.amazonaws.lightsail#GetSetupHistoryRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource for which you are requesting information.

", "smithy.api#required": {} } }, "pageToken": { "target": "com.amazonaws.lightsail#SetupHistoryPageToken", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetSetupHistory request. If your\n results are paginated, the response will return a next page token that you can specify as the\n page token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetSetupHistoryResult": { "type": "structure", "members": { "setupHistory": { "target": "com.amazonaws.lightsail#setupHistoryList", "traits": { "smithy.api#documentation": "

The historical information that's returned.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#SetupHistoryPageToken", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetSetupHistory request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetStaticIp": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetStaticIpRequest" }, "output": { "target": "com.amazonaws.lightsail#GetStaticIpResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about an Amazon Lightsail static IP.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetStaticIp", "code": 200 } } }, "com.amazonaws.lightsail#GetStaticIpRequest": { "type": "structure", "members": { "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP in Lightsail.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetStaticIpResult": { "type": "structure", "members": { "staticIp": { "target": "com.amazonaws.lightsail#StaticIp", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the requested static IP.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetStaticIps": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#GetStaticIpsRequest" }, "output": { "target": "com.amazonaws.lightsail#GetStaticIpsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns information about all static IPs in the user's account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetStaticIps", "code": 200 } } }, "com.amazonaws.lightsail#GetStaticIpsRequest": { "type": "structure", "members": { "pageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

To get a page token, perform an initial GetStaticIps request. If your results\n are paginated, the response will return a next page token that you can specify as the page\n token in a subsequent request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#GetStaticIpsResult": { "type": "structure", "members": { "staticIps": { "target": "com.amazonaws.lightsail#StaticIpList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about your get static IPs\n request.

" } }, "nextPageToken": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n

A next page token is not returned if there are no more results to display.

\n

To get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#HeaderEnum": { "type": "enum", "members": { "accept": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accept" } }, "acceptCharset": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accept-Charset" } }, "acceptDatetime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accept-Datetime" } }, "acceptEncoding": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accept-Encoding" } }, "acceptLanguage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accept-Language" } }, "authorization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Authorization" } }, "cloudFrontForwardedProto": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Forwarded-Proto" } }, "cloudFrontIsDesktopViewer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Is-Desktop-Viewer" } }, "cloudFrontIsMobileViewer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Is-Mobile-Viewer" } }, "cloudFrontIsSmartTVViewer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Is-SmartTV-Viewer" } }, "cloudFrontIsTabletViewer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Is-Tablet-Viewer" } }, "cloudFrontViewerCountry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFront-Viewer-Country" } }, "host": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Host" } }, "origin": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Origin" } }, "referer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Referer" } } } }, "com.amazonaws.lightsail#HeaderForwardList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#HeaderEnum" } }, "com.amazonaws.lightsail#HeaderObject": { "type": "structure", "members": { "option": { "target": "com.amazonaws.lightsail#ForwardValues", "traits": { "smithy.api#documentation": "

The headers that you want your distribution to forward to your origin and base caching\n on.

\n

You can configure your distribution to do one of the following:

\n " } }, "headersAllowList": { "target": "com.amazonaws.lightsail#HeaderForwardList", "traits": { "smithy.api#documentation": "

The specific headers to forward to your distribution's origin.

" } } }, "traits": { "smithy.api#documentation": "

Describes the request headers that a Lightsail distribution bases caching on.

\n

For the headers that you specify, your distribution caches separate versions of the\n specified content based on the header values in viewer requests. For example, suppose viewer\n requests for logo.jpg contain a custom product header that has a\n value of either acme or apex, and you configure your distribution to\n cache your content based on values in the product header. Your distribution\n forwards the product header to the origin and caches the response from the origin\n once for each header value.\n

" } }, "com.amazonaws.lightsail#HostKeyAttributes": { "type": "structure", "members": { "algorithm": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The SSH host key algorithm or the RDP certificate format.

\n

For SSH host keys, the algorithm may be ssh-rsa,\n ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the\n algorithm is always x509-cert.

" } }, "publicKey": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The public SSH host key or the RDP certificate.

" } }, "witnessedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" } }, "fingerprintSHA1": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

\n " } }, "fingerprintSHA256": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

\n " } }, "notValidBefore": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The returned RDP certificate is valid after this point in time.

\n

This value is listed only for RDP certificates.

" } }, "notValidAfter": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The returned RDP certificate is not valid after this point in time.

\n

This value is listed only for RDP certificates.

" } } }, "traits": { "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" } }, "com.amazonaws.lightsail#HostKeysList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#HostKeyAttributes" } }, "com.amazonaws.lightsail#HttpEndpoint": { "type": "enum", "members": { "disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } } } }, "com.amazonaws.lightsail#HttpProtocolIpv6": { "type": "enum", "members": { "disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "disabled" } }, "enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "enabled" } } } }, "com.amazonaws.lightsail#HttpTokens": { "type": "enum", "members": { "optional": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "optional" } }, "required": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } } } }, "com.amazonaws.lightsail#IAMAccessKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 20 }, "smithy.api#pattern": "^[A-Z0-9]{20}$", "smithy.api#sensitive": {} } }, "com.amazonaws.lightsail#ImportKeyPair": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#ImportKeyPairRequest" }, "output": { "target": "com.amazonaws.lightsail#ImportKeyPairResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Imports a public SSH key from a specific key pair.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/ImportKeyPair", "code": 200 } } }, "com.amazonaws.lightsail#ImportKeyPairRequest": { "type": "structure", "members": { "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the key pair for which you want to import the public key.

", "smithy.api#required": {} } }, "publicKeyBase64": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

A base64-encoded public key of the ssh-rsa type.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#ImportKeyPairResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#InUseResourceCount": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.lightsail#IncludeCertificateDetails": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.lightsail#InputOrigin": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the origin resource.

" } }, "regionName": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The AWS Region name of the origin resource.

" } }, "protocolPolicy": { "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", "traits": { "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" } }, "responseTimeout": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, that the distribution waits for a response after\n forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60\n seconds, and the default (if you don't specify otherwise) is 30 seconds.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#OriginIpAddressTypeEnum", "traits": { "smithy.api#documentation": "

The IP address type that the distribution uses when connecting to the origin.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

" } } }, "traits": { "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, container service, or load balancer. A\n distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide\n network of edge servers.

" } }, "com.amazonaws.lightsail#Instance": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name the user gave the instance (Amazon_Linux_2023-1).

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance\n (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the instance was created (1479734909.17) in Unix time\n format.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The region name and Availability Zone where the instance is located.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The type of resource (usually Instance).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "blueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The blueprint ID (amazon_linux_2023).

" } }, "blueprintName": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The friendly name of the blueprint (Amazon Linux 2023).

" } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle for the instance (micro_x_x).

" } }, "addOns": { "target": "com.amazonaws.lightsail#AddOnList", "traits": { "smithy.api#documentation": "

An array of objects representing the add-ons enabled on the instance.

" } }, "isStaticIp": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether this instance has a static IP assigned to it.

" } }, "privateIpAddress": { "target": "com.amazonaws.lightsail#IpAddress", "traits": { "smithy.api#documentation": "

The private IP address of the instance.

" } }, "publicIpAddress": { "target": "com.amazonaws.lightsail#IpAddress", "traits": { "smithy.api#documentation": "

The public IP address of the instance.

" } }, "ipv6Addresses": { "target": "com.amazonaws.lightsail#Ipv6AddressList", "traits": { "smithy.api#documentation": "

The IPv6 addresses of the instance.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type of the instance.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

" } }, "hardware": { "target": "com.amazonaws.lightsail#InstanceHardware", "traits": { "smithy.api#documentation": "

The size of the vCPU and the amount of RAM for the instance.

" } }, "networking": { "target": "com.amazonaws.lightsail#InstanceNetworking", "traits": { "smithy.api#documentation": "

Information about the public ports and monthly data transfer rates for the\n instance.

" } }, "state": { "target": "com.amazonaws.lightsail#InstanceState", "traits": { "smithy.api#documentation": "

The status code and the state (running) for the instance.

" } }, "username": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The user name for connecting to the instance (ec2-user).

" } }, "sshKeyName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSH key being used to connect to the instance\n (LightsailDefaultKeyPair).

" } }, "metadataOptions": { "target": "com.amazonaws.lightsail#InstanceMetadataOptions", "traits": { "smithy.api#documentation": "

The metadata options for the Amazon Lightsail instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes an instance (a virtual private server).

" } }, "com.amazonaws.lightsail#InstanceAccessDetails": { "type": "structure", "members": { "certKey": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

For SSH access, the public key to use when accessing your instance For OpenSSH clients\n (command line SSH), you should save this value to tempkey-cert.pub.

" } }, "expiresAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

For SSH access, the date on which the temporary keys expire.

" } }, "ipAddress": { "target": "com.amazonaws.lightsail#IpAddress", "traits": { "smithy.api#documentation": "

The public IP address of the Amazon Lightsail instance.

" } }, "ipv6Addresses": { "target": "com.amazonaws.lightsail#Ipv6AddressList", "traits": { "smithy.api#documentation": "

The IPv6 address of the Amazon Lightsail instance.

" } }, "password": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty\n string if the password for your new instance is not ready yet. When you create an instance, it\n can take up to 15 minutes for the instance to be ready.

\n \n

If you create an instance using any key pair other than the default\n (LightsailDefaultKeyPair), password will always be an empty\n string.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original password value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n
" } }, "passwordData": { "target": "com.amazonaws.lightsail#PasswordData", "traits": { "smithy.api#documentation": "

For a Windows Server-based instance, an object with the data you can use to retrieve your\n password. This is only needed if password is empty and the instance is not new\n (and therefore the password is not ready yet). When you create an instance, it can take up to\n 15 minutes for the instance to be ready.

" } }, "privateKey": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

For SSH access, the temporary private key. For OpenSSH clients (command line SSH), you\n should save this value to tempkey).

" } }, "protocol": { "target": "com.amazonaws.lightsail#InstanceAccessProtocol", "traits": { "smithy.api#documentation": "

The protocol for these Amazon Lightsail instance access details.

" } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of this Amazon Lightsail instance.

" } }, "username": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The user name to use when logging in to the Amazon Lightsail instance.

" } }, "hostKeys": { "target": "com.amazonaws.lightsail#HostKeysList", "traits": { "smithy.api#documentation": "

Describes the public SSH host keys or the RDP certificate.

" } } }, "traits": { "smithy.api#documentation": "

The parameters for gaining temporary access to one of your Amazon Lightsail\n instances.

" } }, "com.amazonaws.lightsail#InstanceAccessProtocol": { "type": "enum", "members": { "ssh": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ssh" } }, "rdp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "rdp" } } } }, "com.amazonaws.lightsail#InstanceEntry": { "type": "structure", "members": { "sourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the export snapshot record, which contains the exported Lightsail instance\n snapshot that will be used as the source of the new Amazon EC2 instance.

\n

Use the get export snapshot records operation to get a list of export\n snapshot records that you can use to create a CloudFormation stack.

", "smithy.api#required": {} } }, "instanceType": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The instance type (t2.micro) to use for the new Amazon EC2 instance.

", "smithy.api#required": {} } }, "portInfoSource": { "target": "com.amazonaws.lightsail#PortInfoSourceType", "traits": { "smithy.api#documentation": "

The port configuration to use for the new Amazon EC2 instance.

\n

The following configuration options are available:

\n \n \n

If you configured lightsail-connect as a cidrListAliases on\n your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to\n connect to your instance, that configuration is not carried over to your new Amazon EC2\n instance.

\n
", "smithy.api#required": {} } }, "userData": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

A launch script you can create that configures a server with additional user data. For\n example, you might want to run apt-get -y update.

\n \n

Depending on the machine image you choose, the command to get software on your instance\n varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use\n apt-get, and FreeBSD uses pkg.

\n
" } }, "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone for the new Amazon EC2 instance.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the\n create cloud formation stack operation.

" } }, "com.amazonaws.lightsail#InstanceEntryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstanceEntry" } }, "com.amazonaws.lightsail#InstanceHardware": { "type": "structure", "members": { "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of vCPUs the instance has.

" } }, "disks": { "target": "com.amazonaws.lightsail#DiskList", "traits": { "smithy.api#documentation": "

The disks attached to the instance.

" } }, "ramSizeInGb": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The amount of RAM in GB on the instance (1.0).

" } } }, "traits": { "smithy.api#documentation": "

Describes the hardware for the instance.

" } }, "com.amazonaws.lightsail#InstanceHealthReason": { "type": "enum", "members": { "LbRegistrationInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lb.RegistrationInProgress" } }, "LbInitialHealthChecking": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lb.InitialHealthChecking" } }, "LbInternalError": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lb.InternalError" } }, "InstanceResponseCodeMismatch": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.ResponseCodeMismatch" } }, "InstanceTimeout": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.Timeout" } }, "InstanceFailedHealthChecks": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.FailedHealthChecks" } }, "InstanceNotRegistered": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.NotRegistered" } }, "InstanceNotInUse": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.NotInUse" } }, "InstanceDeregistrationInProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.DeregistrationInProgress" } }, "InstanceInvalidState": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.InvalidState" } }, "InstanceIpUnusable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance.IpUnusable" } } } }, "com.amazonaws.lightsail#InstanceHealthState": { "type": "enum", "members": { "Initial": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "initial" } }, "Healthy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "healthy" } }, "Unhealthy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unhealthy" } }, "Unused": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unused" } }, "Draining": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "draining" } }, "Unavailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unavailable" } } } }, "com.amazonaws.lightsail#InstanceHealthSummary": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance for which you are requesting health check\n data.

" } }, "instanceHealth": { "target": "com.amazonaws.lightsail#InstanceHealthState", "traits": { "smithy.api#documentation": "

Describes the overall instance health. Valid values are below.

" } }, "instanceHealthReason": { "target": "com.amazonaws.lightsail#InstanceHealthReason", "traits": { "smithy.api#documentation": "

More information about the instance health. If the instanceHealth is\n healthy, then an instanceHealthReason value is not\n provided.

\n

If \n instanceHealth\n is initial,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unhealthy,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is unused,\n the \n instanceHealthReason\n value can be one of the\n following:

\n \n

If \n instanceHealth\n is draining,\n the \n instanceHealthReason\n value can be one of the\n following:

\n " } } }, "traits": { "smithy.api#documentation": "

Describes information about the health of the instance.

" } }, "com.amazonaws.lightsail#InstanceHealthSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstanceHealthSummary" } }, "com.amazonaws.lightsail#InstanceList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Instance" } }, "com.amazonaws.lightsail#InstanceMetadataOptions": { "type": "structure", "members": { "state": { "target": "com.amazonaws.lightsail#InstanceMetadataState", "traits": { "smithy.api#documentation": "

The state of the metadata option changes.

\n

The following states are possible:

\n " } }, "httpTokens": { "target": "com.amazonaws.lightsail#HttpTokens", "traits": { "smithy.api#documentation": "

The state of token usage for your instance metadata requests.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

\n \n

Not all instance blueprints in Lightsail support version 2.0 credentials.\n Use the MetadataNoToken instance metric to track the number of calls to the\n instance metadata service that are using version 1.0 credentials. For more information, see\n Viewing instance metrics in Amazon Lightsail in the Amazon Lightsail Developer Guide.

\n
" } }, "httpEndpoint": { "target": "com.amazonaws.lightsail#HttpEndpoint", "traits": { "smithy.api#documentation": "

Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.

\n

If the value is disabled, you cannot access your instance metadata.

" } }, "httpPutResponseHopLimit": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther.

" } }, "httpProtocolIpv6": { "target": "com.amazonaws.lightsail#HttpProtocolIpv6", "traits": { "smithy.api#documentation": "

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or\n disabled.

" } } }, "traits": { "smithy.api#documentation": "

The metadata options for the instance.

" } }, "com.amazonaws.lightsail#InstanceMetadataState": { "type": "enum", "members": { "pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "applied": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "applied" } } } }, "com.amazonaws.lightsail#InstanceMetricName": { "type": "enum", "members": { "CPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CPUUtilization" } }, "NetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkIn" } }, "NetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkOut" } }, "StatusCheckFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed" } }, "StatusCheckFailed_Instance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed_Instance" } }, "StatusCheckFailed_System": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed_System" } }, "BurstCapacityTime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BurstCapacityTime" } }, "BurstCapacityPercentage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BurstCapacityPercentage" } }, "MetadataNoToken": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MetadataNoToken" } } } }, "com.amazonaws.lightsail#InstanceNetworking": { "type": "structure", "members": { "monthlyTransfer": { "target": "com.amazonaws.lightsail#MonthlyTransfer", "traits": { "smithy.api#documentation": "

The amount of data in GB allocated for monthly data transfers.

" } }, "ports": { "target": "com.amazonaws.lightsail#InstancePortInfoList", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the ports on the instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes monthly data transfer rates and port information for an instance.

" } }, "com.amazonaws.lightsail#InstancePlatform": { "type": "enum", "members": { "LinuxUnix": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINUX_UNIX" } }, "Windows": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS" } } } }, "com.amazonaws.lightsail#InstancePlatformList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstancePlatform" } }, "com.amazonaws.lightsail#InstancePortInfo": { "type": "structure", "members": { "fromPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "toPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "protocol": { "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " } }, "accessFrom": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The location from which access is allowed. For example, Anywhere (0.0.0.0/0),\n or Custom if a specific IP address or range of IP addresses is allowed.

" } }, "accessType": { "target": "com.amazonaws.lightsail#PortAccessType", "traits": { "smithy.api#documentation": "

The type of access (Public or Private).

" } }, "commonName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The common name of the port information.

" } }, "accessDirection": { "target": "com.amazonaws.lightsail#AccessDirection", "traits": { "smithy.api#documentation": "

The access direction (inbound or outbound).

\n \n

Lightsail currently supports only inbound access direction.

\n
" } }, "cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n
\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "ipv6Cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n
\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "cidrListAliases": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes information about ports for an Amazon Lightsail instance.

" } }, "com.amazonaws.lightsail#InstancePortInfoList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstancePortInfo" } }, "com.amazonaws.lightsail#InstancePortState": { "type": "structure", "members": { "fromPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "toPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "protocol": { "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " } }, "state": { "target": "com.amazonaws.lightsail#PortState", "traits": { "smithy.api#documentation": "

Specifies whether the instance port is open or closed.

\n \n

The port state for Lightsail instances is always open.

\n
" } }, "cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n
\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "ipv6Cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n
\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "cidrListAliases": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes open ports on an instance, the IP addresses allowed to connect to the instance\n through the ports, and the protocol.

" } }, "com.amazonaws.lightsail#InstancePortStateList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstancePortState" } }, "com.amazonaws.lightsail#InstanceSnapshot": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the snapshot.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot\n (arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the snapshot was created (1479907467.024).

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The region name and Availability Zone where you created the snapshot.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The type of resource (usually InstanceSnapshot).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "state": { "target": "com.amazonaws.lightsail#InstanceSnapshotState", "traits": { "smithy.api#documentation": "

The state the snapshot is in.

" } }, "progress": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The progress of the snapshot.

\n \n

This is populated only for disk snapshots, and is null for instance\n snapshots.

\n
" } }, "fromAttachedDisks": { "target": "com.amazonaws.lightsail#DiskList", "traits": { "smithy.api#documentation": "

An array of disk objects containing information about all block storage disks.

" } }, "fromInstanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The instance from which the snapshot was created.

" } }, "fromInstanceArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the instance from which the snapshot was created\n (arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" } }, "fromBlueprintId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The blueprint ID from which you created the snapshot (amazon_linux_2023). A\n blueprint is a virtual private server (or instance) image used to create\n instances quickly.

" } }, "fromBundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID from which you created the snapshot (micro_x_x).

" } }, "isFromAutoSnapshot": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the snapshot was created from an automatic\n snapshot.

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size in GB of the SSD.

" } } }, "traits": { "smithy.api#documentation": "

Describes an instance snapshot.

" } }, "com.amazonaws.lightsail#InstanceSnapshotInfo": { "type": "structure", "members": { "fromBundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle ID from which the source instance was created (micro_x_x).

" } }, "fromBlueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The blueprint ID from which the source instance (amazon_linux_2023).

" } }, "fromDiskInfo": { "target": "com.amazonaws.lightsail#DiskInfoList", "traits": { "smithy.api#documentation": "

A list of objects describing the disks that were attached to the source instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes an instance snapshot.

" } }, "com.amazonaws.lightsail#InstanceSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#InstanceSnapshot" } }, "com.amazonaws.lightsail#InstanceSnapshotState": { "type": "enum", "members": { "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "pending" } }, "Error": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "error" } }, "Available": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "available" } } } }, "com.amazonaws.lightsail#InstanceState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The status code for the instance.

" } }, "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The state of the instance (running or pending).

" } } }, "traits": { "smithy.api#documentation": "

Describes the virtual private server (or instance) status.

" } }, "com.amazonaws.lightsail#InvalidInputException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.lightsail#IpAddress": { "type": "string", "traits": { "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" } }, "com.amazonaws.lightsail#IpAddressType": { "type": "enum", "members": { "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack" } }, "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "IPV6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv6" } } } }, "com.amazonaws.lightsail#Ipv6Address": { "type": "string", "traits": { "smithy.api#pattern": "^([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}$" } }, "com.amazonaws.lightsail#Ipv6AddressList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Ipv6Address" } }, "com.amazonaws.lightsail#IsVpcPeered": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#IsVpcPeeredRequest" }, "output": { "target": "com.amazonaws.lightsail#IsVpcPeeredResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Returns a Boolean value indicating whether your Lightsail VPC is peered.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/IsVpcPeered", "code": 200 } } }, "com.amazonaws.lightsail#IsVpcPeeredRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#IsVpcPeeredResult": { "type": "structure", "members": { "isPeered": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Returns true if the Lightsail VPC is peered; otherwise,\n false.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#IsoDate": { "type": "timestamp" }, "com.amazonaws.lightsail#IssuerCA": { "type": "string" }, "com.amazonaws.lightsail#KeyAlgorithm": { "type": "string" }, "com.amazonaws.lightsail#KeyPair": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The friendly name of the SSH key pair.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key pair\n (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the key pair was created (1479816991.349).

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The region name and Availability Zone where the key pair was created.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type (usually KeyPair).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "fingerprint": { "target": "com.amazonaws.lightsail#Base64", "traits": { "smithy.api#documentation": "

The RSA fingerprint of the key pair.

" } } }, "traits": { "smithy.api#documentation": "

Describes an SSH key pair.

" } }, "com.amazonaws.lightsail#KeyPairList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#KeyPair" } }, "com.amazonaws.lightsail#LightsailDistribution": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the distribution.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail distribution. This code enables our support team to look up your Lightsail\n information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the distribution was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n
" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type (Distribution).

" } }, "alternativeDomainNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The alternate domain names of the distribution.

" } }, "status": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The status of the distribution.

" } }, "isEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the distribution is enabled.

" } }, "domainName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The domain name of the distribution.

" } }, "bundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID of the bundle currently applied to the distribution.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate attached to the distribution, if any.

" } }, "origin": { "target": "com.amazonaws.lightsail#Origin", "traits": { "smithy.api#documentation": "

An object that describes the origin resource of the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" } }, "originPublicDNS": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The public DNS of the origin.

" } }, "defaultCacheBehavior": { "target": "com.amazonaws.lightsail#CacheBehavior", "traits": { "smithy.api#documentation": "

An object that describes the default cache behavior of the distribution.

" } }, "cacheBehaviorSettings": { "target": "com.amazonaws.lightsail#CacheSettings", "traits": { "smithy.api#documentation": "

An object that describes the cache behavior settings of the distribution.

" } }, "cacheBehaviors": { "target": "com.amazonaws.lightsail#CacheBehaviorList", "traits": { "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior of the distribution.

" } }, "ableToUpdateBundle": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to your distribution, specified\n using the distributionName parameter, can be changed to another bundle.

\n

Use the UpdateDistributionBundle action to change your distribution's\n bundle.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type of the distribution.

\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "viewerMinimumTlsProtocolVersion": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The minimum TLS protocol version that the distribution can use to communicate with\n viewers.

" } }, "defaultRootObject": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The object (for example, index.html) that the distribution returns when a\n viewer requests the root URL of the distribution (/) instead of a specific\n object.

" } }, "customErrorResponses": { "target": "com.amazonaws.lightsail#DistributionCustomErrorResponseList", "traits": { "smithy.api#documentation": "

An array of objects that describe the custom error responses configured for the\n distribution.

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Lightsail content delivery network (CDN) distribution.

" } }, "com.amazonaws.lightsail#Lightsail_20161128": { "type": "service", "version": "2016-11-28", "operations": [ { "target": "com.amazonaws.lightsail#AllocateStaticIp" }, { "target": "com.amazonaws.lightsail#AttachCertificateToDistribution" }, { "target": "com.amazonaws.lightsail#AttachDisk" }, { "target": "com.amazonaws.lightsail#AttachInstancesToLoadBalancer" }, { "target": "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate" }, { "target": "com.amazonaws.lightsail#AttachStaticIp" }, { "target": "com.amazonaws.lightsail#CloseInstancePublicPorts" }, { "target": "com.amazonaws.lightsail#CopySnapshot" }, { "target": "com.amazonaws.lightsail#CreateBucket" }, { "target": "com.amazonaws.lightsail#CreateBucketAccessKey" }, { "target": "com.amazonaws.lightsail#CreateCertificate" }, { "target": "com.amazonaws.lightsail#CreateCloudFormationStack" }, { "target": "com.amazonaws.lightsail#CreateContactMethod" }, { "target": "com.amazonaws.lightsail#CreateContainerService" }, { "target": "com.amazonaws.lightsail#CreateContainerServiceDeployment" }, { "target": "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin" }, { "target": "com.amazonaws.lightsail#CreateDisk" }, { "target": "com.amazonaws.lightsail#CreateDiskFromSnapshot" }, { "target": "com.amazonaws.lightsail#CreateDiskSnapshot" }, { "target": "com.amazonaws.lightsail#CreateDistribution" }, { "target": "com.amazonaws.lightsail#CreateDomain" }, { "target": "com.amazonaws.lightsail#CreateDomainEntry" }, { "target": "com.amazonaws.lightsail#CreateGUISessionAccessDetails" }, { "target": "com.amazonaws.lightsail#CreateInstances" }, { "target": "com.amazonaws.lightsail#CreateInstancesFromSnapshot" }, { "target": "com.amazonaws.lightsail#CreateInstanceSnapshot" }, { "target": "com.amazonaws.lightsail#CreateKeyPair" }, { "target": "com.amazonaws.lightsail#CreateLoadBalancer" }, { "target": "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate" }, { "target": "com.amazonaws.lightsail#CreateRelationalDatabase" }, { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseFromSnapshot" }, { "target": "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot" }, { "target": "com.amazonaws.lightsail#DeleteAlarm" }, { "target": "com.amazonaws.lightsail#DeleteAutoSnapshot" }, { "target": "com.amazonaws.lightsail#DeleteBucket" }, { "target": "com.amazonaws.lightsail#DeleteBucketAccessKey" }, { "target": "com.amazonaws.lightsail#DeleteCertificate" }, { "target": "com.amazonaws.lightsail#DeleteContactMethod" }, { "target": "com.amazonaws.lightsail#DeleteContainerImage" }, { "target": "com.amazonaws.lightsail#DeleteContainerService" }, { "target": "com.amazonaws.lightsail#DeleteDisk" }, { "target": "com.amazonaws.lightsail#DeleteDiskSnapshot" }, { "target": "com.amazonaws.lightsail#DeleteDistribution" }, { "target": "com.amazonaws.lightsail#DeleteDomain" }, { "target": "com.amazonaws.lightsail#DeleteDomainEntry" }, { "target": "com.amazonaws.lightsail#DeleteInstance" }, { "target": "com.amazonaws.lightsail#DeleteInstanceSnapshot" }, { "target": "com.amazonaws.lightsail#DeleteKeyPair" }, { "target": "com.amazonaws.lightsail#DeleteKnownHostKeys" }, { "target": "com.amazonaws.lightsail#DeleteLoadBalancer" }, { "target": "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate" }, { "target": "com.amazonaws.lightsail#DeleteRelationalDatabase" }, { "target": "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot" }, { "target": "com.amazonaws.lightsail#DetachCertificateFromDistribution" }, { "target": "com.amazonaws.lightsail#DetachDisk" }, { "target": "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer" }, { "target": "com.amazonaws.lightsail#DetachStaticIp" }, { "target": "com.amazonaws.lightsail#DisableAddOn" }, { "target": "com.amazonaws.lightsail#DownloadDefaultKeyPair" }, { "target": "com.amazonaws.lightsail#EnableAddOn" }, { "target": "com.amazonaws.lightsail#ExportSnapshot" }, { "target": "com.amazonaws.lightsail#GetActiveNames" }, { "target": "com.amazonaws.lightsail#GetAlarms" }, { "target": "com.amazonaws.lightsail#GetAutoSnapshots" }, { "target": "com.amazonaws.lightsail#GetBlueprints" }, { "target": "com.amazonaws.lightsail#GetBucketAccessKeys" }, { "target": "com.amazonaws.lightsail#GetBucketBundles" }, { "target": "com.amazonaws.lightsail#GetBucketMetricData" }, { "target": "com.amazonaws.lightsail#GetBuckets" }, { "target": "com.amazonaws.lightsail#GetBundles" }, { "target": "com.amazonaws.lightsail#GetCertificates" }, { "target": "com.amazonaws.lightsail#GetCloudFormationStackRecords" }, { "target": "com.amazonaws.lightsail#GetContactMethods" }, { "target": "com.amazonaws.lightsail#GetContainerAPIMetadata" }, { "target": "com.amazonaws.lightsail#GetContainerImages" }, { "target": "com.amazonaws.lightsail#GetContainerLog" }, { "target": "com.amazonaws.lightsail#GetContainerServiceDeployments" }, { "target": "com.amazonaws.lightsail#GetContainerServiceMetricData" }, { "target": "com.amazonaws.lightsail#GetContainerServicePowers" }, { "target": "com.amazonaws.lightsail#GetContainerServices" }, { "target": "com.amazonaws.lightsail#GetCostEstimate" }, { "target": "com.amazonaws.lightsail#GetDisk" }, { "target": "com.amazonaws.lightsail#GetDisks" }, { "target": "com.amazonaws.lightsail#GetDiskSnapshot" }, { "target": "com.amazonaws.lightsail#GetDiskSnapshots" }, { "target": "com.amazonaws.lightsail#GetDistributionBundles" }, { "target": "com.amazonaws.lightsail#GetDistributionLatestCacheReset" }, { "target": "com.amazonaws.lightsail#GetDistributionMetricData" }, { "target": "com.amazonaws.lightsail#GetDistributions" }, { "target": "com.amazonaws.lightsail#GetDomain" }, { "target": "com.amazonaws.lightsail#GetDomains" }, { "target": "com.amazonaws.lightsail#GetExportSnapshotRecords" }, { "target": "com.amazonaws.lightsail#GetInstance" }, { "target": "com.amazonaws.lightsail#GetInstanceAccessDetails" }, { "target": "com.amazonaws.lightsail#GetInstanceMetricData" }, { "target": "com.amazonaws.lightsail#GetInstancePortStates" }, { "target": "com.amazonaws.lightsail#GetInstances" }, { "target": "com.amazonaws.lightsail#GetInstanceSnapshot" }, { "target": "com.amazonaws.lightsail#GetInstanceSnapshots" }, { "target": "com.amazonaws.lightsail#GetInstanceState" }, { "target": "com.amazonaws.lightsail#GetKeyPair" }, { "target": "com.amazonaws.lightsail#GetKeyPairs" }, { "target": "com.amazonaws.lightsail#GetLoadBalancer" }, { "target": "com.amazonaws.lightsail#GetLoadBalancerMetricData" }, { "target": "com.amazonaws.lightsail#GetLoadBalancers" }, { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" }, { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" }, { "target": "com.amazonaws.lightsail#GetOperation" }, { "target": "com.amazonaws.lightsail#GetOperations" }, { "target": "com.amazonaws.lightsail#GetOperationsForResource" }, { "target": "com.amazonaws.lightsail#GetProfile" }, { "target": "com.amazonaws.lightsail#GetRegions" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabase" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBlueprints" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseBundles" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseEvents" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogEvents" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseMetricData" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseParameters" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabases" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot" }, { "target": "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots" }, { "target": "com.amazonaws.lightsail#GetSetupHistory" }, { "target": "com.amazonaws.lightsail#GetStaticIp" }, { "target": "com.amazonaws.lightsail#GetStaticIps" }, { "target": "com.amazonaws.lightsail#ImportKeyPair" }, { "target": "com.amazonaws.lightsail#IsVpcPeered" }, { "target": "com.amazonaws.lightsail#OpenInstancePublicPorts" }, { "target": "com.amazonaws.lightsail#PeerVpc" }, { "target": "com.amazonaws.lightsail#PutAlarm" }, { "target": "com.amazonaws.lightsail#PutInstancePublicPorts" }, { "target": "com.amazonaws.lightsail#RebootInstance" }, { "target": "com.amazonaws.lightsail#RebootRelationalDatabase" }, { "target": "com.amazonaws.lightsail#RegisterContainerImage" }, { "target": "com.amazonaws.lightsail#ReleaseStaticIp" }, { "target": "com.amazonaws.lightsail#ResetDistributionCache" }, { "target": "com.amazonaws.lightsail#SendContactMethodVerification" }, { "target": "com.amazonaws.lightsail#SetIpAddressType" }, { "target": "com.amazonaws.lightsail#SetResourceAccessForBucket" }, { "target": "com.amazonaws.lightsail#SetupInstanceHttps" }, { "target": "com.amazonaws.lightsail#StartGUISession" }, { "target": "com.amazonaws.lightsail#StartInstance" }, { "target": "com.amazonaws.lightsail#StartRelationalDatabase" }, { "target": "com.amazonaws.lightsail#StopGUISession" }, { "target": "com.amazonaws.lightsail#StopInstance" }, { "target": "com.amazonaws.lightsail#StopRelationalDatabase" }, { "target": "com.amazonaws.lightsail#TagResource" }, { "target": "com.amazonaws.lightsail#TestAlarm" }, { "target": "com.amazonaws.lightsail#UnpeerVpc" }, { "target": "com.amazonaws.lightsail#UntagResource" }, { "target": "com.amazonaws.lightsail#UpdateBucket" }, { "target": "com.amazonaws.lightsail#UpdateBucketBundle" }, { "target": "com.amazonaws.lightsail#UpdateContainerService" }, { "target": "com.amazonaws.lightsail#UpdateDistribution" }, { "target": "com.amazonaws.lightsail#UpdateDistributionBundle" }, { "target": "com.amazonaws.lightsail#UpdateDomainEntry" }, { "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptions" }, { "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttribute" }, { "target": "com.amazonaws.lightsail#UpdateRelationalDatabase" }, { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters" } ], "traits": { "aws.api#service": { "sdkId": "Lightsail", "arnNamespace": "lightsail", "cloudFormationName": "Lightsail", "cloudTrailEventSource": "lightsail.amazonaws.com", "endpointPrefix": "lightsail" }, "aws.auth#sigv4": { "name": "lightsail" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n Command Line Interface (CLI), or SDKs. For more information about Lightsail\n concepts and tasks, see the Amazon Lightsail Developer Guide.

\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", "smithy.api#title": "Amazon Lightsail", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://lightsail-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://lightsail-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://lightsail.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://lightsail.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://lightsail.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://lightsail.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.lightsail#LoadBalancer": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer (my-load-balancer).

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the load balancer.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer. This code enables our support team to look up your Lightsail\n information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The date when your load balancer was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The AWS Region where your load balancer was created (us-east-2a). Lightsail\n automatically creates your load balancer across Availability Zones.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type (LoadBalancer.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "dnsName": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The DNS name of your Lightsail load balancer.

" } }, "state": { "target": "com.amazonaws.lightsail#LoadBalancerState", "traits": { "smithy.api#documentation": "

The status of your load balancer. Valid values are below.

" } }, "protocol": { "target": "com.amazonaws.lightsail#LoadBalancerProtocol", "traits": { "smithy.api#documentation": "

The protocol you have enabled for your load balancer. Valid values are below.

\n

You can't just have HTTP_HTTPS, but you can have just\n HTTP.

" } }, "publicPorts": { "target": "com.amazonaws.lightsail#PortList", "traits": { "smithy.api#documentation": "

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS,\n use port 443.

" } }, "healthCheckPath": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The path you specified to perform your health checks. If no path is specified, the load\n balancer tries to make a request to the default (root) page.

" } }, "instancePort": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The port where the load balancer will direct traffic to your Lightsail instances. For\n HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" } }, "instanceHealthSummary": { "target": "com.amazonaws.lightsail#InstanceHealthSummaryList", "traits": { "smithy.api#documentation": "

An array of InstanceHealthSummary objects describing the health of the load\n balancer.

" } }, "tlsCertificateSummaries": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList", "traits": { "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateSummary objects that provide additional information\n about the SSL/TLS certificates. For example, if true, the certificate is attached\n to the load balancer.

" } }, "configurationOptions": { "target": "com.amazonaws.lightsail#LoadBalancerConfigurationOptions", "traits": { "smithy.api#documentation": "

A string to string map of the configuration options for your load balancer. Valid values\n are listed below.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type of the load balancer.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

" } }, "httpsRedirectionEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" } }, "tlsPolicyName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

" } } }, "traits": { "smithy.api#documentation": "

Describes a load balancer.

" } }, "com.amazonaws.lightsail#LoadBalancerAttributeName": { "type": "enum", "members": { "HealthCheckPath": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HealthCheckPath" } }, "SessionStickinessEnabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SessionStickinessEnabled" } }, "SessionStickiness_LB_CookieDurationSeconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SessionStickiness_LB_CookieDurationSeconds" } }, "HttpsRedirectionEnabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HttpsRedirectionEnabled" } }, "TlsPolicyName": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TlsPolicyName" } } } }, "com.amazonaws.lightsail#LoadBalancerConfigurationOptions": { "type": "map", "key": { "target": "com.amazonaws.lightsail#LoadBalancerAttributeName" }, "value": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#LoadBalancerList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancer" } }, "com.amazonaws.lightsail#LoadBalancerMetricName": { "type": "enum", "members": { "ClientTLSNegotiationErrorCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" } }, "HealthyHostCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HealthyHostCount" } }, "UnhealthyHostCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnhealthyHostCount" } }, "HTTPCode_LB_4XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" } }, "HTTPCode_LB_5XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" } }, "HTTPCode_Instance_2XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" } }, "HTTPCode_Instance_3XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" } }, "HTTPCode_Instance_4XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" } }, "HTTPCode_Instance_5XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" } }, "InstanceResponseTime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InstanceResponseTime" } }, "RejectedConnectionCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RejectedConnectionCount" } }, "RequestCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequestCount" } } } }, "com.amazonaws.lightsail#LoadBalancerProtocol": { "type": "enum", "members": { "HTTP_HTTPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP_HTTPS" } }, "HTTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP" } } } }, "com.amazonaws.lightsail#LoadBalancerState": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active" } }, "Provisioning": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "provisioning" } }, "ActiveImpaired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "active_impaired" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failed" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknown" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificate": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate (my-certificate).

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to\n look up your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The time when you created your SSL/TLS certificate.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone where you created your\n certificate.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type (LoadBalancerTlsCertificate).

\n " } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The load balancer name where your SSL/TLS certificate is attached.

" } }, "isAttached": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" } }, "status": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus", "traits": { "smithy.api#documentation": "

The validation status of the SSL/TLS certificate. Valid values are below.

" } }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name for your SSL/TLS certificate.

" } }, "domainValidationRecords": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList", "traits": { "smithy.api#documentation": "

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the\n records.

" } }, "failureReason": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason", "traits": { "smithy.api#documentation": "

The validation failure reason, if any, of the certificate.

\n

The following failure reasons are possible:

\n " } }, "issuedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The time when the SSL/TLS certificate was issued.

" } }, "issuer": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The issuer of the certificate.

" } }, "keyAlgorithm": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The algorithm used to generate the key pair (the public and private key).

" } }, "notAfter": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate expires.

" } }, "notBefore": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the SSL/TLS certificate is first valid.

" } }, "renewalSummary": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary", "traits": { "smithy.api#documentation": "

An object that describes the status of the certificate renewal managed by\n Lightsail.

" } }, "revocationReason": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason", "traits": { "smithy.api#documentation": "

The reason the certificate was revoked. This value is present only when the certificate\n status is REVOKED.

" } }, "revokedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate was revoked. This value is present only when the\n certificate status is REVOKED.

" } }, "serial": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The serial number of the certificate.

" } }, "signatureAlgorithm": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The algorithm that was used to sign the certificate.

" } }, "subject": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the entity that is associated with the public key contained in the\n certificate.

" } }, "subjectAlternativeNames": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

An array of strings that specify the alternate domains (example2.com) and\n subdomains (blog.example.com) for the certificate.

" } } }, "traits": { "smithy.api#documentation": "

Describes a load balancer SSL/TLS certificate.

\n

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode", "traits": { "smithy.api#documentation": "

The status code for the automated DNS record creation.

\n

Following are the possible values:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message that describes the reason for the status code.

" } } }, "traits": { "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of the domain to validate domain\n ownership.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationStateCode": { "type": "enum", "members": { "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus": { "type": "enum", "members": { "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VALIDATION" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The fully qualified domain name in the certificate request.

" } }, "validationStatus": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", "traits": { "smithy.api#documentation": "

The status of the domain validation. Valid values are listed below.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the domain names on an SSL/TLS certificate that you will use to\n validate domain ownership.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOption" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

A fully qualified domain name in the certificate. For example,\n example.com.

" } }, "type": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The type of validation record. For example, CNAME for domain\n validation.

" } }, "value": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The value for that type.

" } }, "validationStatus": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainStatus", "traits": { "smithy.api#documentation": "

The validation status. Valid values are listed below.

" } }, "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The domain name against which your SSL/TLS certificate was validated.

" } }, "dnsRecordCreationState": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDnsRecordCreationState", "traits": { "smithy.api#documentation": "

An object that describes the state of the canonical name (CNAME) records that are\n automatically added by Lightsail to the DNS of a domain to validate domain\n ownership.

" } } }, "traits": { "smithy.api#documentation": "

Describes the validation record of each domain name in the SSL/TLS certificate.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecordList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationRecord" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateFailureReason": { "type": "enum", "members": { "NoAvailableContacts": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_AVAILABLE_CONTACTS" } }, "AdditionalVerificationRequired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADDITIONAL_VERIFICATION_REQUIRED" } }, "DomainNotAllowed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOMAIN_NOT_ALLOWED" } }, "InvalidPublicDomain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PUBLIC_DOMAIN" } }, "Other": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificate" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus": { "type": "enum", "members": { "PendingAutoRenewal": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_AUTO_RENEWAL" } }, "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VALIDATION" } }, "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalSummary": { "type": "structure", "members": { "renewalStatus": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateRenewalStatus", "traits": { "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " } }, "domainValidationOptions": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateDomainValidationOptionList", "traits": { "smithy.api#documentation": "

Contains information about the validation of each domain name in the certificate, as it\n pertains to Lightsail's managed renewal. This is different from the initial validation that\n occurs as a result of the RequestCertificate request.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the status of Lightsail's managed renewal for the\n certificate.

\n

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateRevocationReason": { "type": "enum", "members": { "Unspecified": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSPECIFIED" } }, "KeyCompromise": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEY_COMPROMISE" } }, "CaCompromise": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CA_COMPROMISE" } }, "AffiliationChanged": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFFILIATION_CHANGED" } }, "Superceded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERCEDED" } }, "CessationOfOperation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CESSATION_OF_OPERATION" } }, "CertificateHold": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CERTIFICATE_HOLD" } }, "RemoveFromCrl": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REMOVE_FROM_CRL" } }, "PrivilegeWithdrawn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVILEGE_WITHDRAWN" } }, "AACompromise": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "A_A_COMPROMISE" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateStatus": { "type": "enum", "members": { "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VALIDATION" } }, "Issued": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISSUED" } }, "Inactive": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "Expired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "ValidationTimedOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION_TIMED_OUT" } }, "Revoked": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKED" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "Unknown": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } } } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate.

" } }, "isAttached": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, the SSL/TLS certificate is attached to the Lightsail load\n balancer.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of SSL/TLS certificate metadata.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" } }, "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the TLS security policy.

" } }, "isDefault": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" } }, "description": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The description of the TLS security policy.

" } }, "protocols": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The protocols used in a given TLS security policy.

" } }, "ciphers": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

" } } }, "traits": { "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" } }, "com.amazonaws.lightsail#LogEvent": { "type": "structure", "members": { "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the database log event was created.

" } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message of the database log event.

" } } }, "traits": { "smithy.api#documentation": "

Describes a database log event.

" } }, "com.amazonaws.lightsail#LogEventList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#LogEvent" } }, "com.amazonaws.lightsail#MetricDatapoint": { "type": "structure", "members": { "average": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The average.

" } }, "maximum": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The maximum.

" } }, "minimum": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The minimum.

" } }, "sampleCount": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The sample count.

" } }, "sum": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The sum.

" } }, "timestamp": { "target": "com.amazonaws.lightsail#timestamp", "traits": { "smithy.api#documentation": "

The timestamp (1479816991.349).

" } }, "unit": { "target": "com.amazonaws.lightsail#MetricUnit", "traits": { "smithy.api#documentation": "

The unit.

" } } }, "traits": { "smithy.api#documentation": "

Describes the metric data point.

" } }, "com.amazonaws.lightsail#MetricDatapointList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#MetricDatapoint" } }, "com.amazonaws.lightsail#MetricName": { "type": "enum", "members": { "CPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CPUUtilization" } }, "NetworkIn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkIn" } }, "NetworkOut": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkOut" } }, "StatusCheckFailed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed" } }, "StatusCheckFailed_Instance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed_Instance" } }, "StatusCheckFailed_System": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StatusCheckFailed_System" } }, "ClientTLSNegotiationErrorCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ClientTLSNegotiationErrorCount" } }, "HealthyHostCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HealthyHostCount" } }, "UnhealthyHostCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UnhealthyHostCount" } }, "HTTPCode_LB_4XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_LB_4XX_Count" } }, "HTTPCode_LB_5XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_LB_5XX_Count" } }, "HTTPCode_Instance_2XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_2XX_Count" } }, "HTTPCode_Instance_3XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_3XX_Count" } }, "HTTPCode_Instance_4XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_4XX_Count" } }, "HTTPCode_Instance_5XX_Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPCode_Instance_5XX_Count" } }, "InstanceResponseTime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InstanceResponseTime" } }, "RejectedConnectionCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RejectedConnectionCount" } }, "RequestCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RequestCount" } }, "DatabaseConnections": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DatabaseConnections" } }, "DiskQueueDepth": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskQueueDepth" } }, "FreeStorageSpace": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FreeStorageSpace" } }, "NetworkReceiveThroughput": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkReceiveThroughput" } }, "NetworkTransmitThroughput": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkTransmitThroughput" } }, "FreeableMemory": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FreeableMemory" } }, "SwapUsage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SwapUsage" } }, "BurstCapacityTime": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BurstCapacityTime" } }, "BurstCapacityPercentage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BurstCapacityPercentage" } } } }, "com.amazonaws.lightsail#MetricPeriod": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 86400 } } }, "com.amazonaws.lightsail#MetricStatistic": { "type": "enum", "members": { "Minimum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Minimum" } }, "Maximum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Maximum" } }, "Sum": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Sum" } }, "Average": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Average" } }, "SampleCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SampleCount" } } } }, "com.amazonaws.lightsail#MetricStatisticList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#MetricStatistic" } }, "com.amazonaws.lightsail#MetricUnit": { "type": "enum", "members": { "Seconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Seconds" } }, "Microseconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Microseconds" } }, "Milliseconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Milliseconds" } }, "Bytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bytes" } }, "Kilobytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobytes" } }, "Megabytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabytes" } }, "Gigabytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabytes" } }, "Terabytes": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabytes" } }, "Bits": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bits" } }, "Kilobits": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobits" } }, "Megabits": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabits" } }, "Gigabits": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabits" } }, "Terabits": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabits" } }, "Percent": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Percent" } }, "Count": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Count" } }, "BytesSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bytes/Second" } }, "KilobytesSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobytes/Second" } }, "MegabytesSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabytes/Second" } }, "GigabytesSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabytes/Second" } }, "TerabytesSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabytes/Second" } }, "BitsSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bits/Second" } }, "KilobitsSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Kilobits/Second" } }, "MegabitsSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Megabits/Second" } }, "GigabitsSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Gigabits/Second" } }, "TerabitsSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Terabits/Second" } }, "CountSecond": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Count/Second" } }, "None": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "None" } } } }, "com.amazonaws.lightsail#MonitoredResourceInfo": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.lightsail#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being monitored.

" } }, "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail resource being monitored.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type of the resource being monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

" } } }, "traits": { "smithy.api#documentation": "

Describes resource being monitored by an alarm.

\n

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information,\n see Alarms\n in Amazon Lightsail.

" } }, "com.amazonaws.lightsail#MonthlyTransfer": { "type": "structure", "members": { "gbPerMonthAllocated": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The amount allocated per month (in GB).

" } } }, "traits": { "smithy.api#documentation": "

Describes the monthly data transfer in and out of your virtual private server (or\n instance).

" } }, "com.amazonaws.lightsail#NameServersUpdateState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#NameServersUpdateStateCode", "traits": { "smithy.api#documentation": "

The status code for the name servers update.

\n

Following are the possible values:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message that describes the reason for the status code.

" } } }, "traits": { "smithy.api#documentation": "

Describes the state of the name server records update made by Amazon Lightsail\n to an Amazon Route\u00a053 registered domain.

\n

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail\n Developer Guide.

" } }, "com.amazonaws.lightsail#NameServersUpdateStateCode": { "type": "enum", "members": { "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } } } }, "com.amazonaws.lightsail#NetworkProtocol": { "type": "enum", "members": { "TCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "tcp" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "all" } }, "UDP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "udp" } }, "ICMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "icmp" } }, "ICMPV6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "icmpv6" } } } }, "com.amazonaws.lightsail#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "\\S" } }, "com.amazonaws.lightsail#NotFoundException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when it cannot find a resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.lightsail#NotificationTriggerList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#AlarmState" } }, "com.amazonaws.lightsail#OpenInstancePublicPorts": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#OpenInstancePublicPortsRequest" }, "output": { "target": "com.amazonaws.lightsail#OpenInstancePublicPortsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol.

\n

The OpenInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/OpenInstancePublicPorts", "code": 200 } } }, "com.amazonaws.lightsail#OpenInstancePublicPortsRequest": { "type": "structure", "members": { "portInfo": { "target": "com.amazonaws.lightsail#PortInfo", "traits": { "smithy.api#documentation": "

An object to describe the ports to open for the specified instance.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which to open ports.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#OpenInstancePublicPortsResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#Operation": { "type": "structure", "members": { "id": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the operation.

" } }, "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the operation was initialized (1479816991.349).

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" } }, "isTerminal": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the operation is terminal.

" } }, "operationDetails": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Details about the operation (Debian-1GB-Ohio-1).

" } }, "operationType": { "target": "com.amazonaws.lightsail#OperationType", "traits": { "smithy.api#documentation": "

The type of operation.

" } }, "status": { "target": "com.amazonaws.lightsail#OperationStatus", "traits": { "smithy.api#documentation": "

The status of the operation.

" } }, "statusChangedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the status was changed (1479816991.349).

" } }, "errorCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The error code.

" } }, "errorDetails": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The error details.

" } } }, "traits": { "smithy.api#documentation": "

Describes the API operation.

" } }, "com.amazonaws.lightsail#OperationFailureException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when an operation fails to execute.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.lightsail#OperationList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Operation" } }, "com.amazonaws.lightsail#OperationStatus": { "type": "enum", "members": { "NotStarted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotStarted" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Started" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Completed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Completed" } }, "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Succeeded" } } } }, "com.amazonaws.lightsail#OperationType": { "type": "enum", "members": { "DeleteKnownHostKeys": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteKnownHostKeys" } }, "DeleteInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteInstance" } }, "CreateInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateInstance" } }, "StopInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StopInstance" } }, "StartInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StartInstance" } }, "RebootInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RebootInstance" } }, "OpenInstancePublicPorts": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OpenInstancePublicPorts" } }, "PutInstancePublicPorts": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PutInstancePublicPorts" } }, "CloseInstancePublicPorts": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloseInstancePublicPorts" } }, "AllocateStaticIp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AllocateStaticIp" } }, "ReleaseStaticIp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReleaseStaticIp" } }, "AttachStaticIp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AttachStaticIp" } }, "DetachStaticIp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DetachStaticIp" } }, "UpdateDomainEntry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateDomainEntry" } }, "DeleteDomainEntry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteDomainEntry" } }, "CreateDomain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateDomain" } }, "DeleteDomain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteDomain" } }, "CreateInstanceSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateInstanceSnapshot" } }, "DeleteInstanceSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteInstanceSnapshot" } }, "CreateInstancesFromSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateInstancesFromSnapshot" } }, "CreateLoadBalancer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateLoadBalancer" } }, "DeleteLoadBalancer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteLoadBalancer" } }, "AttachInstancesToLoadBalancer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AttachInstancesToLoadBalancer" } }, "DetachInstancesFromLoadBalancer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DetachInstancesFromLoadBalancer" } }, "UpdateLoadBalancerAttribute": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateLoadBalancerAttribute" } }, "CreateLoadBalancerTlsCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateLoadBalancerTlsCertificate" } }, "DeleteLoadBalancerTlsCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteLoadBalancerTlsCertificate" } }, "AttachLoadBalancerTlsCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AttachLoadBalancerTlsCertificate" } }, "CreateDisk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateDisk" } }, "DeleteDisk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteDisk" } }, "AttachDisk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AttachDisk" } }, "DetachDisk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DetachDisk" } }, "CreateDiskSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateDiskSnapshot" } }, "DeleteDiskSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteDiskSnapshot" } }, "CreateDiskFromSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateDiskFromSnapshot" } }, "CreateRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateRelationalDatabase" } }, "UpdateRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateRelationalDatabase" } }, "DeleteRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteRelationalDatabase" } }, "CreateRelationalDatabaseFromSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateRelationalDatabaseFromSnapshot" } }, "CreateRelationalDatabaseSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateRelationalDatabaseSnapshot" } }, "DeleteRelationalDatabaseSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteRelationalDatabaseSnapshot" } }, "UpdateRelationalDatabaseParameters": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateRelationalDatabaseParameters" } }, "StartRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StartRelationalDatabase" } }, "RebootRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RebootRelationalDatabase" } }, "StopRelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StopRelationalDatabase" } }, "EnableAddOn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EnableAddOn" } }, "DisableAddOn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DisableAddOn" } }, "PutAlarm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PutAlarm" } }, "GetAlarms": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetAlarms" } }, "DeleteAlarm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteAlarm" } }, "TestAlarm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TestAlarm" } }, "CreateContactMethod": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateContactMethod" } }, "GetContactMethods": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetContactMethods" } }, "SendContactMethodVerification": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SendContactMethodVerification" } }, "DeleteContactMethod": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteContactMethod" } }, "CreateDistribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateDistribution" } }, "UpdateDistribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateDistribution" } }, "DeleteDistribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteDistribution" } }, "ResetDistributionCache": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResetDistributionCache" } }, "AttachCertificateToDistribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AttachCertificateToDistribution" } }, "DetachCertificateFromDistribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DetachCertificateFromDistribution" } }, "UpdateDistributionBundle": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateDistributionBundle" } }, "SetIpAddressType": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SetIpAddressType" } }, "CreateCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateCertificate" } }, "DeleteCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteCertificate" } }, "CreateContainerService": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateContainerService" } }, "UpdateContainerService": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateContainerService" } }, "DeleteContainerService": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteContainerService" } }, "CreateContainerServiceDeployment": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateContainerServiceDeployment" } }, "CreateContainerServiceRegistryLogin": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateContainerServiceRegistryLogin" } }, "RegisterContainerImage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RegisterContainerImage" } }, "DeleteContainerImage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteContainerImage" } }, "CreateBucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateBucket" } }, "DeleteBucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteBucket" } }, "CreateBucketAccessKey": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreateBucketAccessKey" } }, "DeleteBucketAccessKey": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeleteBucketAccessKey" } }, "UpdateBucketBundle": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateBucketBundle" } }, "UpdateBucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateBucket" } }, "SetResourceAccessForBucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SetResourceAccessForBucket" } }, "UpdateInstanceMetadataOptions": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpdateInstanceMetadataOptions" } }, "StartGUISession": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StartGUISession" } }, "StopGUISession": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StopGUISession" } }, "SetupInstanceHttps": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SetupInstanceHttps" } }, "GetProfile": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GetProfile" } } } }, "com.amazonaws.lightsail#Origin": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the origin resource.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type of the origin resource (Instance).

" } }, "regionName": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The AWS Region name of the origin resource.

" } }, "protocolPolicy": { "target": "com.amazonaws.lightsail#OriginProtocolPolicyEnum", "traits": { "smithy.api#documentation": "

The protocol that your Amazon Lightsail distribution uses when establishing a connection\n with your origin to pull content.

" } }, "responseTimeout": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The amount of time, in seconds, that the distribution waits for a response after\n forwarding a request to the origin. The minimum timeout is 1 second, the maximum is 60\n seconds, and the default (if you don't specify otherwise) is 30 seconds.

" } }, "ipAddressType": { "target": "com.amazonaws.lightsail#OriginIpAddressTypeEnum", "traits": { "smithy.api#documentation": "

The IP address type that the distribution uses when connecting to the origin.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

" } }, "isPrivateOriginAccessEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies whether private origin access is enabled for the distribution's origin. With\n private origin access, the distribution can serve objects that aren't publicly accessible\n from a Lightsail bucket.

\n

This applies when you set the bucket's getObject access rule to\n private. It also applies when you set getObject to public\n but set individual objects to private.

" } } }, "traits": { "smithy.api#documentation": "

Describes the origin resource of an Amazon Lightsail content delivery network (CDN)\n distribution.

\n

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls\n content from an origin, caches it, and serves it to viewers via a worldwide network of edge\n servers.

" } }, "com.amazonaws.lightsail#OriginIpAddressTypeEnum": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "IPV6": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv6" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack" } } } }, "com.amazonaws.lightsail#OriginProtocolPolicyEnum": { "type": "enum", "members": { "HTTPOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "http-only" } }, "HTTPSOnly": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "https-only" } } } }, "com.amazonaws.lightsail#PartnerIdList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#NonEmptyString" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.lightsail#PartnerInfo": { "type": "structure", "members": { "enrolledAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the account was enrolled in the Lightsail partner program.

", "smithy.api#required": {} } }, "tierName": { "target": "com.amazonaws.lightsail#TierName", "traits": { "smithy.api#documentation": "

The tier of the partner membership.

" } }, "status": { "target": "com.amazonaws.lightsail#PartnerStatus", "traits": { "smithy.api#documentation": "

The status of the partner membership.

\n

The following statuses are possible:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An object that contains information about the Lightsail partner program membership of an\n Amazon Lightsail account.

" } }, "com.amazonaws.lightsail#PartnerStatus": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Suspended": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Suspended" } } } }, "com.amazonaws.lightsail#PasswordData": { "type": "structure", "members": { "ciphertext": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The encrypted password. Ciphertext will be an empty string if access to your new instance\n is not ready yet. When you create an instance, it can take up to 15 minutes for the instance\n to be ready.

\n \n

If you use the default key pair (LightsailDefaultKeyPair), the decrypted\n password will be available in the password field.

\n

If you are using a custom key pair, you need to use your own means of decryption.

\n

If you change the Administrator password on the instance, Lightsail will continue to\n return the original ciphertext value. When accessing the instance using RDP, you need to\n manually enter the Administrator password after changing it from the default.

\n
" } }, "keyPairName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the key pair that you used when creating your instance. If no key pair name\n was specified when creating the instance, Lightsail uses the default key pair\n (LightsailDefaultKeyPair).

\n

If you are using a custom key pair, you need to use your own means of decrypting your\n password using the ciphertext. Lightsail creates the ciphertext by encrypting\n your password with the public key part of this key pair.

" } } }, "traits": { "smithy.api#documentation": "

The password data for the Windows Server-based instance, including the ciphertext and the\n key pair name.

" } }, "com.amazonaws.lightsail#PeerVpc": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#PeerVpcRequest" }, "output": { "target": "com.amazonaws.lightsail#PeerVpcResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Peers the Lightsail VPC with the user's default VPC.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/PeerVpc", "code": 200 } } }, "com.amazonaws.lightsail#PeerVpcRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#PeerVpcResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#PendingMaintenanceAction": { "type": "structure", "members": { "action": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The type of pending database maintenance action.

" } }, "description": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Additional detail about the pending database maintenance action.

" } }, "currentApplyDate": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The effective date of the pending database maintenance action.

" } } }, "traits": { "smithy.api#documentation": "

Describes a pending database maintenance action.

" } }, "com.amazonaws.lightsail#PendingMaintenanceActionList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#PendingMaintenanceAction" } }, "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues": { "type": "structure", "members": { "masterUserPassword": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The password for the master user of the database.

" } }, "engineVersion": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The database engine version.

" } }, "backupRetentionEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled.

" } } }, "traits": { "smithy.api#documentation": "

Describes a pending database value modification.

" } }, "com.amazonaws.lightsail#Port": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": -1, "max": 65535 } } }, "com.amazonaws.lightsail#PortAccessType": { "type": "enum", "members": { "Public": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Public" } }, "Private": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Private" } } } }, "com.amazonaws.lightsail#PortInfo": { "type": "structure", "members": { "fromPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The first port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "toPort": { "target": "com.amazonaws.lightsail#Port", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The last port in a range of open ports on an instance.

\n

Allowed ports:

\n " } }, "protocol": { "target": "com.amazonaws.lightsail#NetworkProtocol", "traits": { "smithy.api#documentation": "

The IP protocol name.

\n

The name can be one of the following:

\n " } }, "cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol.

\n \n

The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to\n connect to an instance.

\n
\n

Examples:

\n \n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "ipv6Cidrs": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to\n connect to an instance through the ports, and the protocol. Only devices with an IPv6 address\n can connect to an instance through IPv6; otherwise, IPv4 should be used.

\n \n

The cidrs parameter lists the IPv4 addresses that are allowed to connect to\n an instance.

\n
\n

For more information about CIDR block notation, see Classless\n Inter-Domain Routing on Wikipedia.

" } }, "cidrListAliases": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

An alias that defines access for a preconfigured range of IP addresses.

\n

The only alias currently supported is lightsail-connect, which allows IP\n addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your\n instance.

" } } }, "traits": { "smithy.api#documentation": "

Describes ports to open on an instance, the IP addresses allowed to connect to the\n instance through the ports, and the protocol.

" } }, "com.amazonaws.lightsail#PortInfoList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#PortInfo" } }, "com.amazonaws.lightsail#PortInfoSourceType": { "type": "enum", "members": { "Default": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "Instance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSTANCE" } }, "None": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "Closed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED" } } } }, "com.amazonaws.lightsail#PortList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Port" } }, "com.amazonaws.lightsail#PortMap": { "type": "map", "key": { "target": "com.amazonaws.lightsail#string" }, "value": { "target": "com.amazonaws.lightsail#ContainerServiceProtocol" } }, "com.amazonaws.lightsail#PortState": { "type": "enum", "members": { "Open": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "open" } }, "Closed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "closed" } } } }, "com.amazonaws.lightsail#PricingUnit": { "type": "enum", "members": { "GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GB" } }, "Hrs": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Hrs" } }, "GBMo": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GB-Mo" } }, "Bundles": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bundles" } }, "Queries": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Queries" } } } }, "com.amazonaws.lightsail#PrivateRegistryAccess": { "type": "structure", "members": { "ecrImagePullerRole": { "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRole", "traits": { "smithy.api#documentation": "

An object that describes the activation status of the role that you can use to grant a\n Lightsail container service access to Amazon ECR private\n repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also\n listed.

" } } }, "traits": { "smithy.api#documentation": "

Describes the configuration for an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#PrivateRegistryAccessRequest": { "type": "structure", "members": { "ecrImagePullerRole": { "target": "com.amazonaws.lightsail#ContainerServiceECRImagePullerRoleRequest", "traits": { "smithy.api#documentation": "

An object to describe a request to activate or deactivate the role that you can use to\n grant an Amazon Lightsail container service access to Amazon Elastic Container Registry\n (Amazon ECR) private repositories.

" } } }, "traits": { "smithy.api#documentation": "

Describes a request to configure an Amazon Lightsail container service to\n access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#ProfileType": { "type": "enum", "members": { "Lightsailor": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Lightsailor" } }, "LightsailPartner": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LightsailPartner" } } } }, "com.amazonaws.lightsail#PutAlarm": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#PutAlarmRequest" }, "output": { "target": "com.amazonaws.lightsail#PutAlarmResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates or updates an alarm, and associates it with the specified metric.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

\n

When this action creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.

\n

When you update an existing alarm, its state is left unchanged, but the update completely\n overwrites the previous configuration of the alarm. The alarm is then evaluated with the\n updated configuration.

\n

The put alarm operation supports tag-based access control via request\n tags. For more information, see the Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/PutAlarm", "code": 200 } } }, "com.amazonaws.lightsail#PutAlarmRequest": { "type": "structure", "members": { "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the\n previous configuration of the alarm.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.lightsail#MetricName", "traits": { "smithy.api#documentation": "

The name of the metric to associate with the alarm.

\n

You can configure up to two alarms per metric.

\n

The following metrics are available for each resource type:

\n \n

For more information about these metrics, see Metrics available in Lightsail.

", "smithy.api#required": {} } }, "monitoredResourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail resource that will be monitored.

\n

Instances, load balancers, and relational databases are the only Lightsail resources\n that can currently be monitored by alarms.

", "smithy.api#required": {} } }, "comparisonOperator": { "target": "com.amazonaws.lightsail#ComparisonOperator", "traits": { "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic to the threshold.\n The specified statistic value is used as the first operand.

", "smithy.api#required": {} } }, "threshold": { "target": "com.amazonaws.lightsail#double", "traits": { "smithy.api#documentation": "

The value against which the specified statistic is compared.

", "smithy.api#required": {} } }, "evaluationPeriods": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of most recent periods over which data is compared to the specified threshold.\n If you are setting an \"M out of N\" alarm, this value (evaluationPeriods) is the\n N.

\n

If you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies the rolling period of time in which data\n points are evaluated.

\n

Each evaluation period is five minutes long. For example, specify an evaluation period of\n 24 to evaluate a metric over a rolling period of two hours.

\n

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation\n period of 288 (24 hours).

", "smithy.api#required": {} } }, "datapointsToAlarm": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of data points that must be not within the specified threshold to trigger the\n alarm. If you are setting an \"M out of N\" alarm, this value (datapointsToAlarm)\n is the M.

" } }, "treatMissingData": { "target": "com.amazonaws.lightsail#TreatMissingData", "traits": { "smithy.api#documentation": "

Sets how this alarm will handle missing data points.

\n

An alarm can treat missing data in the following ways:

\n \n

If treatMissingData is not specified, the default behavior of\n missing is used.

" } }, "contactProtocols": { "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" } }, "notificationTriggers": { "target": "com.amazonaws.lightsail#NotificationTriggerList", "traits": { "smithy.api#documentation": "

The alarm states that trigger a notification.

\n

An alarm has the following possible states:

\n \n

When you specify a notification trigger, the ALARM state must be specified.\n The INSUFFICIENT_DATA and OK states can be specified in addition to\n the ALARM state.

\n \n

The notification trigger defaults to ALARM if you don't specify this\n parameter.

" } }, "notificationEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the alarm is enabled.

\n

Notifications are enabled by default if you don't specify this parameter.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values to add to the alarm during create.

\n

Use the TagResource action to tag a resource after it's created.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#PutAlarmResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#PutInstancePublicPorts": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#PutInstancePublicPortsRequest" }, "output": { "target": "com.amazonaws.lightsail#PutInstancePublicPortsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses\n allowed to connect to the instance through the ports, and the protocol. This action also\n closes all currently open ports that are not included in the request. Include all of the ports\n and the protocols you want to open in your PutInstancePublicPortsrequest. Or use\n the OpenInstancePublicPorts action to open ports without closing currently open\n ports.

\n

The PutInstancePublicPorts action supports tag-based access control via\n resource tags applied to the resource identified by instanceName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/PutInstancePublicPorts", "code": 200 } } }, "com.amazonaws.lightsail#PutInstancePublicPortsRequest": { "type": "structure", "members": { "portInfos": { "target": "com.amazonaws.lightsail#PortInfoList", "traits": { "smithy.api#documentation": "

An array of objects to describe the ports to open for the specified instance.

", "smithy.api#required": {} } }, "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which to open ports.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#PutInstancePublicPortsResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#QueryStringObject": { "type": "structure", "members": { "option": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the distribution forwards and caches based on query strings.

" } }, "queryStringsAllowList": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The specific query strings that the distribution forwards to the origin.

\n

Your distribution will cache content based on the specified query strings.

\n

If the option parameter is true, then your distribution forwards all query\n strings, regardless of what you specify using the queryStringsAllowList\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Describes the query string parameters that an Amazon Lightsail content delivery network\n (CDN) distribution to bases caching on.

\n

For the query strings that you specify, your distribution caches separate versions of the\n specified content based on the query string values in viewer\n requests.

" } }, "com.amazonaws.lightsail#R53HostedZoneDeletionState": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode", "traits": { "smithy.api#documentation": "

The status code for the deletion state.

\n

Following are the possible values:

\n " } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message that describes the reason for the status code.

" } } }, "traits": { "smithy.api#documentation": "

Describes the deletion state of an Amazon Route\u00a053 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" } }, "com.amazonaws.lightsail#R53HostedZoneDeletionStateCode": { "type": "enum", "members": { "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTED" } } } }, "com.amazonaws.lightsail#RebootInstance": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#RebootInstanceRequest" }, "output": { "target": "com.amazonaws.lightsail#RebootInstanceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Restarts a specific instance.

\n

The reboot instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/RebootInstance", "code": 200 } } }, "com.amazonaws.lightsail#RebootInstanceRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance to reboot.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#RebootInstanceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#RebootRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#RebootRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#RebootRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Restarts a specific database in Amazon Lightsail.

\n

The reboot relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/RebootRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#RebootRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database to reboot.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#RebootRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#RecordState": { "type": "enum", "members": { "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Started" } }, "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Succeeded" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.lightsail#Region": { "type": "structure", "members": { "continentCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The continent code (NA, meaning North America).

" } }, "description": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The description of the Amazon Web Services Region (This region is recommended to\n serve users in the eastern United States and eastern Canada).

" } }, "displayName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The display name (Ohio).

" } }, "name": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The region name (us-east-2).

" } }, "availabilityZones": { "target": "com.amazonaws.lightsail#AvailabilityZoneList", "traits": { "smithy.api#documentation": "

The Availability Zones. Follows the format us-east-2a\n (case-sensitive).

" } }, "relationalDatabaseAvailabilityZones": { "target": "com.amazonaws.lightsail#AvailabilityZoneList", "traits": { "smithy.api#documentation": "

The Availability Zones for databases. Follows the format us-east-2a\n (case-sensitive).

" } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Web Services Region.

" } }, "com.amazonaws.lightsail#RegionList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Region" } }, "com.amazonaws.lightsail#RegionName": { "type": "enum", "members": { "US_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-east-1" } }, "US_EAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-east-2" } }, "US_WEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-1" } }, "US_WEST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "us-west-2" } }, "EU_WEST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-1" } }, "EU_WEST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-2" } }, "EU_WEST_3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-west-3" } }, "EU_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-central-1" } }, "EU_NORTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-north-1" } }, "EU_SOUTH_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eu-south-2" } }, "CA_CENTRAL_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ca-central-1" } }, "AP_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-east-1" } }, "AP_SOUTH_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-south-1" } }, "AP_SOUTHEAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-1" } }, "AP_SOUTHEAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-2" } }, "AP_NORTHEAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-1" } }, "AP_NORTHEAST_2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-northeast-2" } }, "AP_SOUTHEAST_3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-3" } }, "AP_SOUTHEAST_5": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ap-southeast-5" } }, "SA_EAST_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "sa-east-1" } } } }, "com.amazonaws.lightsail#RegionSetupInProgressException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

\n Regions\n and Availability Zones for Lightsail\n

" } }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.

" } } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when an operation is performed on resources in an opt-in\n Region that is currently being set up.

", "smithy.api#error": "client", "smithy.api#httpError": 428 } }, "com.amazonaws.lightsail#RegisterContainerImage": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#RegisterContainerImageRequest" }, "output": { "target": "com.amazonaws.lightsail#RegisterContainerImageResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Registers a container image to your Amazon Lightsail container service.

\n \n

This action is not required if you install and use the Lightsail Control\n (lightsailctl) plugin to push container images to your Lightsail container service. For\n more information, see Pushing and managing container images on your Amazon Lightsail container services\n in the Amazon Lightsail Developer Guide.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/images", "code": 200 } } }, "com.amazonaws.lightsail#RegisterContainerImageRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service for which to register a container image.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "label": { "target": "com.amazonaws.lightsail#ContainerLabel", "traits": { "smithy.api#documentation": "

The label for the container image when it's registered to the container service.

\n

Use a descriptive label that you can use to track the different versions of your\n registered container images.

\n

Use the GetContainerImages action to return the container images registered\n to a Lightsail container service. The label is the portion\n of the following image name example:

\n \n

If the name of your container service is mycontainerservice, and the label\n that you specify is mystaticwebsite, then the name of the registered container\n image will be :mycontainerservice.mystaticwebsite.1.

\n

The number at the end of these image name examples represents the version of the\n registered container image. If you push and register another container image to the same\n Lightsail container service, with the same label, then the version number for the new\n registered container image will be 2. If you push and register another container\n image, the version number will be 3, and so on.

", "smithy.api#required": {} } }, "digest": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The digest of the container image to be registered.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#RegisterContainerImageResult": { "type": "structure", "members": { "containerImage": { "target": "com.amazonaws.lightsail#ContainerImage", "traits": { "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { "type": "structure", "members": { "nameServersUpdateState": { "target": "com.amazonaws.lightsail#NameServersUpdateState", "traits": { "smithy.api#documentation": "

An object that describes the state of the name server records that are automatically added\n to the Route\u00a053 domain by Lightsail.

" } }, "r53HostedZoneDeletionState": { "target": "com.amazonaws.lightsail#R53HostedZoneDeletionState", "traits": { "smithy.api#documentation": "

Describes the deletion state of an Amazon Route\u00a053 hosted zone for a domain that is\n being automatically delegated to an Amazon Lightsail DNS zone.

" } } }, "traits": { "smithy.api#documentation": "

Describes the delegation state of an Amazon Route\u00a053 registered domain to Amazon Lightsail.

\n

When you delegate an Amazon Route\u00a053 registered domain to Lightsail,\n you can manage the DNS of the domain using a Lightsail DNS zone. You no longer\n use the Route\u00a053 hosted zone to manage the DNS of the domain. To delegate the\n domain, Lightsail automatically updates the domain's name servers in Route\u00a053 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route\u00a053 hosted zone for the\n domain.

\n

All of the following conditions must be true for automatic domain delegation to be\n successful:

\n \n

If automatic domain delegation fails, or if you manage the DNS of your domain using a\n service other than Route\u00a053, then you must manually add the Lightsail\n DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain\u2019s records in Amazon Lightsail\n in the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#RelationalDatabase": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The unique name of the database resource in Lightsail.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code for the database. Include this code in your email to support when you\n have questions about a database in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the database was created. Formatted in Unix time.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The Region name and Availability Zone where the database is located.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type for the database (for example,\n RelationalDatabase).

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "relationalDatabaseBlueprintId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The blueprint ID for the database. A blueprint describes the major engine version of a\n database.

" } }, "relationalDatabaseBundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The bundle ID for the database. A bundle describes the performance specifications for your\n database.

" } }, "masterDatabaseName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the master database created when the Lightsail database resource is\n created.

" } }, "hardware": { "target": "com.amazonaws.lightsail#RelationalDatabaseHardware", "traits": { "smithy.api#documentation": "

Describes the hardware of the database.

" } }, "state": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Describes the current state of the database.

" } }, "secondaryAvailabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Describes the secondary Availability Zone of a high availability database.

\n

The secondary database is used for failover support of a high availability\n database.

" } }, "backupRetentionEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether automated backup retention is enabled for the\n database.

" } }, "pendingModifiedValues": { "target": "com.amazonaws.lightsail#PendingModifiedRelationalDatabaseValues", "traits": { "smithy.api#documentation": "

Describes pending database value modifications.

" } }, "engine": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The database software (for example, MySQL).

" } }, "engineVersion": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The database engine version (for example, 5.7.23).

" } }, "latestRestorableTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The latest point in time to which the database can be restored. Formatted in Unix\n time.

" } }, "masterUsername": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The master user name of the database.

" } }, "parameterApplyStatus": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The status of parameter updates for the database.

" } }, "preferredBackupWindow": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created for the database (for\n example, 16:00-16:30).

" } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on the database.

\n

In the format ddd:hh24:mi-ddd:hh24:mi. For example,\n Tue:17:00-Tue:17:30.

" } }, "publiclyAccessible": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the database is publicly accessible.

" } }, "masterEndpoint": { "target": "com.amazonaws.lightsail#RelationalDatabaseEndpoint", "traits": { "smithy.api#documentation": "

The master endpoint for the database.

" } }, "pendingMaintenanceActions": { "target": "com.amazonaws.lightsail#PendingMaintenanceActionList", "traits": { "smithy.api#documentation": "

Describes the pending maintenance actions for the database.

" } }, "caCertificateIdentifier": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The certificate associated with the database.

" } } }, "traits": { "smithy.api#documentation": "

Describes a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseBlueprint": { "type": "structure", "members": { "blueprintId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID for the database blueprint.

" } }, "engine": { "target": "com.amazonaws.lightsail#RelationalDatabaseEngine", "traits": { "smithy.api#documentation": "

The database software of the database blueprint (for example, MySQL).

" } }, "engineVersion": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The database engine version for the database blueprint (for example,\n 5.7.23).

" } }, "engineDescription": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The description of the database engine for the database blueprint.

" } }, "engineVersionDescription": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The description of the database engine version for the database blueprint.

" } }, "isEngineDefault": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the engine version is the default for the database\n blueprint.

" } } }, "traits": { "smithy.api#documentation": "

Describes a database image, or blueprint. A blueprint describes the major engine version\n of a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseBlueprintList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabaseBlueprint" } }, "com.amazonaws.lightsail#RelationalDatabaseBundle": { "type": "structure", "members": { "bundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The ID for the database bundle.

" } }, "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name for the database bundle.

" } }, "price": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The cost of the database bundle in US currency.

" } }, "ramSizeInGb": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The amount of RAM in GB (for example, 2.0) for the database bundle.

" } }, "diskSizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk for the database bundle.

" } }, "transferPerMonthInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The data transfer rate per month in GB for the database bundle.

" } }, "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of virtual CPUs (vCPUs) for the database bundle.

" } }, "isEncrypted": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is encrypted.

" } }, "isActive": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the database bundle is active.

" } } }, "traits": { "smithy.api#documentation": "

Describes a database bundle. A bundle describes the performance specifications of the\n database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseBundleList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabaseBundle" } }, "com.amazonaws.lightsail#RelationalDatabaseEndpoint": { "type": "structure", "members": { "port": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

Specifies the port that the database is listening on.

" } }, "address": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Specifies the DNS address of the database.

" } } }, "traits": { "smithy.api#documentation": "

Describes an endpoint for a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseEngine": { "type": "enum", "members": { "MYSQL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "mysql" } } } }, "com.amazonaws.lightsail#RelationalDatabaseEvent": { "type": "structure", "members": { "resource": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The database that the database event relates to.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the database event was created.

" } }, "message": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The message of the database event.

" } }, "eventCategories": { "target": "com.amazonaws.lightsail#StringList", "traits": { "smithy.api#documentation": "

The category that the database event belongs to.

" } } }, "traits": { "smithy.api#documentation": "

Describes an event for a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseEventList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabaseEvent" } }, "com.amazonaws.lightsail#RelationalDatabaseHardware": { "type": "structure", "members": { "cpuCount": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The number of vCPUs for the database.

" } }, "diskSizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk for the database.

" } }, "ramSizeInGb": { "target": "com.amazonaws.lightsail#float", "traits": { "smithy.api#documentation": "

The amount of RAM in GB for the database.

" } } }, "traits": { "smithy.api#documentation": "

Describes the hardware of a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabase" } }, "com.amazonaws.lightsail#RelationalDatabaseMetricName": { "type": "enum", "members": { "CPUUtilization": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CPUUtilization" } }, "DatabaseConnections": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DatabaseConnections" } }, "DiskQueueDepth": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskQueueDepth" } }, "FreeStorageSpace": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FreeStorageSpace" } }, "NetworkReceiveThroughput": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkReceiveThroughput" } }, "NetworkTransmitThroughput": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NetworkTransmitThroughput" } }, "FreeableMemory": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FreeableMemory" } }, "SwapUsage": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SwapUsage" } } } }, "com.amazonaws.lightsail#RelationalDatabaseParameter": { "type": "structure", "members": { "allowedValues": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Specifies the valid range of values for the parameter.

" } }, "applyMethod": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Indicates when parameter updates are applied.

\n

Can be immediate or pending-reboot.

" } }, "applyType": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Specifies the engine-specific parameter type.

" } }, "dataType": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Specifies the valid data type for the parameter.

" } }, "description": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Provides a description of the parameter.

" } }, "isModifiable": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the parameter can be modified.

" } }, "parameterName": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Specifies the name of the parameter.

" } }, "parameterValue": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Specifies the value of the parameter.

" } } }, "traits": { "smithy.api#documentation": "

Describes the parameters of a database.

" } }, "com.amazonaws.lightsail#RelationalDatabaseParameterList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabaseParameter" } }, "com.amazonaws.lightsail#RelationalDatabasePasswordVersion": { "type": "enum", "members": { "CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CURRENT" } }, "PREVIOUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIOUS" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } } } }, "com.amazonaws.lightsail#RelationalDatabaseSnapshot": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the database snapshot.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database snapshot.

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code for the database snapshot. Include this code in your email to support\n when you have questions about a database snapshot in Lightsail. This code enables our\n support team to look up your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the database snapshot was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The Region name and Availability Zone where the database snapshot is located.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag keys and optional values for the resource. For more information about tags in\n Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "engine": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The software of the database snapshot (for example, MySQL)

" } }, "engineVersion": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The database engine version for the database snapshot (for example,\n 5.7.23).

" } }, "sizeInGb": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The size of the disk in GB (for example, 32) for the database\n snapshot.

" } }, "state": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The state of the database snapshot.

" } }, "fromRelationalDatabaseName": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the source database from which the database snapshot was created.

" } }, "fromRelationalDatabaseArn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database from which the database snapshot was\n created.

" } }, "fromRelationalDatabaseBundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID of the database from which the database snapshot was created.

" } }, "fromRelationalDatabaseBlueprintId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The blueprint ID of the database from which the database snapshot was created. A blueprint\n describes the major engine version of a database.

" } } }, "traits": { "smithy.api#documentation": "

Describes a database snapshot.

" } }, "com.amazonaws.lightsail#RelationalDatabaseSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#RelationalDatabaseSnapshot" } }, "com.amazonaws.lightsail#ReleaseStaticIp": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#ReleaseStaticIpRequest" }, "output": { "target": "com.amazonaws.lightsail#ReleaseStaticIpResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes a specific static IP from your account.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/ReleaseStaticIp", "code": 200 } } }, "com.amazonaws.lightsail#ReleaseStaticIpRequest": { "type": "structure", "members": { "staticIpName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP to delete.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#ReleaseStaticIpResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#RenewalStatus": { "type": "enum", "members": { "PendingAutoRenewal": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingAutoRenewal" } }, "PendingValidation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PendingValidation" } }, "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Success" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } } } }, "com.amazonaws.lightsail#RenewalStatusReason": { "type": "string" }, "com.amazonaws.lightsail#RenewalSummary": { "type": "structure", "members": { "domainValidationRecords": { "target": "com.amazonaws.lightsail#DomainValidationRecordList", "traits": { "smithy.api#documentation": "

An array of objects that describe the domain validation records of the certificate.

" } }, "renewalStatus": { "target": "com.amazonaws.lightsail#RenewalStatus", "traits": { "smithy.api#documentation": "

The renewal status of the certificate.

\n

The following renewal status are possible:

\n " } }, "renewalStatusReason": { "target": "com.amazonaws.lightsail#RenewalStatusReason", "traits": { "smithy.api#documentation": "

The reason for the renewal status of the certificate.

" } }, "updatedAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the certificate was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

" } }, "com.amazonaws.lightsail#RequestFailureReason": { "type": "string" }, "com.amazonaws.lightsail#ResetDistributionCache": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#ResetDistributionCacheRequest" }, "output": { "target": "com.amazonaws.lightsail#ResetDistributionCacheResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After resetting the cache, the next time a content request is made, your distribution\n pulls, serves, and caches it from the origin.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/ResetDistributionCache", "code": 200 } } }, "com.amazonaws.lightsail#ResetDistributionCacheRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to reset cache.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#ResetDistributionCacheResult": { "type": "structure", "members": { "status": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The status of the reset cache request.

" } }, "createTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp of the reset cache request (1479734909.17) in Unix time\n format.

" } }, "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#ResourceArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" } }, "com.amazonaws.lightsail#ResourceBucketAccess": { "type": "enum", "members": { "Allow": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "allow" } }, "Deny": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deny" } } } }, "com.amazonaws.lightsail#ResourceBudgetEstimate": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The type of resource the budget will track.

" } }, "costEstimates": { "target": "com.amazonaws.lightsail#CostEstimates", "traits": { "smithy.api#documentation": "

The cost estimate for the specified budget.

" } }, "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The estimate start time.

" } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The estimate end time.

" } } }, "traits": { "smithy.api#documentation": "

Describes the estimated cost or usage that a budget tracks.

" } }, "com.amazonaws.lightsail#ResourceLocation": { "type": "structure", "members": { "availabilityZone": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" } }, "regionName": { "target": "com.amazonaws.lightsail#RegionName", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region name.

" } } }, "traits": { "smithy.api#documentation": "

Describes the resource location.

" } }, "com.amazonaws.lightsail#ResourceName": { "type": "string", "traits": { "smithy.api#pattern": "^\\w[\\w\\-]*\\w$" } }, "com.amazonaws.lightsail#ResourceNameList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ResourceName" } }, "com.amazonaws.lightsail#ResourceReceivingAccess": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Lightsail resource type (for example, Instance).

" } } }, "traits": { "smithy.api#documentation": "

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

" } }, "com.amazonaws.lightsail#ResourceRecord": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The name of the record.

" } }, "type": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The DNS record type.

" } }, "value": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The value for the DNS record.

" } } }, "traits": { "smithy.api#documentation": "

Describes the domain name system (DNS) records to add to your domain's DNS to validate it\n for an Amazon Lightsail certificate.

" } }, "com.amazonaws.lightsail#ResourceType": { "type": "enum", "members": { "ContainerService": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ContainerService" } }, "Instance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Instance" } }, "StaticIp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "StaticIp" } }, "KeyPair": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KeyPair" } }, "InstanceSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InstanceSnapshot" } }, "Domain": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Domain" } }, "PeeredVpc": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PeeredVpc" } }, "LoadBalancer": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LoadBalancer" } }, "LoadBalancerTlsCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LoadBalancerTlsCertificate" } }, "Disk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disk" } }, "DiskSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DiskSnapshot" } }, "RelationalDatabase": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RelationalDatabase" } }, "RelationalDatabaseSnapshot": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RelationalDatabaseSnapshot" } }, "ExportSnapshotRecord": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ExportSnapshotRecord" } }, "CloudFormationStackRecord": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CloudFormationStackRecord" } }, "Alarm": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Alarm" } }, "ContactMethod": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ContactMethod" } }, "Distribution": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Distribution" } }, "Certificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Certificate" } }, "Bucket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Bucket" } } } }, "com.amazonaws.lightsail#ResourcesBudgetEstimate": { "type": "list", "member": { "target": "com.amazonaws.lightsail#ResourceBudgetEstimate" } }, "com.amazonaws.lightsail#RevocationReason": { "type": "string" }, "com.amazonaws.lightsail#SendContactMethodVerification": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#SendContactMethodVerificationRequest" }, "output": { "target": "com.amazonaws.lightsail#SendContactMethodVerificationResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n
", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/SendContactMethodVerification", "code": 200 } } }, "com.amazonaws.lightsail#SendContactMethodVerificationRequest": { "type": "structure", "members": { "protocol": { "target": "com.amazonaws.lightsail#ContactMethodVerificationProtocol", "traits": { "smithy.api#documentation": "

The protocol to verify, such as Email or SMS (text\n messaging).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#SendContactMethodVerificationResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#SensitiveNonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "\\S", "smithy.api#sensitive": {} } }, "com.amazonaws.lightsail#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.lightsail#SerialNumber": { "type": "string" }, "com.amazonaws.lightsail#ServiceException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

A general service exception.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.lightsail#Session": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The session name.

" } }, "url": { "target": "com.amazonaws.lightsail#SensitiveNonEmptyString", "traits": { "smithy.api#documentation": "

The session URL.

" } }, "isPrimary": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, this Boolean value indicates the primary session for the specified\n resource.

" } } }, "traits": { "smithy.api#documentation": "

Describes a web-based, remote graphical user interface (GUI), Amazon DCV session. The\n session is used to access a virtual computer\u2019s operating system or application.

" } }, "com.amazonaws.lightsail#Sessions": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Session" } }, "com.amazonaws.lightsail#SetIpAddressType": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#SetIpAddressTypeRequest" }, "output": { "target": "com.amazonaws.lightsail#SetIpAddressTypeResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Sets the IP address type for an Amazon Lightsail resource.

\n

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the\n specified resource. Alternately, you can use this action to disable dual-stack, and enable\n IPv4 only.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/SetIpAddressType", "code": 200 } } }, "com.amazonaws.lightsail#SetIpAddressTypeRequest": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type.

\n

The resource values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

\n
", "smithy.api#required": {} } }, "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource for which to set the IP address type.

", "smithy.api#required": {} } }, "ipAddressType": { "target": "com.amazonaws.lightsail#IpAddressType", "traits": { "smithy.api#documentation": "

The IP address type to set for the specified resource.

\n

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only,\n and dualstack for IPv4 and IPv6.

", "smithy.api#required": {} } }, "acceptBundleUpdate": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Required parameter to accept the instance bundle update when changing to, and from,\n IPv6-only.

\n \n

An instance bundle will change when switching from dual-stack or\n ipv4, to ipv6. It also changes when switching from\n ipv6, to dual-stack or ipv4.

\n

You must include this parameter in the command to update the bundle. For example, if you\n switch from dual-stack to ipv6, the bundle will be updated, and\n billing for the IPv6-only instance bundle begins immediately.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#SetIpAddressTypeResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#SetResourceAccessForBucket": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#SetResourceAccessForBucketRequest" }, "output": { "target": "com.amazonaws.lightsail#SetResourceAccessForBucketResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", "code": 200 } } }, "com.amazonaws.lightsail#SetResourceAccessForBucketRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance for which to set bucket access. The instance must be\n in a running or stopped state.

", "smithy.api#required": {} } }, "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket for which to set access to another Lightsail resource.

", "smithy.api#required": {} } }, "access": { "target": "com.amazonaws.lightsail#ResourceBucketAccess", "traits": { "smithy.api#documentation": "

The access setting.

\n

The following access settings are available:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#SetResourceAccessForBucketResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#SetupDomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 253 }, "smithy.api#pattern": "^[a-zA-Z0-9\\-]{1,63}(\\.[a-zA-Z0-9\\-]{1,63}){0,8}(\\.[a-zA-Z]{2,63})$" } }, "com.amazonaws.lightsail#SetupDomainNameList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#SetupDomainName" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.lightsail#SetupExecutionDetails": { "type": "structure", "members": { "command": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The command that was executed.

" } }, "dateTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp for when the request was run.

" } }, "name": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The name of the target resource.

" } }, "status": { "target": "com.amazonaws.lightsail#SetupStatus", "traits": { "smithy.api#documentation": "

The status of the SetupInstanceHttps request.

" } }, "standardError": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The text written by the command to stderr.

" } }, "standardOutput": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The text written by the command to stdout.

" } }, "version": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The current version of the script..

" } } }, "traits": { "smithy.api#documentation": "

Returns details about the commands that were run.

" } }, "com.amazonaws.lightsail#SetupExecutionDetailsList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#SetupExecutionDetails" } }, "com.amazonaws.lightsail#SetupHistory": { "type": "structure", "members": { "operationId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

A GUID that's used to identify the operation.

" } }, "request": { "target": "com.amazonaws.lightsail#SetupRequest", "traits": { "smithy.api#documentation": "

Information about the specified request.

" } }, "resource": { "target": "com.amazonaws.lightsail#SetupHistoryResource", "traits": { "smithy.api#documentation": "

The target resource name for the request.

" } }, "executionDetails": { "target": "com.amazonaws.lightsail#SetupExecutionDetailsList", "traits": { "smithy.api#documentation": "

Describes the full details of the request.

" } }, "status": { "target": "com.amazonaws.lightsail#SetupStatus", "traits": { "smithy.api#documentation": "

The status of the request.

" } } }, "traits": { "smithy.api#documentation": "

Returns a list of the commands that were ran on the target resource.

\n

The status of each command is also returned.

" } }, "com.amazonaws.lightsail#SetupHistoryPageToken": { "type": "string", "traits": { "smithy.api#length": { "min": 24, "max": 40 }, "smithy.api#pattern": "^[A-Za-z0-9+/=]+$" } }, "com.amazonaws.lightsail#SetupHistoryResource": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail resource.

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lightsail resource.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp for when the resource was created.

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation" }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The Lightsail resource type. For example, Instance.

" } } }, "traits": { "smithy.api#documentation": "

The Lightsail resource that SetupHistory was ran on.

" } }, "com.amazonaws.lightsail#SetupInstanceHttps": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#SetupInstanceHttpsRequest" }, "output": { "target": "com.amazonaws.lightsail#SetupInstanceHttpsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Creates an SSL/TLS certificate that secures traffic for your website. After the\n certificate is created, it is installed on the specified Lightsail instance.

\n

If you provide more than one domain name in the request, at least one name must be less\n than or equal to 63 characters in length.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/setup-instance-https", "code": 200 } } }, "com.amazonaws.lightsail#SetupInstanceHttpsRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance.

", "smithy.api#required": {} } }, "emailAddress": { "target": "com.amazonaws.lightsail#EmailAddress", "traits": { "smithy.api#documentation": "

The contact method for SSL/TLS certificate renewal alerts. You can enter one email\n address.

", "smithy.api#required": {} } }, "domainNames": { "target": "com.amazonaws.lightsail#SetupDomainNameList", "traits": { "smithy.api#documentation": "

The name of the domain and subdomains that were specified for the SSL/TLS\n certificate.

", "smithy.api#required": {} } }, "certificateProvider": { "target": "com.amazonaws.lightsail#CertificateProvider", "traits": { "smithy.api#documentation": "

The certificate authority that issues the SSL/TLS certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#SetupInstanceHttpsResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

The available API operations for SetupInstanceHttps.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#SetupRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the Lightsail instance.

" } }, "domainNames": { "target": "com.amazonaws.lightsail#SetupDomainNameList", "traits": { "smithy.api#documentation": "

The name of the domain and subdomains that the SSL/TLS certificate secures.

" } }, "certificateProvider": { "target": "com.amazonaws.lightsail#CertificateProvider", "traits": { "smithy.api#documentation": "

The Certificate Authority (CA) that issues the SSL/TLS certificate.

" } } }, "traits": { "smithy.api#documentation": "

Returns information that was submitted during the SetupInstanceHttps request.\n Email information is redacted for privacy.

" } }, "com.amazonaws.lightsail#SetupStatus": { "type": "enum", "members": { "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "succeeded" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failed" } }, "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "inProgress" } } } }, "com.amazonaws.lightsail#StartGUISession": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StartGUISessionRequest" }, "output": { "target": "com.amazonaws.lightsail#StartGUISessionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Initiates a graphical user interface (GUI) session that\u2019s used to access a virtual\n computer\u2019s operating system and application. The session will be active for 1 hour. Use this\n action to resume the session after it expires.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/start-gui-session", "code": 200 } } }, "com.amazonaws.lightsail#StartGUISessionRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StartGUISessionResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

The available API operations.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StartInstance": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StartInstanceRequest" }, "output": { "target": "com.amazonaws.lightsail#StartInstanceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance,\n use the reboot instance operation.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n
\n

The start instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/StartInstance", "code": 200 } } }, "com.amazonaws.lightsail#StartInstanceRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance (a virtual private server) to start.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StartInstanceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StartRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StartRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#StartRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database,\n use the reboot relational database operation.

\n

The start relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/StartRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#StartRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database to start.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StartRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StaticIp": { "type": "structure", "members": { "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the static IP (StaticIP-Ohio-EXAMPLE).

" } }, "arn": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the static IP\n (arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

" } }, "supportCode": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The support code. Include this code in your email to support when you have questions about\n an instance or another resource in Lightsail. This code enables our support team to look up\n your Lightsail information more easily.

" } }, "createdAt": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The timestamp when the static IP was created (1479735304.222).

" } }, "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { "smithy.api#documentation": "

The region and Availability Zone where the static IP was created.

" } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { "smithy.api#documentation": "

The resource type (usually StaticIp).

" } }, "ipAddress": { "target": "com.amazonaws.lightsail#IpAddress", "traits": { "smithy.api#documentation": "

The static IP address.

" } }, "attachedTo": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The instance where the static IP is attached\n (Amazon_Linux-1GB-Ohio-1).

" } }, "isAttached": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value indicating whether the static IP is attached.

" } } }, "traits": { "smithy.api#documentation": "

Describes a static IP.

" } }, "com.amazonaws.lightsail#StaticIpList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#StaticIp" } }, "com.amazonaws.lightsail#Status": { "type": "enum", "members": { "StartExpired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "startExpired" } }, "NotStarted": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "notStarted" } }, "Started": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "started" } }, "Starting": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "starting" } }, "Stopped": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopped" } }, "Stopping": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "stopping" } }, "SettingUpInstance": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "settingUpInstance" } }, "FailedInstanceCreation": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failedInstanceCreation" } }, "FailedStartingGUISession": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failedStartingGUISession" } }, "FailedStoppingGUISession": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "failedStoppingGUISession" } } } }, "com.amazonaws.lightsail#StatusType": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Inactive": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Inactive" } } } }, "com.amazonaws.lightsail#StopGUISession": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StopGUISessionRequest" }, "output": { "target": "com.amazonaws.lightsail#StopGUISessionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Terminates a web-based Amazon DCV session that\u2019s used to access a virtual computer\u2019s\n operating system or application. The session will close and any unsaved data will be\n lost.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/stop-gui-session", "code": 200 } } }, "com.amazonaws.lightsail#StopGUISessionRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The resource name.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StopGUISessionResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

The available API operations.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StopInstance": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StopInstanceRequest" }, "output": { "target": "com.amazonaws.lightsail#StopInstanceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Stops a specific Amazon Lightsail instance that is currently running.

\n \n

When you start a stopped instance, Lightsail assigns a new public IP address to the\n instance. To use the same IP address after stopping and starting an instance, create a\n static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

\n
\n

The stop instance operation supports tag-based access control via resource\n tags applied to the resource identified by instance name. For more information,\n see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/StopInstance", "code": 200 } } }, "com.amazonaws.lightsail#StopInstanceOnIdleRequest": { "type": "structure", "members": { "threshold": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The value to compare with the duration.

" } }, "duration": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The amount of idle time in minutes after which your virtual computer will automatically\n stop.

" } } }, "traits": { "smithy.api#documentation": "

Describes a request to create or edit the StopInstanceOnIdle add-on.

\n \n

This add-on only applies to Lightsail for Research resources.

\n
" } }, "com.amazonaws.lightsail#StopInstanceRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance (a virtual private server) to stop.

", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When set to True, forces a Lightsail instance that is stuck in a\n stopping state to stop.

\n \n

Only use the force parameter if your instance is stuck in the\n stopping state. In any other state, your instance should stop normally\n without adding this parameter to your API request.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StopInstanceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StopRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#StopRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#StopRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Stops a specific database that is currently running in Amazon Lightsail.

\n \n

If you don't manually start your database instance after it has been stopped for seven\n consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure\n that your database instance doesn't fall behind on any required maintenance updates.

\n
\n

The stop relational database operation supports tag-based access control via\n resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/StopRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#StopRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database to stop.

", "smithy.api#required": {} } }, "relationalDatabaseSnapshotName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your new database snapshot to be created before stopping your database.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#StopRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#StringList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#string" } }, "com.amazonaws.lightsail#StringMax256": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.lightsail#SubjectAlternativeNameList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#DomainName" } }, "com.amazonaws.lightsail#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.lightsail#TagKey", "traits": { "smithy.api#documentation": "

The key of the tag.

\n

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" } }, "value": { "target": "com.amazonaws.lightsail#TagValue", "traits": { "smithy.api#documentation": "

The value of the tag.

\n

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the\n following characters: + - = . _ : / @

" } } }, "traits": { "smithy.api#documentation": "

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

\n

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

" } }, "com.amazonaws.lightsail#TagKey": { "type": "string" }, "com.amazonaws.lightsail#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#TagKey" } }, "com.amazonaws.lightsail#TagList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#Tag" } }, "com.amazonaws.lightsail#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#TagResourceRequest" }, "output": { "target": "com.amazonaws.lightsail#TagResourceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a\n maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique\n per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

\n

The tag resource operation supports tag-based access control via request tags\n and resource tags applied to the resource identified by resource name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/TagResource", "code": 200 } } }, "com.amazonaws.lightsail#TagResourceRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource to which you are adding tags.

", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.lightsail#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" } }, "tags": { "target": "com.amazonaws.lightsail#TagList", "traits": { "smithy.api#documentation": "

The tag key and optional value.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#TagResourceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#TagValue": { "type": "string" }, "com.amazonaws.lightsail#TestAlarm": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#TestAlarmRequest" }, "output": { "target": "com.amazonaws.lightsail#TestAlarmResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification\n trigger is configured for the specified alarm, the test also sends a notification to the\n notification protocol (Email and/or SMS) configured for the\n alarm.

\n

An alarm is used to monitor a single metric for one of your resources. When a metric\n condition is met, the alarm can notify you by email, SMS text message, and a banner displayed\n on the Amazon Lightsail console. For more information, see Alarms\n in Amazon Lightsail.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/TestAlarm/{alarmName}", "code": 200 } } }, "com.amazonaws.lightsail#TestAlarmRequest": { "type": "structure", "members": { "alarmName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the alarm to test.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.lightsail#AlarmState", "traits": { "smithy.api#documentation": "

The alarm state to test.

\n

An alarm has the following possible states that can be tested:

\n ", "smithy.api#httpQuery": "state", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#TestAlarmResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#TierName": { "type": "enum", "members": { "Essential": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Essential" } }, "Growth": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Growth" } }, "Accelerate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Accelerate" } }, "Premier": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Premier" } } } }, "com.amazonaws.lightsail#TimeOfDay": { "type": "string", "traits": { "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" } }, "com.amazonaws.lightsail#TimePeriod": { "type": "structure", "members": { "start": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The beginning of the time period. The start date is inclusive. For example, if\n start is 2017-01-01, Lightsail for Research retrieves cost and usage data starting\n at 2017-01-01 up to the end date. The start date must be equal to or no later\n than the current date to avoid a validation error.

" } }, "end": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { "smithy.api#documentation": "

The end of the time period. The end date is exclusive. For example, if end is\n 2017-05-01, Lightsail for Research retrieves cost and usage data from the start date up to, but\n not including, 2017-05-01.

" } } }, "traits": { "smithy.api#documentation": "

Sets the start date and end date for retrieving a cost estimate. The start date is\n inclusive, but the end date is exclusive. For example, if start is\n 2017-01-01 and end is 2017-05-01, then the cost and\n usage data is retrieved from 2017-01-01 up to and including\n 2017-04-30 but not including 2017-05-01.

" } }, "com.amazonaws.lightsail#TreatMissingData": { "type": "enum", "members": { "Breaching": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "breaching" } }, "NotBreaching": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "notBreaching" } }, "Ignore": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ignore" } }, "Missing": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "missing" } } } }, "com.amazonaws.lightsail#UnauthenticatedException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.lightsail#string" }, "docs": { "target": "com.amazonaws.lightsail#string" }, "message": { "target": "com.amazonaws.lightsail#string" }, "tip": { "target": "com.amazonaws.lightsail#string" } }, "traits": { "smithy.api#documentation": "

Lightsail throws this exception when the user has not been authenticated.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.lightsail#UnpeerVpc": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UnpeerVpcRequest" }, "output": { "target": "com.amazonaws.lightsail#UnpeerVpcResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Unpeers the Lightsail VPC from the user's default VPC.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UnpeerVpc", "code": 200 } } }, "com.amazonaws.lightsail#UnpeerVpcRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UnpeerVpcResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UntagResourceRequest" }, "output": { "target": "com.amazonaws.lightsail#UntagResourceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail\n resource.

\n

The untag resource operation supports tag-based access control via request\n tags and resource tags applied to the resource identified by resource name. For\n more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UntagResource", "code": 200 } } }, "com.amazonaws.lightsail#UntagResourceRequest": { "type": "structure", "members": { "resourceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the resource from which you are removing a tag.

", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.lightsail#ResourceArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" } }, "tagKeys": { "target": "com.amazonaws.lightsail#TagKeyList", "traits": { "smithy.api#documentation": "

The tag keys to delete from the specified resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UntagResourceResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateBucket": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateBucketRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateBucketResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateBucket", "code": 200 } } }, "com.amazonaws.lightsail#UpdateBucketBundle": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateBucketBundleRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateBucketBundleResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

\n

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a\n bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services\n billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The\n ableToUpdateBundle parameter in the response will indicate whether you can\n currently update a bucket's bundle.

\n

Update a bucket's bundle if it's consistently going over its storage space or data\n transfer quota, or if a bucket's usage is consistently in the lower range of its storage space\n or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might\n experience, we strongly recommend that you update a bucket's bundle only as a long-term\n strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle\n that will provide the bucket with ample storage space and data transfer for a long time to\n come.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateBucketBundle", "code": 200 } } }, "com.amazonaws.lightsail#UpdateBucketBundleRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket for which to update the bundle.

", "smithy.api#required": {} } }, "bundleId": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

The ID of the new bundle to apply to the bucket.

\n

Use the GetBucketBundles action to get a list of\n bundle IDs that you can specify.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateBucketBundleResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateBucketRequest": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { "smithy.api#documentation": "

The name of the bucket to update.

", "smithy.api#required": {} } }, "accessRules": { "target": "com.amazonaws.lightsail#AccessRules", "traits": { "smithy.api#documentation": "

An object that sets the public accessibility of objects in the specified bucket.

" } }, "versioning": { "target": "com.amazonaws.lightsail#NonEmptyString", "traits": { "smithy.api#documentation": "

Specifies whether to enable or suspend versioning of objects in the bucket.

\n

The following options can be specified:

\n " } }, "readonlyAccessAccounts": { "target": "com.amazonaws.lightsail#PartnerIdList", "traits": { "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" } }, "accessLogConfig": { "target": "com.amazonaws.lightsail#BucketAccessLogConfig", "traits": { "smithy.api#documentation": "

An object that describes the access log configuration for the bucket.

" } }, "cors": { "target": "com.amazonaws.lightsail#BucketCorsConfig", "traits": { "smithy.api#documentation": "

Sets the cross-origin resource sharing (CORS) configuration for your bucket. If a CORS configuration exists, it is replaced with the specified configuration. For AWS CLI operations, this parameter can also be passed as a file. For more information, see Configuring cross-origin resource sharing (CORS).

\n \n

CORS information is only returned in a response when you update the CORS policy.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateBucketResult": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.lightsail#Bucket", "traits": { "smithy.api#documentation": "

An object that describes the bucket that is updated.

" } }, "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateContainerService": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateContainerServiceRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateContainerServiceResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration of your Amazon Lightsail container service, such as its power,\n scale, and public domain names.

", "smithy.api#http": { "method": "PATCH", "uri": "/ls/api/2016-11-28/container-services/{serviceName}", "code": 200 } } }, "com.amazonaws.lightsail#UpdateContainerServiceRequest": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { "smithy.api#documentation": "

The name of the container service to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "power": { "target": "com.amazonaws.lightsail#ContainerServicePowerName", "traits": { "smithy.api#documentation": "

The power for the container service.

\n

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the\n container service. The power and scale of a container service makes\n up its configured capacity. To determine the monthly price of your container service, multiply\n the base price of the power with the scale (the number of nodes) of\n the service.

\n

Use the GetContainerServicePowers action to view the specifications of each\n power option.

" } }, "scale": { "target": "com.amazonaws.lightsail#ContainerServiceScale", "traits": { "smithy.api#documentation": "

The scale for the container service.

\n

The scale specifies the allocated compute nodes of the container service. The\n power and scale of a container service makes up its configured\n capacity. To determine the monthly price of your container service, multiply the base price of\n the power with the scale (the number of nodes) of the\n service.

" } }, "isDisabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

A Boolean value to indicate whether the container service is disabled.

" } }, "publicDomainNames": { "target": "com.amazonaws.lightsail#ContainerServicePublicDomains", "traits": { "smithy.api#documentation": "

The public domain names to use with the container service, such as\n example.com and www.example.com.

\n

You can specify up to four public domain names for a container service. The domain names\n that you specify are used when you create a deployment with a container configured as the\n public endpoint of your container service.

\n

If you don't specify public domain names, then you can use the default domain of the\n container service.

\n \n

You must create and validate an SSL/TLS certificate before you can use public domain\n names with your container service. Use the CreateCertificate action to create a\n certificate for the public domain names you want to use with your container service.

\n
\n

You can specify public domain names using a string to array map as shown in the example\n later on this page.

" } }, "privateRegistryAccess": { "target": "com.amazonaws.lightsail#PrivateRegistryAccessRequest", "traits": { "smithy.api#documentation": "

An object to describe the configuration for the container service to access private\n container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private\n repositories.

\n

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateContainerServiceResult": { "type": "structure", "members": { "containerService": { "target": "com.amazonaws.lightsail#ContainerService", "traits": { "smithy.api#documentation": "

An object that describes a container service.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDistribution": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateDistributionRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateDistributionResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

\n

Use this action to update the configuration of your existing distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateDistribution", "code": 200 } } }, "com.amazonaws.lightsail#UpdateDistributionBundle": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateDistributionBundleRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateDistributionBundleResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", "code": 200 } } }, "com.amazonaws.lightsail#UpdateDistributionBundleRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution for which to update the bundle.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

" } }, "bundleId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The bundle ID of the new bundle to apply to your distribution.

\n

Use the GetDistributionBundles action to get a list of distribution bundle\n IDs that you can specify.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateDistributionBundleResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDistributionRequest": { "type": "structure", "members": { "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the distribution to update.

\n

Use the GetDistributions action to get a list of distribution names that you\n can specify.

", "smithy.api#required": {} } }, "origin": { "target": "com.amazonaws.lightsail#InputOrigin", "traits": { "smithy.api#documentation": "

An object that describes the origin resource for the distribution, such as a Lightsail\n instance, bucket, or load balancer.

\n

The distribution pulls, caches, and serves content from the origin.

" } }, "defaultCacheBehavior": { "target": "com.amazonaws.lightsail#CacheBehavior", "traits": { "smithy.api#documentation": "

An object that describes the default cache behavior for the distribution.

" } }, "cacheBehaviorSettings": { "target": "com.amazonaws.lightsail#CacheSettings", "traits": { "smithy.api#documentation": "

An object that describes the cache behavior settings for the distribution.

\n \n

The cacheBehaviorSettings specified in your\n UpdateDistributionRequest will replace your distribution's existing\n settings.

\n
" } }, "cacheBehaviors": { "target": "com.amazonaws.lightsail#CacheBehaviorList", "traits": { "smithy.api#documentation": "

An array of objects that describe the per-path cache behavior for the distribution.

" } }, "isEnabled": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether to enable the distribution.

" } }, "viewerMinimumTlsProtocolVersion": { "target": "com.amazonaws.lightsail#ViewerMinimumTlsProtocolVersionEnum", "traits": { "smithy.api#documentation": "

Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate\n that's attached to the distribution.

" } }, "certificateName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the SSL/TLS certificate that you want to attach to the distribution.

\n

Only certificates with a status of ISSUED can be attached to a\n distribution.

\n

Use the GetCertificates\n action to get a list of certificate names that you can specify.

" } }, "useDefaultCertificate": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Indicates whether the default SSL/TLS certificate is attached to the distribution. The\n default value is true. When true, the distribution uses the default\n domain name such as d111111abcdef8.cloudfront.net.

\n

Set this value to false to attach a new certificate to the\n distribution.

" } }, "enablePrivateOriginAccess": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies whether to enable private origin access for the distribution. With private\n origin access, the distribution can serve objects that aren't publicly accessible from a\n Lightsail bucket.

\n

Lightsail grants the distribution permission to read the bucket's objects. Enabling\n private origin access doesn't change the bucket's access settings, and you can still\n retrieve publicly accessible objects directly from the bucket's endpoint.

\n \n

When you include this parameter, you must also include the origin parameter\n with the resource name, even if the origin is not changing.

\n

You can enable private origin access only when the distribution's origin is a\n Lightsail bucket. If the origin is another resource type, the request fails.

\n
" } }, "defaultRootObject": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The object (for example, index.html) that the distribution returns when a\n viewer requests the root URL of the distribution (/) instead of a specific\n object. The object that you specify must be available from the origin.

" } }, "customErrorResponses": { "target": "com.amazonaws.lightsail#DistributionCustomErrorResponseList", "traits": { "smithy.api#documentation": "

An array of objects that describe the custom error responses for the distribution. With a\n custom error response, you can specify the page to return when the origin responds with a\n given HTTP error code. You can also specify the HTTP status code to send to the viewer.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateDistributionResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDomainEntry": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateDomainEntryRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateDomainEntryResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates a domain recordset after it is created.

\n

The update domain entry operation supports tag-based access control via\n resource tags applied to the resource identified by domain name. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateDomainEntry", "code": 200 } } }, "com.amazonaws.lightsail#UpdateDomainEntryRequest": { "type": "structure", "members": { "domainName": { "target": "com.amazonaws.lightsail#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain recordset to update.

", "smithy.api#required": {} } }, "domainEntry": { "target": "com.amazonaws.lightsail#DomainEntry", "traits": { "smithy.api#documentation": "

An array of key-value pairs containing information about the domain entry.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateDomainEntryResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Modifies the Amazon Lightsail instance metadata parameters on a running or stopped\n instance. When you modify the parameters on a running instance, the GetInstance\n or GetInstances API operation initially responds with a state of\n pending. After the parameter modifications are successfully applied, the state\n changes to applied in subsequent GetInstance or\n GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateInstanceMetadataOptions", "code": 200 } } }, "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsRequest": { "type": "structure", "members": { "instanceName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the instance for which to update metadata parameters.

", "smithy.api#required": {} } }, "httpTokens": { "target": "com.amazonaws.lightsail#HttpTokens", "traits": { "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose whether to retrieve instance\n metadata with a signed token header on your request. If you retrieve the IAM role credentials\n without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role\n credentials by using a valid signed token, the version 2.0 role credentials are\n returned.

\n

If the state is required, you must send a signed token header with all\n instance metadata retrieval requests. In this state, retrieving the IAM role credential always\n returns the version 2.0 credentials. The version 1.0 credentials are not available.

" } }, "httpEndpoint": { "target": "com.amazonaws.lightsail#HttpEndpoint", "traits": { "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not\n specified, the existing state is maintained.

\n

If you specify a value of disabled, you cannot access your instance\n metadata.

" } }, "httpPutResponseHopLimit": { "target": "com.amazonaws.lightsail#integer", "traits": { "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. A larger number\n means that the instance metadata requests can travel farther. If no parameter is specified,\n the existing state is maintained.

" } }, "httpProtocolIpv6": { "target": "com.amazonaws.lightsail#HttpProtocolIpv6", "traits": { "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service. This setting\n applies only when the HTTP metadata endpoint is enabled.

\n \n

This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (eu-north-1).

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateInstanceMetadataOptionsResult": { "type": "structure", "members": { "operation": { "target": "com.amazonaws.lightsail#Operation", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Updates the specified attribute for a load balancer. You can only update one attribute at\n a time.

\n

The update load balancer attribute operation supports tag-based access\n control via resource tags applied to the resource identified by load balancer\n name. For more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateLoadBalancerAttribute", "code": 200 } } }, "com.amazonaws.lightsail#UpdateLoadBalancerAttributeRequest": { "type": "structure", "members": { "loadBalancerName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of the load balancer that you want to modify\n (my-load-balancer.

", "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", "traits": { "smithy.api#documentation": "

The name of the attribute you want to update.

", "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.lightsail#StringMax256", "traits": { "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateLoadBalancerAttributeResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabase": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Allows the update of one or more attributes of a database in Amazon Lightsail.

\n

Updates are applied immediately, or in cases where the updates could result in an outage,\n are applied during the database's predefined maintenance window.

\n

The update relational database operation supports tag-based access control\n via resource tags applied to the resource identified by relationalDatabaseName. For more\n information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateRelationalDatabase", "code": 200 } } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseParameters": { "type": "operation", "input": { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest" }, "output": { "target": "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult" }, "errors": [ { "target": "com.amazonaws.lightsail#AccessDeniedException" }, { "target": "com.amazonaws.lightsail#AccountSetupInProgressException" }, { "target": "com.amazonaws.lightsail#InvalidInputException" }, { "target": "com.amazonaws.lightsail#NotFoundException" }, { "target": "com.amazonaws.lightsail#OperationFailureException" }, { "target": "com.amazonaws.lightsail#RegionSetupInProgressException" }, { "target": "com.amazonaws.lightsail#ServiceException" }, { "target": "com.amazonaws.lightsail#UnauthenticatedException" } ], "traits": { "smithy.api#documentation": "

Allows the update of one or more parameters of a database in Amazon Lightsail.

\n

Parameter updates don't cause outages; therefore, their application is not subject to the\n preferred maintenance window. However, there are two ways in which parameter updates are\n applied: dynamic or pending-reboot. Parameters marked with a\n dynamic apply type are applied immediately. Parameters marked with a\n pending-reboot apply type are applied only after the database is rebooted using\n the reboot relational database operation.

\n

The update relational database parameters operation supports tag-based access\n control via resource tags applied to the resource identified by relationalDatabaseName. For\n more information, see the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateRelationalDatabaseParameters", "code": 200 } } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your database for which to update parameters.

", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.lightsail#RelationalDatabaseParameterList", "traits": { "smithy.api#documentation": "

The database parameters to update.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseParametersResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { "type": "structure", "members": { "relationalDatabaseName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { "smithy.api#documentation": "

The name of your Lightsail database resource to update.

", "smithy.api#required": {} } }, "masterUserPassword": { "target": "com.amazonaws.lightsail#SensitiveString", "traits": { "smithy.api#documentation": "

The password for the master user. The password can include any printable ASCII character\n except \"/\", \"\"\", or \"@\".

\n

MySQL\n

\n

Constraints: Must contain from 8 to 41 characters.

\n

\n PostgreSQL\n

\n

Constraints: Must contain from 8 to 128 characters.

" } }, "rotateMasterUserPassword": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, the master user password is changed to a new strong password\n generated by Lightsail.

\n

Use the get relational database master user password operation to get the new\n password.

" } }, "preferredBackupWindow": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created for your database if\n automated backups are enabled.

\n

Constraints:

\n " } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur on your database.

\n

The default is a 30-minute window selected at random from an 8-hour block of time for each\n Amazon Web Services Region, occurring on a random day of the week.

\n

Constraints:

\n " } }, "enableBackupRetention": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, enables automated backup retention for your database.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" } }, "disableBackupRetention": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, disables automated backup retention for your database.

\n

Disabling backup retention deletes all automated database backups. Before disabling this,\n you may want to create a snapshot of your database using the create relational database\n snapshot operation.

\n

Updates are applied during the next maintenance window because this can result in an\n outage.

" } }, "publiclyAccessible": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

Specifies the accessibility options for your database. A value of true\n specifies a database that is available to resources outside of your Lightsail account. A\n value of false specifies a database that is available only to your Lightsail\n resources in the same region as your database.

" } }, "applyImmediately": { "target": "com.amazonaws.lightsail#boolean", "traits": { "smithy.api#documentation": "

When true, applies changes immediately. When false, applies\n changes during the preferred maintenance window. Some changes may cause an outage.

\n

Default: false\n

" } }, "caCertificateIdentifier": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" } }, "relationalDatabaseBlueprintId": { "target": "com.amazonaws.lightsail#string", "traits": { "smithy.api#documentation": "

This parameter is used to update the major version of the database. Enter the\n blueprintId for the major version that you want to update to.

\n

Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint\n IDs.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseResult": { "type": "structure", "members": { "operations": { "target": "com.amazonaws.lightsail#OperationList", "traits": { "smithy.api#documentation": "

An array of objects that describe the result of the action, such as the status of the\n request, the timestamp of the request, and the resources affected by the request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.lightsail#ViewerMinimumTlsProtocolVersionEnum": { "type": "enum", "members": { "TLSv11_2016": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLSv1.1_2016" } }, "TLSv12_2018": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLSv1.2_2018" } }, "TLSv12_2019": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLSv1.2_2019" } }, "TLSv12_2021": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLSv1.2_2021" } } } }, "com.amazonaws.lightsail#boolean": { "type": "boolean" }, "com.amazonaws.lightsail#double": { "type": "double" }, "com.amazonaws.lightsail#float": { "type": "float" }, "com.amazonaws.lightsail#integer": { "type": "integer" }, "com.amazonaws.lightsail#long": { "type": "long" }, "com.amazonaws.lightsail#setupHistoryList": { "type": "list", "member": { "target": "com.amazonaws.lightsail#SetupHistory" } }, "com.amazonaws.lightsail#string": { "type": "string" }, "com.amazonaws.lightsail#timestamp": { "type": "timestamp" } } }