amazonka-ec2-1.3.1: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2

Contents

Description

Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

See: AWS API Reference

Synopsis

Service Configuration

eC2 :: Service Source

API version '2015-04-15' of the Amazon Elastic Compute Cloud SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by EC2.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

InstanceTerminated

instanceTerminated :: Wait DescribeInstances Source

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VolumeInUse

volumeInUse :: Wait DescribeVolumes Source

Polls DescribeVolumes every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

SubnetAvailable

subnetAvailable :: Wait DescribeSubnets Source

Polls DescribeSubnets every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

SystemStatusOK

systemStatusOK :: Wait DescribeInstanceStatus Source

Polls DescribeInstanceStatus every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

CustomerGatewayAvailable

customerGatewayAvailable :: Wait DescribeCustomerGateways Source

Polls DescribeCustomerGateways every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ConversionTaskCompleted

conversionTaskCompleted :: Wait DescribeConversionTasks Source

Polls DescribeConversionTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

InstanceStopped

instanceStopped :: Wait DescribeInstances Source

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ConversionTaskDeleted

conversionTaskDeleted :: Wait DescribeConversionTasks Source

Polls DescribeConversionTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

PasswordDataAvailable

passwordDataAvailable :: Wait GetPasswordData Source

Polls GetPasswordData every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

InstanceRunning

instanceRunning :: Wait DescribeInstances Source

Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

SpotInstanceRequestFulfilled

spotInstanceRequestFulfilled :: Wait DescribeSpotInstanceRequests Source

Polls DescribeSpotInstanceRequests every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VPCAvailable

vpcAvailable :: Wait DescribeVPCs Source

Polls DescribeVPCs every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ExportTaskCompleted

exportTaskCompleted :: Wait DescribeExportTasks Source

Polls DescribeExportTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VPNConnectionAvailable

vpnConnectionAvailable :: Wait DescribeVPNConnections Source

Polls DescribeVPNConnections every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ExportTaskCancelled

exportTaskCancelled :: Wait DescribeExportTasks Source

Polls DescribeExportTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VolumeDeleted

volumeDeleted :: Wait DescribeVolumes Source

Polls DescribeVolumes every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

BundleTaskComplete

bundleTaskComplete :: Wait DescribeBundleTasks Source

Polls DescribeBundleTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VPNConnectionDeleted

vpnConnectionDeleted :: Wait DescribeVPNConnections Source

Polls DescribeVPNConnections every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ConversionTaskCancelled

conversionTaskCancelled :: Wait DescribeConversionTasks Source

Polls DescribeConversionTasks every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

ImageAvailable

imageAvailable :: Wait DescribeImages Source

Polls DescribeImages every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

SnapshotCompleted

snapshotCompleted :: Wait DescribeSnapshots Source

Polls DescribeSnapshots every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

InstanceExists

instanceExists :: Wait DescribeInstances Source

Polls DescribeInstances every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.

InstanceStatusOK

instanceStatusOK :: Wait DescribeInstanceStatus Source

Polls DescribeInstanceStatus every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

VolumeAvailable

volumeAvailable :: Wait DescribeVolumes Source

Polls DescribeVolumes every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

ImportInstance

RevokeSecurityGroupEgress

CreateVPNGateway

CreateNetworkACL

DeleteKeyPair

DescribeTags (Paginated)

DetachNetworkInterface

DetachInternetGateway

DeleteVPCEndpoints

DeleteFlowLogs

DescribeVPCClassicLink

ModifySubnetAttribute

DetachVolume

CancelBundleTask

ReleaseAddress

CreateInternetGateway

DeleteVPNConnection

DescribeBundleTasks

AuthorizeSecurityGroupEgress

DeregisterImage

ModifyNetworkInterfaceAttribute

CancelReservedInstancesListing

AttachClassicLinkVPC

CancelSpotFleetRequests

DescribeSpotPriceHistory (Paginated)

DescribeDHCPOptions

ImportImage

StopInstances

DescribeInternetGateways

DisableVPCClassicLink

BundleInstance

DescribeNetworkInterfaces

ReplaceNetworkACLAssociation

DescribeAddresses

DescribeSnapshotAttribute

ReplaceRoute

DescribeVPCEndpointServices

AuthorizeSecurityGroupIngress

