Lightsail / Client / delete_domain_entry

delete_domain_entry

Lightsail.Client.delete_domain_entry(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain_entry(
    domainName='string',
    domainEntry={
        'id': 'string',
        'name': 'string',
        'target': 'string',
        'isAlias': True|False,
        'type': 'string',
        'options': {
            'string': 'string'
        }
    }
)

Parameters:

• domainName (string) –

  [REQUIRED]

  The name of the domain entry to delete.

• domainEntry (dict) –

  [REQUIRED]

  An array of key-value pairs containing information about your domain entries.

  • id (string) –

    The ID of the domain recordset entry.

  • name (string) –

    The name of the domain.

  • target (string) –

    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 (boolean) –

    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 (string) –

    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 (dict) –

    (Discontinued) The options for the domain entry.

    Note

    In releases prior to November 29, 2017, this parameter was not included in the API response. It is now discontinued.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'operation': {
        'id': 'string',
        'resourceName': 'string',
        'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
        'createdAt': datetime(2015, 1, 1),
        'location': {
            'availabilityZone': 'string',
            'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'
        },
        'isTerminal': True|False,
        'operationDetails': 'string',
        'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
        'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
        'statusChangedAt': datetime(2015, 1, 1),
        'errorCode': 'string',
        'errorDetails': 'string'
    }
}

Response Structure

• (dict) –

  • operation (dict) –

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

    • id (string) –

      The ID of the operation.

    • resourceName (string) –

      The resource name.

    • resourceType (string) –

      The resource type.

    • createdAt (datetime) –

      The timestamp when the operation was initialized ( 1479816991.349).

    • location (dict) –

      The Amazon Web Services Region and Availability Zone.

      • availabilityZone (string) –

        The Availability Zone. Follows the format us-east-2a (case-sensitive).

      • regionName (string) –

        The Amazon Web Services Region name.

    • isTerminal (boolean) –

      A Boolean value indicating whether the operation is terminal.

    • operationDetails (string) –

      Details about the operation ( Debian-1GB-Ohio-1).

    • operationType (string) –

      The type of operation.

    • status (string) –

      The status of the operation.

    • statusChangedAt (datetime) –

      The timestamp when the status was changed ( 1479816991.349).

    • errorCode (string) –

      The error code.

    • errorDetails (string) –

      The error details.

Exceptions

• Lightsail.Client.exceptions.ServiceException

• Lightsail.Client.exceptions.InvalidInputException

• Lightsail.Client.exceptions.NotFoundException

• Lightsail.Client.exceptions.OperationFailureException

• Lightsail.Client.exceptions.AccessDeniedException

• Lightsail.Client.exceptions.AccountSetupInProgressException

• Lightsail.Client.exceptions.UnauthenticatedException