openapi: 3.2.0 info: title: Amazon Lightsail Domains API description: Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. version: '2016-11-28' contact: name: AWS Support url: https://aws.amazon.com/premiumsupport/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png x-generated-from: AWS Smithy 2.0 service model (https://github.com/aws/api-models-aws) — mechanical transform, no hand-authored operations servers: - url: https://lightsail.us-east-1.amazonaws.com description: Amazon Lightsail regional endpoint (us-east-1). Lightsail is regional — one endpoint per AWS Region, lightsail.{region}.amazonaws.com (IPv4) or lightsail.{region}.api.aws (dual-stack). See https://docs.aws.amazon.com/general/latest/gr/lightsail.html security: - sigv4: [] tags: - name: Domains paths: /ls/api/2016-11-28/CreateDomain: post: operationId: CreateDomain summary: Creates a domain resource for the specified domain (example.com) description: Creates a domain resource for the specified domain (example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide . tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateDomainRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateDomainResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.CreateDomain /ls/api/2016-11-28/CreateDomainEntry: post: operationId: CreateDomainEntry summary: Creates one of the following domain name system (DNS) records in a domain DNS… description: 'Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Amazon Lightsail Developer Guide .' tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateDomainEntryRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/CreateDomainEntryResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.CreateDomainEntry /ls/api/2016-11-28/DeleteDomain: post: operationId: DeleteDomain summary: Deletes the specified domain recordset and all of its domain records description: Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Amazon Lightsail Developer Guide . tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteDomainRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteDomainResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.DeleteDomain /ls/api/2016-11-28/DeleteDomainEntry: post: operationId: DeleteDomainEntry summary: Deletes a specific domain entry description: Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Amazon Lightsail Developer Guide . tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteDomainEntryRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/DeleteDomainEntryResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.DeleteDomainEntry /ls/api/2016-11-28/GetDomain: post: operationId: GetDomain summary: Returns information about a specific domain recordset description: Returns information about a specific domain recordset. tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/GetDomainRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/GetDomainResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.GetDomain /ls/api/2016-11-28/GetDomains: post: operationId: GetDomains summary: Returns a list of all domains in the user's account description: Returns a list of all domains in the user's account. tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/GetDomainsRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/GetDomainsResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.GetDomains /ls/api/2016-11-28/UpdateDomainEntry: post: operationId: UpdateDomainEntry summary: Updates a domain recordset after it is created description: Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name . For more information, see the Amazon Lightsail Developer Guide . tags: - Domains requestBody: required: true content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UpdateDomainEntryRequest' responses: '200': description: Success content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UpdateDomainEntryResult' '403': description: AccessDeniedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/AccessDeniedException' '428': description: AccountSetupInProgressException, RegionSetupInProgressException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/AccountSetupInProgressException' - $ref: '#/components/schemas/RegionSetupInProgressException' '400': description: InvalidInputException, OperationFailureException content: application/x-amz-json-1.1: schema: oneOf: - $ref: '#/components/schemas/InvalidInputException' - $ref: '#/components/schemas/OperationFailureException' '404': description: NotFoundException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/NotFoundException' '500': description: ServiceException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/ServiceException' '401': description: UnauthenticatedException content: application/x-amz-json-1.1: schema: $ref: '#/components/schemas/UnauthenticatedException' x-amz-target: Lightsail_20161128.UpdateDomainEntry components: schemas: NameServersUpdateState: type: object properties: code: allOf: - $ref: '#/components/schemas/NameServersUpdateStateCode' description: 'The status code for the name servers update. Following are the possible values: SUCCEEDED - The name server records were successfully updated. PENDING - The name server record update is in progress. FAILED - The name server record update failed. STARTED - The automatic name server record update started.' message: allOf: - $ref: '#/components/schemas/string' description: The message that describes the reason for the status code. description: Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain. For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide . CreateDomainResult: type: object properties: operation: allOf: - $ref: '#/components/schemas/Operation' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. AccessDeniedException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. ResourceName: type: string pattern: ^\w[\w\-]*\w$ NotFoundException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when it cannot find a resource. IsoDate: type: string format: date-time RegionSetupInProgressException: type: object properties: code: $ref: '#/components/schemas/string' docs: allOf: - $ref: '#/components/schemas/string' description: Regions and Availability Zones for Lightsail message: $ref: '#/components/schemas/string' tip: allOf: - $ref: '#/components/schemas/string' description: 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. description: Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up. GetDomainsResult: type: object properties: domains: allOf: - $ref: '#/components/schemas/DomainList' description: An array of key-value pairs containing information about each of the domain entries in the user's account. nextPageToken: allOf: - $ref: '#/components/schemas/string' description: The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter. CreateDomainEntryRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The domain name ( example.com ) for which you want to create the domain entry. domainEntry: allOf: - $ref: '#/components/schemas/DomainEntry' description: An array of key-value pairs containing information about the domain entry request. required: - domainName - domainEntry OperationList: type: array items: $ref: '#/components/schemas/Operation' TagKey: type: string InvalidInputException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( us-east-1 ) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources. GetDomainsRequest: type: object properties: pageToken: allOf: - $ref: '#/components/schemas/string' description: The token to advance to the next page of results from your request. To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. OperationFailureException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when an operation fails to execute. R53HostedZoneDeletionState: type: object properties: code: allOf: - $ref: '#/components/schemas/R53HostedZoneDeletionStateCode' description: 'The status code for the deletion state. Following are the possible values: SUCCEEDED - The hosted zone was successfully deleted. PENDING - The hosted zone deletion is in progress. FAILED - The hosted zone deletion failed. STARTED - The hosted zone deletion started.' message: allOf: - $ref: '#/components/schemas/string' description: The message that describes the reason for the status code. description: Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone. RegisteredDomainDelegationInfo: type: object properties: nameServersUpdateState: allOf: - $ref: '#/components/schemas/NameServersUpdateState' description: An object that describes the state of the name server records that are automatically added to the Route 53 domain by Lightsail. r53HostedZoneDeletionState: allOf: - $ref: '#/components/schemas/R53HostedZoneDeletionState' description: Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone. description: 'Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail. When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain''s name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain. All of the following conditions must be true for automatic domain delegation to be successful: The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request. The user or entity making the request must have permission to manage domains in Route 53. The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records. If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail 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’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide .' CreateDomainRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The domain name to manage ( example.com ). tags: allOf: - $ref: '#/components/schemas/TagList' description: The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. required: - domainName DeleteDomainRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The specific domain name to delete. required: - domainName RegionName: type: string enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-north-1 - eu-south-2 - ca-central-1 - ap-east-1 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - ap-northeast-1 - ap-northeast-2 - ap-southeast-3 - ap-southeast-5 - sa-east-1 DeleteDomainEntryRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The name of the domain entry to delete. domainEntry: allOf: - $ref: '#/components/schemas/DomainEntry' description: An array of key-value pairs containing information about your domain entries. required: - domainName - domainEntry DomainEntryType: type: string ResourceType: type: string enum: - ContainerService - Instance - StaticIp - KeyPair - InstanceSnapshot - Domain - PeeredVpc - LoadBalancer - LoadBalancerTlsCertificate - Disk - DiskSnapshot - RelationalDatabase - RelationalDatabaseSnapshot - ExportSnapshotRecord - CloudFormationStackRecord - Alarm - ContactMethod - Distribution - Certificate - Bucket TagList: type: array items: $ref: '#/components/schemas/Tag' AccountSetupInProgressException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when an account is still in the setup in progress state. Operation: type: object properties: id: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The ID of the operation. resourceName: allOf: - $ref: '#/components/schemas/ResourceName' description: The resource name. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' description: The resource type. createdAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The timestamp when the operation was initialized ( 1479816991.349 ). location: allOf: - $ref: '#/components/schemas/ResourceLocation' description: The Amazon Web Services Region and Availability Zone. isTerminal: allOf: - $ref: '#/components/schemas/boolean' description: A Boolean value indicating whether the operation is terminal. operationDetails: allOf: - $ref: '#/components/schemas/string' description: Details about the operation ( Debian-1GB-Ohio-1 ). operationType: allOf: - $ref: '#/components/schemas/OperationType' description: The type of operation. status: allOf: - $ref: '#/components/schemas/OperationStatus' description: The status of the operation. statusChangedAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The timestamp when the status was changed ( 1479816991.349 ). errorCode: allOf: - $ref: '#/components/schemas/string' description: The error code. errorDetails: allOf: - $ref: '#/components/schemas/string' description: The error details. description: Describes the API operation. string: type: string boolean: type: boolean UnauthenticatedException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: Lightsail throws this exception when the user has not been authenticated. ResourceLocation: type: object properties: availabilityZone: allOf: - $ref: '#/components/schemas/string' description: The Availability Zone. Follows the format us-east-2a (case-sensitive). regionName: allOf: - $ref: '#/components/schemas/RegionName' description: The Amazon Web Services Region name. description: Describes the resource location. DomainEntryOptions: type: object additionalProperties: $ref: '#/components/schemas/string' TagValue: type: string DomainEntryList: type: array items: $ref: '#/components/schemas/DomainEntry' DomainName: type: string UpdateDomainEntryResult: type: object properties: operations: allOf: - $ref: '#/components/schemas/OperationList' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. DomainList: type: array items: $ref: '#/components/schemas/Domain' Tag: type: object properties: key: allOf: - $ref: '#/components/schemas/TagKey' description: 'The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @' value: allOf: - $ref: '#/components/schemas/TagValue' description: 'The value of the tag. Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @' description: Describes a tag key and optional value assigned to an Amazon Lightsail resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide . GetDomainRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The domain name for which your want to return information about. required: - domainName NonEmptyString: type: string pattern: \S OperationType: type: string enum: - DeleteKnownHostKeys - DeleteInstance - CreateInstance - StopInstance - StartInstance - RebootInstance - OpenInstancePublicPorts - PutInstancePublicPorts - CloseInstancePublicPorts - AllocateStaticIp - ReleaseStaticIp - AttachStaticIp - DetachStaticIp - UpdateDomainEntry - DeleteDomainEntry - CreateDomain - DeleteDomain - CreateInstanceSnapshot - DeleteInstanceSnapshot - CreateInstancesFromSnapshot - CreateLoadBalancer - DeleteLoadBalancer - AttachInstancesToLoadBalancer - DetachInstancesFromLoadBalancer - UpdateLoadBalancerAttribute - CreateLoadBalancerTlsCertificate - DeleteLoadBalancerTlsCertificate - AttachLoadBalancerTlsCertificate - CreateDisk - DeleteDisk - AttachDisk - DetachDisk - CreateDiskSnapshot - DeleteDiskSnapshot - CreateDiskFromSnapshot - CreateRelationalDatabase - UpdateRelationalDatabase - DeleteRelationalDatabase - CreateRelationalDatabaseFromSnapshot - CreateRelationalDatabaseSnapshot - DeleteRelationalDatabaseSnapshot - UpdateRelationalDatabaseParameters - StartRelationalDatabase - RebootRelationalDatabase - StopRelationalDatabase - EnableAddOn - DisableAddOn - PutAlarm - GetAlarms - DeleteAlarm - TestAlarm - CreateContactMethod - GetContactMethods - SendContactMethodVerification - DeleteContactMethod - CreateDistribution - UpdateDistribution - DeleteDistribution - ResetDistributionCache - AttachCertificateToDistribution - DetachCertificateFromDistribution - UpdateDistributionBundle - SetIpAddressType - CreateCertificate - DeleteCertificate - CreateContainerService - UpdateContainerService - DeleteContainerService - CreateContainerServiceDeployment - CreateContainerServiceRegistryLogin - RegisterContainerImage - DeleteContainerImage - CreateBucket - DeleteBucket - CreateBucketAccessKey - DeleteBucketAccessKey - UpdateBucketBundle - UpdateBucket - SetResourceAccessForBucket - UpdateInstanceMetadataOptions - StartGUISession - StopGUISession - SetupInstanceHttps - GetProfile DomainEntry: type: object properties: id: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The ID of the domain recordset entry. name: allOf: - $ref: '#/components/schemas/DomainName' description: The name of the domain. target: allOf: - $ref: '#/components/schemas/string' description: The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net . For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com . Be sure to also set isAlias to true when setting up an A record for a Lightsail load balancer, distribution, or container service. isAlias: allOf: - $ref: '#/components/schemas/boolean' description: 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 resource. You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other Amazon Web Services resource and routes traffic to that resource. type: allOf: - $ref: '#/components/schemas/DomainEntryType' description: 'The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: A AAAA CNAME MX NS SOA SRV TXT' options: allOf: - $ref: '#/components/schemas/DomainEntryOptions' description: (Discontinued) The options for the domain entry. In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued. description: Describes a domain recordset entry. GetDomainResult: type: object properties: domain: allOf: - $ref: '#/components/schemas/Domain' description: An array of key-value pairs containing information about your get domain request. OperationStatus: type: string enum: - NotStarted - Started - Failed - Completed - Succeeded DeleteDomainResult: type: object properties: operation: allOf: - $ref: '#/components/schemas/Operation' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. Domain: type: object properties: name: allOf: - $ref: '#/components/schemas/ResourceName' description: The name of the domain. arn: allOf: - $ref: '#/components/schemas/NonEmptyString' description: The Amazon Resource Name (ARN) of the domain recordset ( arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ). supportCode: allOf: - $ref: '#/components/schemas/string' description: The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. createdAt: allOf: - $ref: '#/components/schemas/IsoDate' description: The date when the domain recordset was created. location: allOf: - $ref: '#/components/schemas/ResourceLocation' description: The AWS Region and Availability Zones where the domain recordset was created. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' description: The resource type. tags: allOf: - $ref: '#/components/schemas/TagList' description: The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide . domainEntries: allOf: - $ref: '#/components/schemas/DomainEntryList' description: An array of key-value pairs containing information about the domain entries. registeredDomainDelegationInfo: allOf: - $ref: '#/components/schemas/RegisteredDomainDelegationInfo' description: An object that describes the state of the Route 53 domain delegation to a Lightsail DNS zone. description: Describes a domain where you are storing recordsets. DeleteDomainEntryResult: type: object properties: operation: allOf: - $ref: '#/components/schemas/Operation' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. R53HostedZoneDeletionStateCode: type: string enum: - SUCCEEDED - PENDING - FAILED - STARTED UpdateDomainEntryRequest: type: object properties: domainName: allOf: - $ref: '#/components/schemas/DomainName' description: The name of the domain recordset to update. domainEntry: allOf: - $ref: '#/components/schemas/DomainEntry' description: An array of key-value pairs containing information about the domain entry. required: - domainName - domainEntry CreateDomainEntryResult: type: object properties: operation: allOf: - $ref: '#/components/schemas/Operation' description: An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. ServiceException: type: object properties: code: $ref: '#/components/schemas/string' docs: $ref: '#/components/schemas/string' message: $ref: '#/components/schemas/string' tip: $ref: '#/components/schemas/string' description: A general service exception. NameServersUpdateStateCode: type: string enum: - SUCCEEDED - PENDING - FAILED - STARTED securitySchemes: sigv4: type: apiKey name: Authorization in: header description: AWS Signature Version 4. Sign each request with IAM credentials for service name "lightsail"; the Authorization header carries the AWS4-HMAC-SHA256 credential scope, signed headers and signature. Temporary STS credentials additionally require X-Amz-Security-Token. See https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/CommonParameters.html externalDocs: description: Amazon Lightsail API Reference url: https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/Welcome.html