CreateVPCPeeringConnection

DescribeSubnets

CreateTags

PurchaseReservedInstancesOffering

DeleteNetworkACLEntry

ResetSnapshotAttribute

DescribeVPNConnections

DeleteRoute

ReplaceNetworkACLEntry

DescribeVPCEndpoints

ResetInstanceAttribute

AttachNetworkInterface

DescribeInstanceStatus (Paginated)

ImportKeyPair

DeleteTags

ConfirmProductInstance

DescribeInstanceAttribute

DescribeReservedInstancesOfferings (Paginated)

CreateCustomerGateway

DeleteSecurityGroup

DeleteVPCPeeringConnection

AttachInternetGateway

DescribeFlowLogs

RunInstances

AssociateDHCPOptions

DescribeReservedInstances

DescribeVPCs

DescribeConversionTasks

AllocateAddress

CancelConversionTask

ModifyImageAttribute

CreateRouteTable

ReportInstanceStatus

AttachVolume

RequestSpotInstances

DescribeVolumes

RejectVPCPeeringConnection

DeleteVPNConnectionRoute

ModifyVPCEndpoint

RegisterImage

RevokeSecurityGroupIngress

ModifyReservedInstances

CreateFlowLogs

DescribeSpotFleetRequests

MoveAddressToVPC

DeleteNetworkACL

DeleteVPNGateway

DescribeImportImageTasks

DescribeVolumeAttribute

DescribeMovingAddresses

GetPasswordData

CreateVPC

CopySnapshot

DisassociateAddress

DeleteVPC

CreateInstanceExportTask

DescribeVPCAttribute

CreateVolume

ModifyVolumeAttribute

DescribeSpotDatafeedSubscription

DescribePrefixLists

DeletePlacementGroup

RequestSpotFleet

CreateSubnet

CreateNetworkInterface

DescribeSecurityGroups

DescribeExportTasks

DetachVPNGateway

EnableVolumeIO

DescribeInstances (Paginated)

DescribeVPCPeeringConnections

CancelExportTask

DeleteNetworkInterface

ReplaceRouteTableAssociation

StartInstances

CreatePlacementGroup

DescribeSnapshots (Paginated)

AssociateAddress

DescribeNetworkInterfaceAttribute

ResetNetworkInterfaceAttribute

DeleteInternetGateway

DescribeReservedInstancesListings

CreateVPNConnection

DescribeImportSnapshotTasks

DescribeCustomerGateways

DeleteSubnet

CopyImage

CreateVPCEndpoint

UnmonitorInstances

CreateSecurityGroup

ImportVolume

DisableVGWRoutePropagation

CreateSpotDatafeedSubscription

CancelSpotInstanceRequests

CreateRoute

DeleteSnapshot

AssignPrivateIPAddresses

ModifyInstanceAttribute

DeleteCustomerGateway

DisassociateRouteTable

DeleteSpotDatafeedSubscription

EnableVPCClassicLink

DescribePlacementGroups

EnableVGWRoutePropagation

DescribeSpotFleetRequestHistory

ModifySnapshotAttribute

CreateSnapshot

CreateNetworkACLEntry

CreateReservedInstancesListing

AttachVPNGateway

CreateDHCPOptions

DescribeAccountAttributes

RebootInstances

CreateImage

DescribeClassicLinkInstances

TerminateInstances

DescribeKeyPairs

CreateVPNConnectionRoute

AssociateRouteTable

DescribeVPNGateways

GetConsoleOutput

DescribeImageAttribute

DeleteRouteTable

ResetImageAttribute

DescribeReservedInstancesModifications (Paginated)

DescribeSpotInstanceRequests

UnassignPrivateIPAddresses

DeleteDHCPOptions

DescribeNetworkACLs

CancelImportTask

DetachClassicLinkVPC

DescribeRegions

MonitorInstances

AcceptVPCPeeringConnection

ImportSnapshot

DescribeVolumeStatus (Paginated)

DescribeRouteTables

DescribeAvailabilityZones

ModifyVPCAttribute

DescribeImages

RestoreAddressToClassic

CreateKeyPair

DeleteVolume

DescribeSpotFleetInstances

Types

AccountAttributeName

AddressStatus

ArchitectureValues

AttachmentStatus

