Amazon Lightsail
API Reference (API Version 2016-11-28)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Operation

Describes the API operation.

Contents

createdAt

The timestamp when the operation was initialized (e.g., 1479816991.349).

Type: Timestamp

Required: No

errorCode

The error code.

Type: String

Required: No

errorDetails

The error details.

Type: String

Required: No

id

The ID of the operation.

Type: String

Pattern: .*\S.*

Required: No

isTerminal

A Boolean value indicating whether the operation is terminal.

Type: Boolean

Required: No

location

The region and Availability Zone.

Type: ResourceLocation object

Required: No

operationDetails

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

Type: String

Required: No

operationType

The type of operation.

Type: String

Valid Values: 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

Required: No

resourceName

The resource name.

Type: String

Pattern: \w[\w\-]*\w

Required: No

resourceType

The resource type.

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord

Required: No

status

The status of the operation.

Type: String

Valid Values: NotStarted | Started | Failed | Completed | Succeeded

Required: No

statusChangedAt

The timestamp when the status was changed (e.g., 1479816991.349).

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: