AllocateStaticIp

$result = $client->allocateStaticIp([/* ... */]);
$promise = $client->allocateStaticIpAsync([/* ... */]);

Allocates a static IP address.

Parameter Syntax

$result = $client->allocateStaticIp([
    'staticIpName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AttachCertificateToDistribution

$result = $client->attachCertificateToDistribution([/* ... */]);
$promise = $client->attachCertificateToDistributionAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->attachCertificateToDistribution([
    'certificateName' => '<string>', // REQUIRED
    'distributionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AttachDisk

$result = $client->attachDisk([/* ... */]);
$promise = $client->attachDiskAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->attachDisk([
    'autoMounting' => true || false,
    'diskName' => '<string>', // REQUIRED
    'diskPath' => '<string>', // REQUIRED
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AttachInstancesToLoadBalancer

$result = $client->attachInstancesToLoadBalancer([/* ... */]);
$promise = $client->attachInstancesToLoadBalancerAsync([/* ... */]);

Attaches one or more Lightsail instances to a load balancer.

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

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

Parameter Syntax

$result = $client->attachInstancesToLoadBalancer([
    'instanceNames' => ['<string>', ...], // REQUIRED
    'loadBalancerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AttachLoadBalancerTlsCertificate

$result = $client->attachLoadBalancerTlsCertificate([/* ... */]);
$promise = $client->attachLoadBalancerTlsCertificateAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->attachLoadBalancerTlsCertificate([
    'certificateName' => '<string>', // REQUIRED
    'loadBalancerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AttachStaticIp

$result = $client->attachStaticIp([/* ... */]);
$promise = $client->attachStaticIpAsync([/* ... */]);

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

Parameter Syntax

$result = $client->attachStaticIp([
    'instanceName' => '<string>', // REQUIRED
    'staticIpName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CloseInstancePublicPorts

$result = $client->closeInstancePublicPorts([/* ... */]);
$promise = $client->closeInstancePublicPortsAsync([/* ... */]);

Closes ports for a specific Amazon Lightsail instance.

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

Parameter Syntax

$result = $client->closeInstancePublicPorts([
    'instanceName' => '<string>', // REQUIRED
    'portInfo' => [ // REQUIRED
        'cidrListAliases' => ['<string>', ...],
        'cidrs' => ['<string>', ...],
        'fromPort' => <integer>,
        'ipv6Cidrs' => ['<string>', ...],
        'protocol' => 'tcp|all|udp|icmp|icmpv6',
        'toPort' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CopySnapshot

$result = $client->copySnapshot([/* ... */]);
$promise = $client->copySnapshotAsync([/* ... */]);

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be 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.

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

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

Parameter Syntax

$result = $client->copySnapshot([
    'restoreDate' => '<string>',
    'sourceRegion' => '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', // REQUIRED
    'sourceResourceName' => '<string>',
    'sourceSnapshotName' => '<string>',
    'targetSnapshotName' => '<string>', // REQUIRED
    'useLatestRestorableAutoSnapshot' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateBucket

$result = $client->createBucket([/* ... */]);
$promise = $client->createBucketAsync([/* ... */]);

Creates an Amazon Lightsail bucket.

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

Parameter Syntax

$result = $client->createBucket([
    'bucketName' => '<string>', // REQUIRED
    'bundleId' => '<string>', // REQUIRED
    'enableObjectVersioning' => true || false,
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'bucket' => [
        'ableToUpdateBundle' => true || false,
        'accessLogConfig' => [
            'destination' => '<string>',
            'enabled' => true || false,
            'prefix' => '<string>',
        ],
        'accessRules' => [
            'allowPublicOverrides' => true || false,
            'getObject' => 'public|private',
        ],
        'arn' => '<string>',
        'bundleId' => '<string>',
        'createdAt' => <DateTime>,
        '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',
        ],
        'name' => '<string>',
        'objectVersioning' => '<string>',
        'readonlyAccessAccounts' => ['<string>', ...],
        'resourceType' => '<string>',
        'resourcesReceivingAccess' => [
            [
                'name' => '<string>',
                'resourceType' => '<string>',
            ],
            // ...
        ],
        'state' => [
            'code' => '<string>',
            'message' => '<string>',
        ],
        'supportCode' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'url' => '<string>',
    ],
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

InvalidInputException:

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.

ServiceException:

A general service exception.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateBucketAccessKey

$result = $client->createBucketAccessKey([/* ... */]);
$promise = $client->createBucketAccessKeyAsync([/* ... */]);

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

Access keys grant full programmatic access to the specified bucket and its objects. You 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 information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->createBucketAccessKey([
    'bucketName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessKey' => [
        'accessKeyId' => '<string>',
        'createdAt' => <DateTime>,
        'lastUsed' => [
            'lastUsedDate' => <DateTime>,
            'region' => '<string>',
            'serviceName' => '<string>',
        ],
        'secretAccessKey' => '<string>',
        'status' => 'Active|Inactive',
    ],
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

InvalidInputException:

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.

ServiceException:

A general service exception.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateCertificate

$result = $client->createCertificate([/* ... */]);
$promise = $client->createCertificateAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createCertificate([
    'certificateName' => '<string>', // REQUIRED
    'domainName' => '<string>', // REQUIRED
    'subjectAlternativeNames' => ['<string>', ...],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'certificate' => [
        'certificateArn' => '<string>',
        'certificateDetail' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'domainName' => '<string>',
            'domainValidationRecords' => [
                [
                    'dnsRecordCreationState' => [
                        'code' => 'SUCCEEDED|STARTED|FAILED',
                        'message' => '<string>',
                    ],
                    'domainName' => '<string>',
                    'resourceRecord' => [
                        'name' => '<string>',
                        'type' => '<string>',
                        'value' => '<string>',
                    ],
                    'validationStatus' => 'PENDING_VALIDATION|FAILED|SUCCESS',
                ],
                // ...
            ],
            'eligibleToRenew' => '<string>',
            'inUseResourceCount' => <integer>,
            'issuedAt' => <DateTime>,
            'issuerCA' => '<string>',
            'keyAlgorithm' => '<string>',
            'name' => '<string>',
            'notAfter' => <DateTime>,
            'notBefore' => <DateTime>,
            'renewalSummary' => [
                'domainValidationRecords' => [
                    [
                        'dnsRecordCreationState' => [
                            'code' => 'SUCCEEDED|STARTED|FAILED',
                            'message' => '<string>',
                        ],
                        'domainName' => '<string>',
                        'resourceRecord' => [
                            'name' => '<string>',
                            'type' => '<string>',
                            'value' => '<string>',
                        ],
                        'validationStatus' => 'PENDING_VALIDATION|FAILED|SUCCESS',
                    ],
                    // ...
                ],
                'renewalStatus' => 'PendingAutoRenewal|PendingValidation|Success|Failed',
                'renewalStatusReason' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            'requestFailureReason' => '<string>',
            'revocationReason' => '<string>',
            'revokedAt' => <DateTime>,
            'serialNumber' => '<string>',
            'status' => 'PENDING_VALIDATION|ISSUED|INACTIVE|EXPIRED|VALIDATION_TIMED_OUT|REVOKED|FAILED',
            'subjectAlternativeNames' => ['<string>', ...],
            'supportCode' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        'certificateName' => '<string>',
        'domainName' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateCloudFormationStack

$result = $client->createCloudFormationStack([/* ... */]);
$promise = $client->createCloudFormationStackAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCloudFormationStack([
    'instances' => [ // REQUIRED
        [
            'availabilityZone' => '<string>', // REQUIRED
            'instanceType' => '<string>', // REQUIRED
            'portInfoSource' => 'DEFAULT|INSTANCE|NONE|CLOSED', // REQUIRED
            'sourceName' => '<string>', // REQUIRED
            'userData' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateContactMethod

$result = $client->createContactMethod([/* ... */]);
$promise = $client->createContactMethodAsync([/* ... */]);

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. 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 Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Parameter Syntax

$result = $client->createContactMethod([
    'contactEndpoint' => '<string>', // REQUIRED
    'protocol' => 'Email|SMS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateContainerService

$result = $client->createContainerService([/* ... */]);
$promise = $client->createContainerServiceAsync([/* ... */]);

Creates an Amazon Lightsail container service.

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

Parameter Syntax

$result = $client->createContainerService([
    'deployment' => [
        'containers' => [
            '<ContainerName>' => [
                'command' => ['<string>', ...],
                'environment' => ['<string>', ...],
                'image' => '<string>',
                'ports' => ['<string>', ...],
            ],
            // ...
        ],
        'publicEndpoint' => [
            'containerName' => '<string>', // REQUIRED
            'containerPort' => <integer>, // REQUIRED
            'healthCheck' => [
                'healthyThreshold' => <integer>,
                'intervalSeconds' => <integer>,
                'path' => '<string>',
                'successCodes' => '<string>',
                'timeoutSeconds' => <integer>,
                'unhealthyThreshold' => <integer>,
            ],
        ],
    ],
    'power' => 'nano|micro|small|medium|large|xlarge', // REQUIRED
    'privateRegistryAccess' => [
        'ecrImagePullerRole' => [
            'isActive' => true || false,
        ],
    ],
    'publicDomainNames' => [
        '<string>' => ['<string>', ...],
        // ...
    ],
    'scale' => <integer>, // REQUIRED
    'serviceName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'containerService' => [
        'arn' => '<string>',
        'containerServiceName' => '<string>',
        'createdAt' => <DateTime>,
        'currentDeployment' => [
            'containers' => [
                '<ContainerName>' => [
                    'command' => ['<string>', ...],
                    'environment' => ['<string>', ...],
                    'image' => '<string>',
                    'ports' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'publicEndpoint' => [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'healthCheck' => [
                    'healthyThreshold' => <integer>,
                    'intervalSeconds' => <integer>,
                    'path' => '<string>',
                    'successCodes' => '<string>',
                    'timeoutSeconds' => <integer>,
                    'unhealthyThreshold' => <integer>,
                ],
            ],
            'state' => 'ACTIVATING|ACTIVE|INACTIVE|FAILED',
            'version' => <integer>,
        ],
        'isDisabled' => true || false,
        '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',
        ],
        'nextDeployment' => [
            'containers' => [
                '<ContainerName>' => [
                    'command' => ['<string>', ...],
                    'environment' => ['<string>', ...],
                    'image' => '<string>',
                    'ports' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'publicEndpoint' => [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'healthCheck' => [
                    'healthyThreshold' => <integer>,
                    'intervalSeconds' => <integer>,
                    'path' => '<string>',
                    'successCodes' => '<string>',
                    'timeoutSeconds' => <integer>,
                    'unhealthyThreshold' => <integer>,
                ],
            ],
            'state' => 'ACTIVATING|ACTIVE|INACTIVE|FAILED',
            'version' => <integer>,
        ],
        'power' => 'nano|micro|small|medium|large|xlarge',
        'powerId' => '<string>',
        'principalArn' => '<string>',
        'privateDomainName' => '<string>',
        'privateRegistryAccess' => [
            'ecrImagePullerRole' => [
                'isActive' => true || false,
                'principalArn' => '<string>',
            ],
        ],
        'publicDomainNames' => [
            '<string>' => ['<string>', ...],
            // ...
        ],
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'scale' => <integer>,
        'state' => 'PENDING|READY|RUNNING|UPDATING|DELETING|DISABLED|DEPLOYING',
        'stateDetail' => [
            'code' => 'CREATING_SYSTEM_RESOURCES|CREATING_NETWORK_INFRASTRUCTURE|PROVISIONING_CERTIFICATE|PROVISIONING_SERVICE|CREATING_DEPLOYMENT|EVALUATING_HEALTH_CHECK|ACTIVATING_DEPLOYMENT|CERTIFICATE_LIMIT_EXCEEDED|UNKNOWN_ERROR',
            'message' => '<string>',
        ],
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'url' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateContainerServiceDeployment

$result = $client->createContainerServiceDeployment([/* ... */]);
$promise = $client->createContainerServiceDeploymentAsync([/* ... */]);

Creates a deployment for your Amazon Lightsail container service.

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

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

Parameter Syntax

$result = $client->createContainerServiceDeployment([
    'containers' => [
        '<ContainerName>' => [
            'command' => ['<string>', ...],
            'environment' => ['<string>', ...],
            'image' => '<string>',
            'ports' => ['<string>', ...],
        ],
        // ...
    ],
    'publicEndpoint' => [
        'containerName' => '<string>', // REQUIRED
        'containerPort' => <integer>, // REQUIRED
        'healthCheck' => [
            'healthyThreshold' => <integer>,
            'intervalSeconds' => <integer>,
            'path' => '<string>',
            'successCodes' => '<string>',
            'timeoutSeconds' => <integer>,
            'unhealthyThreshold' => <integer>,
        ],
    ],
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'containerService' => [
        'arn' => '<string>',
        'containerServiceName' => '<string>',
        'createdAt' => <DateTime>,
        'currentDeployment' => [
            'containers' => [
                '<ContainerName>' => [
                    'command' => ['<string>', ...],
                    'environment' => ['<string>', ...],
                    'image' => '<string>',
                    'ports' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'publicEndpoint' => [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'healthCheck' => [
                    'healthyThreshold' => <integer>,
                    'intervalSeconds' => <integer>,
                    'path' => '<string>',
                    'successCodes' => '<string>',
                    'timeoutSeconds' => <integer>,
                    'unhealthyThreshold' => <integer>,
                ],
            ],
            'state' => 'ACTIVATING|ACTIVE|INACTIVE|FAILED',
            'version' => <integer>,
        ],
        'isDisabled' => true || false,
        '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',
        ],
        'nextDeployment' => [
            'containers' => [
                '<ContainerName>' => [
                    'command' => ['<string>', ...],
                    'environment' => ['<string>', ...],
                    'image' => '<string>',
                    'ports' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'publicEndpoint' => [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'healthCheck' => [
                    'healthyThreshold' => <integer>,
                    'intervalSeconds' => <integer>,
                    'path' => '<string>',
                    'successCodes' => '<string>',
                    'timeoutSeconds' => <integer>,
                    'unhealthyThreshold' => <integer>,
                ],
            ],
            'state' => 'ACTIVATING|ACTIVE|INACTIVE|FAILED',
            'version' => <integer>,
        ],
        'power' => 'nano|micro|small|medium|large|xlarge',
        'powerId' => '<string>',
        'principalArn' => '<string>',
        'privateDomainName' => '<string>',
        'privateRegistryAccess' => [
            'ecrImagePullerRole' => [
                'isActive' => true || false,
                'principalArn' => '<string>',
            ],
        ],
        'publicDomainNames' => [
            '<string>' => ['<string>', ...],
            // ...
        ],
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'scale' => <integer>,
        'state' => 'PENDING|READY|RUNNING|UPDATING|DELETING|DISABLED|DEPLOYING',
        'stateDetail' => [
            'code' => 'CREATING_SYSTEM_RESOURCES|CREATING_NETWORK_INFRASTRUCTURE|PROVISIONING_CERTIFICATE|PROVISIONING_SERVICE|CREATING_DEPLOYMENT|EVALUATING_HEALTH_CHECK|ACTIVATING_DEPLOYMENT|CERTIFICATE_LIMIT_EXCEEDED|UNKNOWN_ERROR',
            'message' => '<string>',
        ],
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'url' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateContainerServiceRegistryLogin

$result = $client->createContainerServiceRegistryLogin([/* ... */]);
$promise = $client->createContainerServiceRegistryLoginAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createContainerServiceRegistryLogin([
]);

Parameter Details

Result Syntax

[
    'registryLogin' => [
        'expiresAt' => <DateTime>,
        'password' => '<string>',
        'registry' => '<string>',
        'username' => '<string>',
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDisk

$result = $client->createDisk([/* ... */]);
$promise = $client->createDiskAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createDisk([
    'addOns' => [
        [
            'addOnType' => 'AutoSnapshot|StopInstanceOnIdle', // REQUIRED
            'autoSnapshotAddOnRequest' => [
                'snapshotTimeOfDay' => '<string>',
            ],
            'stopInstanceOnIdleRequest' => [
                'duration' => '<string>',
                'threshold' => '<string>',
            ],
        ],
        // ...
    ],
    'availabilityZone' => '<string>', // REQUIRED
    'diskName' => '<string>', // REQUIRED
    'sizeInGb' => <integer>, // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDiskFromSnapshot

$result = $client->createDiskFromSnapshot([/* ... */]);
$promise = $client->createDiskFromSnapshotAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createDiskFromSnapshot([
    'addOns' => [
        [
            'addOnType' => 'AutoSnapshot|StopInstanceOnIdle', // REQUIRED
            'autoSnapshotAddOnRequest' => [
                'snapshotTimeOfDay' => '<string>',
            ],
            'stopInstanceOnIdleRequest' => [
                'duration' => '<string>',
                'threshold' => '<string>',
            ],
        ],
        // ...
    ],
    'availabilityZone' => '<string>', // REQUIRED
    'diskName' => '<string>', // REQUIRED
    'diskSnapshotName' => '<string>',
    'restoreDate' => '<string>',
    'sizeInGb' => <integer>, // REQUIRED
    'sourceDiskName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'useLatestRestorableAutoSnapshot' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDiskSnapshot

$result = $client->createDiskSnapshot([/* ... */]);
$promise = $client->createDiskSnapshotAsync([/* ... */]);

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

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

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

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

Parameter Syntax

$result = $client->createDiskSnapshot([
    'diskName' => '<string>',
    'diskSnapshotName' => '<string>', // REQUIRED
    'instanceName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDistribution

$result = $client->createDistribution([/* ... */]);
$promise = $client->createDistributionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createDistribution([
    'bundleId' => '<string>', // REQUIRED
    'cacheBehaviorSettings' => [
        'allowedHTTPMethods' => '<string>',
        'cachedHTTPMethods' => '<string>',
        'defaultTTL' => <integer>,
        'forwardedCookies' => [
            'cookiesAllowList' => ['<string>', ...],
            'option' => 'none|allow-list|all',
        ],
        'forwardedHeaders' => [
            'headersAllowList' => ['<string>', ...],
            'option' => 'none|allow-list|all',
        ],
        'forwardedQueryStrings' => [
            'option' => true || false,
            'queryStringsAllowList' => ['<string>', ...],
        ],
        'maximumTTL' => <integer>,
        'minimumTTL' => <integer>,
    ],
    'cacheBehaviors' => [
        [
            'behavior' => 'dont-cache|cache',
            'path' => '<string>',
        ],
        // ...
    ],
    'certificateName' => '<string>',
    'defaultCacheBehavior' => [ // REQUIRED
        'behavior' => 'dont-cache|cache',
    ],
    'distributionName' => '<string>', // REQUIRED
    'ipAddressType' => 'dualstack|ipv4|ipv6',
    'origin' => [ // REQUIRED
        'name' => '<string>',
        'protocolPolicy' => 'http-only|https-only',
        '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',
        'responseTimeout' => <integer>,
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'viewerMinimumTlsProtocolVersion' => 'TLSv1.1_2016|TLSv1.2_2018|TLSv1.2_2019|TLSv1.2_2021',
]);

Parameter Details

Result Syntax

[
    'distribution' => [
        'ableToUpdateBundle' => true || false,
        'alternativeDomainNames' => ['<string>', ...],
        'arn' => '<string>',
        'bundleId' => '<string>',
        'cacheBehaviorSettings' => [
            'allowedHTTPMethods' => '<string>',
            'cachedHTTPMethods' => '<string>',
            'defaultTTL' => <integer>,
            'forwardedCookies' => [
                'cookiesAllowList' => ['<string>', ...],
                'option' => 'none|allow-list|all',
            ],
            'forwardedHeaders' => [
                'headersAllowList' => ['<string>', ...],
                'option' => 'none|allow-list|all',
            ],
            'forwardedQueryStrings' => [
                'option' => true || false,
                'queryStringsAllowList' => ['<string>', ...],
            ],
            'maximumTTL' => <integer>,
            'minimumTTL' => <integer>,
        ],
        'cacheBehaviors' => [
            [
                'behavior' => 'dont-cache|cache',
                'path' => '<string>',
            ],
            // ...
        ],
        'certificateName' => '<string>',
        'createdAt' => <DateTime>,
        'defaultCacheBehavior' => [
            'behavior' => 'dont-cache|cache',
        ],
        'domainName' => '<string>',
        'ipAddressType' => 'dualstack|ipv4|ipv6',
        'isEnabled' => true || false,
        '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',
        ],
        'name' => '<string>',
        'origin' => [
            'name' => '<string>',
            'protocolPolicy' => 'http-only|https-only',
            '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',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'responseTimeout' => <integer>,
        ],
        'originPublicDNS' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => '<string>',
        'supportCode' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'viewerMinimumTlsProtocolVersion' => '<string>',
    ],
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDomain([
    'domainName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateDomainEntry

$result = $client->createDomainEntry([/* ... */]);
$promise = $client->createDomainEntryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDomainEntry([
    'domainEntry' => [ // REQUIRED
        'id' => '<string>',
        'isAlias' => true || false,
        'name' => '<string>',
        'options' => ['<string>', ...],
        'target' => '<string>',
        'type' => '<string>',
    ],
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateGUISessionAccessDetails

$result = $client->createGUISessionAccessDetails([/* ... */]);
$promise = $client->createGUISessionAccessDetailsAsync([/* ... */]);

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

Use StartGUISession to open the session.

Parameter Syntax

$result = $client->createGUISessionAccessDetails([
    'resourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failureReason' => '<string>',
    'percentageComplete' => <integer>,
    'resourceName' => '<string>',
    'sessions' => [
        [
            'isPrimary' => true || false,
            'name' => '<string>',
            'url' => '<string>',
        ],
        // ...
    ],
    'status' => 'startExpired|notStarted|started|starting|stopped|stopping|settingUpInstance|failedInstanceCreation|failedStartingGUISession|failedStoppingGUISession',
]

Result Details

Errors

AccessDeniedException:

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

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

ServiceException:

A general service exception.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateInstanceSnapshot

$result = $client->createInstanceSnapshot([/* ... */]);
$promise = $client->createInstanceSnapshotAsync([/* ... */]);

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

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

Parameter Syntax

$result = $client->createInstanceSnapshot([
    'instanceName' => '<string>', // REQUIRED
    'instanceSnapshotName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateInstances

$result = $client->createInstances([/* ... */]);
$promise = $client->createInstancesAsync([/* ... */]);

Creates one or more Amazon Lightsail instances.

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

Parameter Syntax

$result = $client->createInstances([
    'addOns' => [
        [
            'addOnType' => 'AutoSnapshot|StopInstanceOnIdle', // REQUIRED
            'autoSnapshotAddOnRequest' => [
                'snapshotTimeOfDay' => '<string>',
            ],
            'stopInstanceOnIdleRequest' => [
                'duration' => '<string>',
                'threshold' => '<string>',
            ],
        ],
        // ...
    ],
    'availabilityZone' => '<string>', // REQUIRED
    'blueprintId' => '<string>', // REQUIRED
    'bundleId' => '<string>', // REQUIRED
    'customImageName' => '<string>',
    'instanceNames' => ['<string>', ...], // REQUIRED
    'ipAddressType' => 'dualstack|ipv4|ipv6',
    'keyPairName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'userData' => '<string>',
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateInstancesFromSnapshot

$result = $client->createInstancesFromSnapshot([/* ... */]);
$promise = $client->createInstancesFromSnapshotAsync([/* ... */]);

Creates one or more new instances from a manual or automatic snapshot of an instance.

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

Parameter Syntax

$result = $client->createInstancesFromSnapshot([
    'addOns' => [
        [
            'addOnType' => 'AutoSnapshot|StopInstanceOnIdle', // REQUIRED
            'autoSnapshotAddOnRequest' => [
                'snapshotTimeOfDay' => '<string>',
            ],
            'stopInstanceOnIdleRequest' => [
                'duration' => '<string>',
                'threshold' => '<string>',
            ],
        ],
        // ...
    ],
    'attachedDiskMapping' => [
        '<ResourceName>' => [
            [
                'newDiskName' => '<string>',
                'originalDiskPath' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'availabilityZone' => '<string>', // REQUIRED
    'bundleId' => '<string>', // REQUIRED
    'instanceNames' => ['<string>', ...], // REQUIRED
    'instanceSnapshotName' => '<string>',
    'ipAddressType' => 'dualstack|ipv4|ipv6',
    'keyPairName' => '<string>',
    'restoreDate' => '<string>',
    'sourceInstanceName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'useLatestRestorableAutoSnapshot' => true || false,
    'userData' => '<string>',
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateKeyPair

$result = $client->createKeyPair([/* ... */]);
$promise = $client->createKeyPairAsync([/* ... */]);

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

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

Parameter Syntax

$result = $client->createKeyPair([
    'keyPairName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'keyPair' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'fingerprint' => '<string>',
        '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',
        ],
        'name' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'supportCode' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
    'privateKeyBase64' => '<string>',
    'publicKeyBase64' => '<string>',
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateLoadBalancer

$result = $client->createLoadBalancer([/* ... */]);
$promise = $client->createLoadBalancerAsync([/* ... */]);

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

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

Parameter Syntax

$result = $client->createLoadBalancer([
    'certificateAlternativeNames' => ['<string>', ...],
    'certificateDomainName' => '<string>',
    'certificateName' => '<string>',
    'healthCheckPath' => '<string>',
    'instancePort' => <integer>, // REQUIRED
    'ipAddressType' => 'dualstack|ipv4|ipv6',
    'loadBalancerName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'tlsPolicyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateLoadBalancerTlsCertificate

$result = $client->createLoadBalancerTlsCertificate([/* ... */]);
$promise = $client->createLoadBalancerTlsCertificateAsync([/* ... */]);

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

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

Parameter Syntax

$result = $client->createLoadBalancerTlsCertificate([
    'certificateAlternativeNames' => ['<string>', ...],
    'certificateDomainName' => '<string>', // REQUIRED
    'certificateName' => '<string>', // REQUIRED
    'loadBalancerName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateRelationalDatabase

$result = $client->createRelationalDatabase([/* ... */]);
$promise = $client->createRelationalDatabaseAsync([/* ... */]);

Creates a new database in Amazon Lightsail.

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

Parameter Syntax

$result = $client->createRelationalDatabase([
    'availabilityZone' => '<string>',
    'masterDatabaseName' => '<string>', // REQUIRED
    'masterUserPassword' => '<string>',
    'masterUsername' => '<string>', // REQUIRED
    'preferredBackupWindow' => '<string>',
    'preferredMaintenanceWindow' => '<string>',
    'publiclyAccessible' => true || false,
    'relationalDatabaseBlueprintId' => '<string>', // REQUIRED
    'relationalDatabaseBundleId' => '<string>', // REQUIRED
    'relationalDatabaseName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateRelationalDatabaseFromSnapshot

$result = $client->createRelationalDatabaseFromSnapshot([/* ... */]);
$promise = $client->createRelationalDatabaseFromSnapshotAsync([/* ... */]);

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

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

Parameter Syntax

$result = $client->createRelationalDatabaseFromSnapshot([
    'availabilityZone' => '<string>',
    'publiclyAccessible' => true || false,
    'relationalDatabaseBundleId' => '<string>',
    'relationalDatabaseName' => '<string>', // REQUIRED
    'relationalDatabaseSnapshotName' => '<string>',
    'restoreTime' => <integer || string || DateTime>,
    'sourceRelationalDatabaseName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'useLatestRestorableTime' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

CreateRelationalDatabaseSnapshot

$result = $client->createRelationalDatabaseSnapshot([/* ... */]);
$promise = $client->createRelationalDatabaseSnapshotAsync([/* ... */]);

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

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

Parameter Syntax

$result = $client->createRelationalDatabaseSnapshot([
    'relationalDatabaseName' => '<string>', // REQUIRED
    'relationalDatabaseSnapshotName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteAlarm

$result = $client->deleteAlarm([/* ... */]);
$promise = $client->deleteAlarmAsync([/* ... */]);

Deletes an alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Parameter Syntax

$result = $client->deleteAlarm([
    'alarmName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AccessDeniedException:

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

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

DeleteAutoSnapshot

$result = $client->deleteAutoSnapshot([/* ... */]);
$promise = $client->deleteAutoSnapshotAsync([/* ... */]);

Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteAutoSnapshot([
    'date' => '<string>', // REQUIRED
    'resourceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteBucket

$result = $client->deleteBucket([/* ... */]);
$promise = $client->deleteBucketAsync([/* ... */]);

Deletes a Amazon Lightsail bucket.

Parameter Syntax

$result = $client->deleteBucket([
    'bucketName' => '<string>', // REQUIRED
    'forceDelete' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

ServiceException:

A general service exception.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteBucketAccessKey

$result = $client->deleteBucketAccessKey([/* ... */]);
$promise = $client->deleteBucketAccessKeyAsync([/* ... */]);

Deletes an access key for the specified Amazon Lightsail bucket.

We recommend that you delete an access key if the secret access key is compromised.

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteBucketAccessKey([
    'accessKeyId' => '<string>', // REQUIRED
    'bucketName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

ServiceException:

A general service exception.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteCertificate

$result = $client->deleteCertificate([/* ... */]);
$promise = $client->deleteCertificateAsync([/* ... */]);

Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

Parameter Syntax

$result = $client->deleteCertificate([
    'certificateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

AccessDeniedException:

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

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteContactMethod

$result = $client->deleteContactMethod([/* ... */]);
$promise = $client->deleteContactMethodAsync([/* ... */]);

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. 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 Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Parameter Syntax

$result = $client->deleteContactMethod([
    'protocol' => 'Email|SMS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

AccessDeniedException:

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

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

DeleteContainerImage

$result = $client->deleteContainerImage([/* ... */]);
$promise = $client->deleteContainerImageAsync([/* ... */]);

Deletes a container image that is registered to your Amazon Lightsail container service.

Parameter Syntax

$result = $client->deleteContainerImage([
    'image' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteContainerService

$result = $client->deleteContainerService([/* ... */]);
$promise = $client->deleteContainerServiceAsync([/* ... */]);

Deletes your Amazon Lightsail container service.

Parameter Syntax

$result = $client->deleteContainerService([
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteDisk

$result = $client->deleteDisk([/* ... */]);
$promise = $client->deleteDiskAsync([/* ... */]);

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

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

Parameter Syntax

$result = $client->deleteDisk([
    'diskName' => '<string>', // REQUIRED
    'forceDeleteAddOns' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteDiskSnapshot

$result = $client->deleteDiskSnapshot([/* ... */]);
$promise = $client->deleteDiskSnapshotAsync([/* ... */]);

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

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

Parameter Syntax

$result = $client->deleteDiskSnapshot([
    'diskSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteDistribution

$result = $client->deleteDistribution([/* ... */]);
$promise = $client->deleteDistributionAsync([/* ... */]);

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

Parameter Syntax

$result = $client->deleteDistribution([
    'distributionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDomain([
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteDomainEntry

$result = $client->deleteDomainEntry([/* ... */]);
$promise = $client->deleteDomainEntryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDomainEntry([
    'domainEntry' => [ // REQUIRED
        'id' => '<string>',
        'isAlias' => true || false,
        'name' => '<string>',
        'options' => ['<string>', ...],
        'target' => '<string>',
        'type' => '<string>',
    ],
    'domainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

Deletes an Amazon Lightsail instance.

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

Parameter Syntax

$result = $client->deleteInstance([
    'forceDeleteAddOns' => true || false,
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteInstanceSnapshot

$result = $client->deleteInstanceSnapshot([/* ... */]);
$promise = $client->deleteInstanceSnapshotAsync([/* ... */]);

Deletes a specific snapshot of a virtual private server (or instance).

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteInstanceSnapshot([
    'instanceSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteKeyPair

$result = $client->deleteKeyPair([/* ... */]);
$promise = $client->deleteKeyPairAsync([/* ... */]);

Deletes the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteKeyPair([
    'expectedFingerprint' => '<string>',
    'keyPairName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteKnownHostKeys

$result = $client->deleteKnownHostKeys([/* ... */]);
$promise = $client->deleteKnownHostKeysAsync([/* ... */]);

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Parameter Syntax

$result = $client->deleteKnownHostKeys([
    'instanceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteLoadBalancer

$result = $client->deleteLoadBalancer([/* ... */]);
$promise = $client->deleteLoadBalancerAsync([/* ... */]);

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

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

Parameter Syntax

$result = $client->deleteLoadBalancer([
    'loadBalancerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteLoadBalancerTlsCertificate

$result = $client->deleteLoadBalancerTlsCertificate([/* ... */]);
$promise = $client->deleteLoadBalancerTlsCertificateAsync([/* ... */]);

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

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

Parameter Syntax

$result = $client->deleteLoadBalancerTlsCertificate([
    'certificateName' => '<string>', // REQUIRED
    'force' => true || false,
    'loadBalancerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteRelationalDatabase

$result = $client->deleteRelationalDatabase([/* ... */]);
$promise = $client->deleteRelationalDatabaseAsync([/* ... */]);

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteRelationalDatabase([
    'finalRelationalDatabaseSnapshotName' => '<string>',
    'relationalDatabaseName' => '<string>', // REQUIRED
    'skipFinalSnapshot' => true || false,
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DeleteRelationalDatabaseSnapshot

$result = $client->deleteRelationalDatabaseSnapshot([/* ... */]);
$promise = $client->deleteRelationalDatabaseSnapshotAsync([/* ... */]);

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

Parameter Syntax

$result = $client->deleteRelationalDatabaseSnapshot([
    'relationalDatabaseSnapshotName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DetachCertificateFromDistribution

$result = $client->detachCertificateFromDistribution([/* ... */]);
$promise = $client->detachCertificateFromDistributionAsync([/* ... */]);

Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

Parameter Syntax

$result = $client->detachCertificateFromDistribution([
    'distributionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operation' => [
        'createdAt' => <DateTime>,
        'errorCode' => '<string>',
        'errorDetails' => '<string>',
        'id' => '<string>',
        'isTerminal' => true || false,
        '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',
        ],
        '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',
        'resourceName' => '<string>',
        'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
        'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
        'statusChangedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DetachDisk

$result = $client->detachDisk([/* ... */]);
$promise = $client->detachDiskAsync([/* ... */]);

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

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

Parameter Syntax

$result = $client->detachDisk([
    'diskName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServiceException:

A general service exception.

InvalidInputException:

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.

NotFoundException:

Lightsail throws this exception when it cannot find a resource.

OperationFailureException:

Lightsail throws this exception when an operation fails to execute.

AccessDeniedException:

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

AccountSetupInProgressException:

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

UnauthenticatedException:

Lightsail throws this exception when the user has not been authenticated.

DetachInstancesFromLoadBalancer

$result = $client->detachInstancesFromLoadBalancer([/* ... */]);
$promise = $client->detachInstancesFromLoadBalancerAsync([/* ... */]);

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

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

Parameter Syntax

$result = $client->detachInstancesFromLoadBalancer([
    'instanceNames' => ['<string>', ...], // REQUIRED
    'loadBalancerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'operations' => [
        [
            'createdAt' => <DateTime>,
            'errorCode' => '<string>',
            'errorDetails' => '<string>',
            'id' => '<string>',
            'isTerminal' => true || false,
            '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',
            ],
            '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',
            'resourceName' => '<string>',
            'resourceType' => 'ContainerService|Instance|StaticIp|KeyPair|InstanceSnapshot|Domain|PeeredVpc|LoadBalancer|LoadBalancerTlsCertificate|Disk|DiskSnapshot|RelationalDatabase|RelationalDatabaseSnapshot|ExportSnapshotRecord|CloudFormationStackRecord|Alarm|ContactMethod|Distribution|Certificate|Bucket',
            'status' => 'NotStarted|Started|Failed|Completed|Succeeded',
            'statusChangedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details