AvailabilityZoneState

BatchState

BundleTaskState

CancelBatchErrorCode

CancelSpotInstanceRequestState

ContainerFormat

ConversionTaskState

CurrencyCodeValues

DatafeedSubscriptionState

DeviceType

DiskImageFormat

DomainType

EventCode

EventType

ExportEnvironment

ExportTaskState

FlowLogsResourceType

GatewayType

HypervisorType

ImageAttributeName

ImageState

ImageTypeValues

InstanceAttributeName

InstanceLifecycleType

InstanceStateName

InstanceType

ListingState

ListingStatus

MonitoringState

MoveStatus

NetworkInterfaceAttribute

NetworkInterfaceStatus

OfferingTypeValues

OperationType

PermissionGroup

PlacementGroupState

PlacementStrategy

PlatformValues

ProductCodeValues

RIProductDescription

RecurringChargeFrequency

ReportInstanceReasonCodes

ReportStatusType

ReservedInstanceState

ResetImageAttributeName

ResourceType

RouteOrigin

RouteState

RuleAction

ShutdownBehavior

SnapshotAttributeName

SnapshotState

SpotInstanceState

SpotInstanceType

State

StatusName

StatusType

SubnetState

SummaryStatus

TelemetryStatus

Tenancy

TrafficType

VPCAttributeName

VPCPeeringConnectionStateReasonCode

VPCState

VPNState

VPNStaticRouteSource

VirtualizationType

VolumeAttachmentState

VolumeAttributeName

VolumeState

VolumeStatusInfoStatus

VolumeStatusName

VolumeType

AccountAttribute

accountAttribute :: AccountAttribute Source

Creates a value of AccountAttribute with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aaAttributeValues :: Lens' AccountAttribute [AccountAttributeValue] Source

One or more values for the account attribute.

aaAttributeName :: Lens' AccountAttribute (Maybe Text) Source

The name of the account attribute.

AccountAttributeValue

accountAttributeValue :: AccountAttributeValue Source

Creates a value of AccountAttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ActiveInstance

activeInstance :: ActiveInstance Source

Creates a value of ActiveInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aiInstanceId :: Lens' ActiveInstance (Maybe Text) Source

The ID of the instance.

aiSpotInstanceRequestId :: Lens' ActiveInstance (Maybe Text) Source

The ID of the Spot Instance request.

Address

data Address Source

Describes an Elastic IP address.

See: address smart constructor.

address :: Address Source

Creates a value of Address with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aAssociationId :: Lens' Address (Maybe Text) Source

The ID representing the association of the address with an instance in a VPC.

aInstanceId :: Lens' Address (Maybe Text) Source

The ID of the instance that the address is associated with (if any).

aNetworkInterfaceOwnerId :: Lens' Address (Maybe Text) Source

The ID of the AWS account that owns the network interface.

aAllocationId :: Lens' Address (Maybe Text) Source

The ID representing the allocation of the address for use with EC2-VPC.

aDomain :: Lens' Address (Maybe DomainType) Source

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

aNetworkInterfaceId :: Lens' Address (Maybe Text) Source

The ID of the network interface.

aPrivateIPAddress :: Lens' Address (Maybe Text) Source

The private IP address associated with the Elastic IP address.

aPublicIP :: Lens' Address (Maybe Text) Source

The Elastic IP address.

AttributeBooleanValue

attributeBooleanValue :: AttributeBooleanValue Source

Creates a value of AttributeBooleanValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

abvValue :: Lens' AttributeBooleanValue (Maybe Bool) Source

Valid values are true or false.

AttributeValue

attributeValue :: AttributeValue Source

Creates a value of AttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

avValue :: Lens' AttributeValue (Maybe Text) Source

Valid values are case-sensitive and vary by action.

AvailabilityZone

availabilityZone :: AvailabilityZone Source

Creates a value of AvailabilityZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

azState :: Lens' AvailabilityZone (Maybe AvailabilityZoneState) Source

The state of the Availability Zone (available | impaired | unavailable).

azRegionName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the region.

azZoneName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the Availability Zone.

azMessages :: Lens' AvailabilityZone [AvailabilityZoneMessage] Source

Any messages about the Availability Zone.

AvailabilityZoneMessage

availabilityZoneMessage :: AvailabilityZoneMessage Source

Creates a value of AvailabilityZoneMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

azmMessage :: Lens' AvailabilityZoneMessage (Maybe Text) Source

The message about the Availability Zone.

BlobAttributeValue

blobAttributeValue :: BlobAttributeValue Source

Creates a value of BlobAttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bavValue :: Lens' BlobAttributeValue (Maybe ByteString) Source

Undocumented member.

Note: This Lens automatically encodes and decodes Base64 data, despite what the AWS documentation might say. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

BlockDeviceMapping

blockDeviceMapping Source

Creates a value of BlockDeviceMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bdmVirtualName :: Lens' BlockDeviceMapping (Maybe Text) Source

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

bdmNoDevice :: Lens' BlockDeviceMapping (Maybe Text) Source

Suppresses the specified device included in the block device mapping of the AMI.

bdmEBS :: Lens' BlockDeviceMapping (Maybe EBSBlockDevice) Source

Parameters used to automatically set up EBS volumes when the instance is launched.

bdmDeviceName :: Lens' BlockDeviceMapping Text Source

The device name exposed to the instance (for example, '\/dev\/sdh' or xvdh).

BundleTask

bundleTask Source

Creates a value of BundleTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

btBundleTaskError :: Lens' BundleTask (Maybe BundleTaskError) Source

If the task fails, a description of the error.

btBundleId :: Lens' BundleTask Text Source

The ID of the bundle task.

btInstanceId :: Lens' BundleTask Text Source

The ID of the instance associated with this bundle task.

btProgress :: Lens' BundleTask Text Source

The level of task completion, as a percent (for example, 20%).

btStartTime :: Lens' BundleTask UTCTime Source

The time this task started.

btState :: Lens' BundleTask BundleTaskState Source

The state of the task.

btStorage :: Lens' BundleTask Storage Source

The Amazon S3 storage locations.

btUpdateTime :: Lens' BundleTask UTCTime Source

The time of the most recent update for the task.

BundleTaskError

bundleTaskError :: BundleTaskError Source

Creates a value of BundleTaskError with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

CancelSpotFleetRequestsError

cancelSpotFleetRequestsError Source

Creates a value of CancelSpotFleetRequestsError with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csfreMessage :: Lens' CancelSpotFleetRequestsError Text Source

The description for the error code.

CancelSpotFleetRequestsErrorItem

cancelSpotFleetRequestsErrorItem Source

Creates a value of CancelSpotFleetRequestsErrorItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

CancelSpotFleetRequestsSuccessItem

CancelledSpotInstanceRequest

cancelledSpotInstanceRequest :: CancelledSpotInstanceRequest Source

Creates a value of CancelledSpotInstanceRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ClassicLinkInstance

classicLinkInstance :: ClassicLinkInstance Source

Creates a value of ClassicLinkInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cliTags :: Lens' ClassicLinkInstance [Tag] Source

Any tags assigned to the instance.

ClientData

data ClientData Source

Describes the client-specific data.

See: clientData smart constructor.

clientData :: ClientData Source

Creates a value of ClientData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cdUploadStart :: Lens' ClientData (Maybe UTCTime) Source

The time that the disk upload starts.

cdUploadSize :: Lens' ClientData (Maybe Double) Source

The size of the uploaded disk image, in GiB.

cdUploadEnd :: Lens' ClientData (Maybe UTCTime) Source

The time that the disk upload ends.

cdComment :: Lens' ClientData (Maybe Text) Source

A user-defined comment about the disk upload.

ConversionTask

conversionTask Source

Creates a value of ConversionTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ctImportInstance :: Lens' ConversionTask (Maybe ImportInstanceTaskDetails) Source

If the task is for importing an instance, this contains information about the import instance task.

ctStatusMessage :: Lens' ConversionTask (Maybe Text) Source

The status message related to the conversion task.

ctImportVolume :: Lens' ConversionTask (Maybe ImportVolumeTaskDetails) Source

If the task is for importing a volume, this contains information about the import volume task.

ctExpirationTime :: Lens' ConversionTask (Maybe Text) Source

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

ctTags :: Lens' ConversionTask [Tag] Source

Any tags assigned to the task.

ctConversionTaskId :: Lens' ConversionTask Text Source

The ID of the conversion task.

ctState :: Lens' ConversionTask ConversionTaskState Source

The state of the conversion task.

CreateVolumePermission

createVolumePermission :: CreateVolumePermission Source

Creates a value of CreateVolumePermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cvpGroup :: Lens' CreateVolumePermission (Maybe PermissionGroup) Source

The specific group that is to be added or removed from a volume's list of create volume permissions.

cvpUserId :: Lens' CreateVolumePermission (Maybe Text) Source

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

CreateVolumePermissionModifications

createVolumePermissionModifications :: CreateVolumePermissionModifications Source

Creates a value of CreateVolumePermissionModifications with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cvpmRemove :: Lens' CreateVolumePermissionModifications [CreateVolumePermission] Source

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

cvpmAdd :: Lens' CreateVolumePermissionModifications [CreateVolumePermission] Source

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

CustomerGateway

customerGateway Source

Creates a value of CustomerGateway with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cgTags :: Lens' CustomerGateway [Tag] Source

Any tags assigned to the customer gateway.

cgBGPASN :: Lens' CustomerGateway Text Source

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

cgCustomerGatewayId :: Lens' CustomerGateway Text Source

The ID of the customer gateway.

cgIPAddress :: Lens' CustomerGateway Text Source

The Internet-routable IP address of the customer gateway's outside interface.

cgState :: Lens' CustomerGateway Text Source

The current state of the customer gateway ('pending | available | deleting | deleted').

cgType :: Lens' CustomerGateway Text Source

The type of VPN connection the customer gateway supports ('ipsec.1').

DHCPConfiguration

dhcpConfiguration :: DHCPConfiguration Source

Creates a value of DHCPConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dcValues :: Lens' DHCPConfiguration [AttributeValue] Source

One or more values for the DHCP option.

dcKey :: Lens' DHCPConfiguration (Maybe Text) Source

The name of a DHCP option.

DHCPOptions

dhcpOptions :: DHCPOptions Source

Creates a value of DHCPOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

doDHCPConfigurations :: Lens' DHCPOptions [DHCPConfiguration] Source

One or more DHCP options in the set.

doDHCPOptionsId :: Lens' DHCPOptions (Maybe Text) Source

The ID of the set of DHCP options.

doTags :: Lens' DHCPOptions [Tag] Source

Any tags assigned to the DHCP options set.

DiskImage

data DiskImage Source

Describes a disk image.

See: diskImage smart constructor.

diskImage :: DiskImage Source

Creates a value of DiskImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

diImage :: Lens' DiskImage (Maybe DiskImageDetail) Source

Information about the disk image.

diVolume :: Lens' DiskImage (Maybe VolumeDetail) Source

Information about the volume.

diDescription :: Lens' DiskImage (Maybe Text) Source

A description of the disk image.

DiskImageDescription

diskImageDescription Source

Creates a value of DiskImageDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dChecksum :: Lens' DiskImageDescription (Maybe Text) Source

The checksum computed for the disk image.

dSize :: Lens' DiskImageDescription Integer Source

The size of the disk image, in GiB.

dImportManifestURL :: Lens' DiskImageDescription Text Source

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

DiskImageDetail

diskImageDetail Source

Creates a value of DiskImageDetail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

didBytes :: Lens' DiskImageDetail Integer Source

The size of the disk image, in GiB.

didImportManifestURL :: Lens' DiskImageDetail Text Source

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

DiskImageVolumeDescription

diskImageVolumeDescription Source

Creates a value of DiskImageVolumeDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

divdSize :: Lens' DiskImageVolumeDescription (Maybe Integer) Source

The size of the volume, in GiB.

EBSBlockDevice

ebsBlockDevice :: EBSBlockDevice Source

Creates a value of EBSBlockDevice with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ebdDeleteOnTermination :: Lens' EBSBlockDevice (Maybe Bool) Source

Indicates whether the EBS volume is deleted on instance termination.

ebdVolumeSize :: Lens' EBSBlockDevice (Maybe Int) Source

The size of the volume, in GiB.

Constraints: '1-1024' for standard volumes, '1-16384' for gp2 volumes, and '4-16384' for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

ebdIOPS :: Lens' EBSBlockDevice (Maybe Int) Source

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

ebdEncrypted :: Lens' EBSBlockDevice (Maybe Bool) Source

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

ebdVolumeType :: Lens' EBSBlockDevice (Maybe VolumeType) Source

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

ebdSnapshotId :: Lens' EBSBlockDevice (Maybe Text) Source

The ID of the snapshot.

EBSInstanceBlockDevice

ebsInstanceBlockDevice :: EBSInstanceBlockDevice Source

Creates a value of EBSInstanceBlockDevice with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eibdDeleteOnTermination :: Lens' EBSInstanceBlockDevice (Maybe Bool) Source

Indicates whether the volume is deleted on instance termination.

eibdAttachTime :: Lens' EBSInstanceBlockDevice (Maybe UTCTime) Source

The time stamp when the attachment initiated.

EBSInstanceBlockDeviceSpecification

ebsInstanceBlockDeviceSpecification :: EBSInstanceBlockDeviceSpecification Source

Creates a value of EBSInstanceBlockDeviceSpecification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eibdsDeleteOnTermination :: Lens' EBSInstanceBlockDeviceSpecification (Maybe Bool) Source

Indicates whether the volume is deleted on instance termination.

EventInformation

eventInformation :: EventInformation Source

Creates a value of EventInformation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eiInstanceId :: Lens' EventInformation (Maybe Text) Source

The ID of the instance. This information is available only for instanceChange events.

eiEventDescription :: Lens' EventInformation (Maybe Text) Source

The description of the event.

eiEventSubType :: Lens' EventInformation (Maybe Text) Source

The event.

The following are the error events.

  • iamFleetRoleInvalid - Spot fleet did not have the required permissions either to launch or terminate an instance.
  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description.
  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot Instances.
  • cancelled - The Spot fleet is canceled and has no running Spot Instances. The Spot fleet will be deleted two days after its instances were terminated.
  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot Instances, but its existing Spot Instances will continue to run until they are interrupted or terminated.
  • cancelled_terminating - The Spot fleet is canceled and its Spot Instances are terminating.
  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.
  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.
  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot Instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.
  • terminated - An instance was terminated by the user.

ExportTask

data ExportTask Source

Describes an instance export task.

See: exportTask smart constructor.

etDescription :: Lens' ExportTask Text Source

A description of the resource being exported.

etExportTaskId :: Lens' ExportTask Text Source

The ID of the export task.

etExportToS3Task :: Lens' ExportTask ExportToS3Task Source

Information about the export task.

etInstanceExportDetails :: Lens' ExportTask InstanceExportDetails Source

Information about the instance to export.

etState :: Lens' ExportTask ExportTaskState Source

The state of the export task.

etStatusMessage :: Lens' ExportTask Text Source

The status message related to the export task.

ExportToS3Task

data ExportToS3Task Source

Describes the format and location for an instance export task.

See: exportToS3Task smart constructor.

exportToS3Task :: ExportToS3Task Source

Creates a value of ExportToS3Task with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

etstS3Key :: Lens' ExportToS3Task (Maybe Text) Source

The encryption key for your S3 bucket.

etstContainerFormat :: Lens' ExportToS3Task (Maybe ContainerFormat) Source

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

etstS3Bucket :: Lens' ExportToS3Task (Maybe Text) Source

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account 'vm-import-export\'amazon.com'.

etstDiskImageFormat :: Lens' ExportToS3Task (Maybe DiskImageFormat) Source

The format for the exported image.

ExportToS3TaskSpecification

exportToS3TaskSpecification :: ExportToS3TaskSpecification Source

Creates a value of ExportToS3TaskSpecification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

etstsContainerFormat :: Lens' ExportToS3TaskSpecification (Maybe ContainerFormat) Source

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

etstsS3Prefix :: Lens' ExportToS3TaskSpecification (Maybe Text) Source

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

etstsS3Bucket :: Lens' ExportToS3TaskSpecification (Maybe Text) Source

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account 'vm-import-export\'amazon.com'.

Filter

data Filter Source

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

See: filter' smart constructor.

filter' Source

Arguments

:: Text

fName

-> Filter 

Creates a value of Filter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fValues :: Lens' Filter [Text] Source

One or more filter values. Filter values are case-sensitive.

fName :: Lens' Filter Text Source

The name of the filter. Filter names are case-sensitive.

FlowLog

data FlowLog Source

Describes a flow log.

See: flowLog smart constructor.

flowLog :: FlowLog Source

Creates a value of FlowLog with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

flCreationTime :: Lens' FlowLog (Maybe UTCTime) Source

The date and time the flow log was created.

flResourceId :: Lens' FlowLog (Maybe Text) Source

The ID of the resource on which the flow log was created.

flFlowLogStatus :: Lens' FlowLog (Maybe Text) Source

The status of the flow log (ACTIVE).

flTrafficType :: Lens' FlowLog (Maybe TrafficType) Source

The type of traffic captured for the flow log.

flDeliverLogsStatus :: Lens' FlowLog (Maybe Text) Source

The status of the logs delivery (SUCCESS | FAILED).

flDeliverLogsErrorMessage :: Lens' FlowLog (Maybe Text) Source

Information about the error that occurred. 'Rate limited' indicates that CloudWatch logs throttling has been applied for one or more network interfaces. 'Access error' indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. 'Unknown error' indicates an internal error.

flLogGroupName :: Lens' FlowLog (Maybe Text) Source

The name of the flow log group.

flDeliverLogsPermissionARN :: Lens' FlowLog (Maybe Text) Source

The ARN of the IAM role that posts logs to CloudWatch Logs.

flFlowLogId :: Lens' FlowLog (Maybe Text) Source

The flow log ID.

GroupIdentifier

groupIdentifier :: GroupIdentifier Source

Creates a value of GroupIdentifier with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

giGroupId :: Lens' GroupIdentifier (Maybe Text) Source

The ID of the security group.

giGroupName :: Lens' GroupIdentifier (Maybe Text) Source

The name of the security group.

HistoryRecord

data HistoryRecord Source

Describes an event in the history of the Spot fleet request.

See: historyRecord smart constructor.

historyRecord Source

Creates a value of HistoryRecord with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hrTimestamp :: Lens' HistoryRecord UTCTime Source

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

hrEventType :: Lens' HistoryRecord EventType Source

The event type.

  • error - Indicates an error with the Spot fleet request.
  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.
  • instanceChange - Indicates that an instance was launched or terminated.

IAMInstanceProfile

iamInstanceProfile :: IAMInstanceProfile Source

Creates a value of IAMInstanceProfile with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iapARN :: Lens' IAMInstanceProfile (Maybe Text) Source

The Amazon Resource Name (ARN) of the instance profile.

iapId :: Lens' IAMInstanceProfile (Maybe Text) Source

The ID of the instance profile.

IAMInstanceProfileSpecification

iamInstanceProfileSpecification :: IAMInstanceProfileSpecification Source

Creates a value of IAMInstanceProfileSpecification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iapsARN :: Lens' IAMInstanceProfileSpecification (Maybe Text) Source

The Amazon Resource Name (ARN) of the instance profile.

iapsName :: Lens' IAMInstanceProfileSpecification (Maybe Text) Source

The name of the instance profile.

ICMPTypeCode

icmpTypeCode :: ICMPTypeCode Source

Creates a value of ICMPTypeCode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

itcCode :: Lens' ICMPTypeCode (Maybe Int) Source

The ICMP type. A value of -1 means all types.

itcType :: Lens' ICMPTypeCode (Maybe Int) Source

The ICMP code. A value of -1 means all codes for the specified ICMP type.

IPPermission

ipPermission Source

Creates a value of IPPermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ipFromPort :: Lens' IPPermission (Maybe Int) Source

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of '-1' indicates all ICMP types.

ipUserIdGroupPairs :: Lens' IPPermission [UserIdGroupPair] Source

One or more security group and AWS account ID pairs.

ipPrefixListIds :: Lens' IPPermission [PrefixListId] Source

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

ipToPort :: Lens' IPPermission (Maybe Int) Source

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of '-1' indicates all ICMP codes for the specified ICMP type.

ipIPRanges :: Lens' IPPermission [IPRange] Source

One or more IP ranges.

ipIPProtocol :: Lens' IPPermission Text Source

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use '-1' to specify all.

IPRange

data IPRange Source

Describes an IP range.

See: ipRange smart constructor.