Api-Ec2-2016-11-15 - AWS SDK for PHP V3

Service ID: ec2

Version: 2016-11-15

This page describes the parameters and results for the operations of the Amazon Elastic Compute Cloud (2016-11-15), and shows how to use the Aws\Ec2\Ec2Client object to call the described operations. This documentation is specific to the 2016-11-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptAddressTransfer ( array $params = [] ): Accepts an Elastic IP address transfer.
AcceptCapacityReservationBillingOwnership ( array $params = [] ): Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account.
AcceptReservedInstancesExchangeQuote ( array $params = [] ): Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
AcceptTransitGatewayClientVpnAttachment ( array $params = [] ): Accepts a Transit Gateway attachment request for a Client VPN endpoint.
AcceptTransitGatewayMulticastDomainAssociations ( array $params = [] ): Accepts a request to associate subnets with a transit gateway multicast domain.
AcceptTransitGatewayPeeringAttachment ( array $params = [] ): Accepts a transit gateway peering attachment request.
AcceptTransitGatewayVpcAttachment ( array $params = [] ): Accepts a request to attach a VPC to a transit gateway.
AcceptVpcEndpointConnections ( array $params = [] ): Accepts connection requests to your VPC endpoint service.
AcceptVpcPeeringConnection ( array $params = [] ): Accept a VPC peering connection request.
AdvertiseByoipCidr ( array $params = [] ): Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
AllocateAddress ( array $params = [] ): Allocates an Elastic IP address to your Amazon Web Services account.
AllocateHosts ( array $params = [] ): Allocates a Dedicated Host to your account.
AllocateIpamPoolCidr ( array $params = [] ): Allocate a CIDR from an IPAM pool.
ApplySecurityGroupsToClientVpnTargetNetwork ( array $params = [] ): Applies a security group to the association between the target network and the Client VPN endpoint.
AssignIpv6Addresses ( array $params = [] ): Assigns the specified IPv6 addresses to the specified network interface.
AssignPrivateIpAddresses ( array $params = [] ): Assigns the specified secondary private IP addresses to the specified network interface.
AssignPrivateNatGatewayAddress ( array $params = [] ): Assigns private IPv4 addresses to a private NAT gateway.
AssociateAddress ( array $params = [] ): Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface.
AssociateApplicationStatusCheck ( array $params = [] ): Associates an application status check with instances or tags.
AssociateCapacityReservationBillingOwner ( array $params = [] ): Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account.
AssociateClientVpnTargetNetwork ( array $params = [] ): Associates a target network with a Client VPN endpoint.
AssociateDhcpOptions ( array $params = [] ): Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
AssociateEnclaveCertificateIamRole ( array $params = [] ): Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate.
AssociateIamInstanceProfile ( array $params = [] ): Associates an IAM instance profile with a running or stopped instance.
AssociateInstanceEventWindow ( array $params = [] ): Associates one or more targets with an event window.
AssociateIpamByoasn ( array $params = [] ): Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region.
AssociateIpamResourceDiscovery ( array $params = [] ): Associates an IPAM resource discovery with an Amazon VPC IPAM.
AssociateNatGatewayAddress ( array $params = [] ): Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway.
AssociateRouteServer ( array $params = [] ): Associates a route server with a VPC to enable dynamic route updates.
AssociateRouteTable ( array $params = [] ): Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC.
AssociateSecurityGroupVpc ( array $params = [] ): Associates a security group with another VPC in the same Region.
AssociateSubnetCidrBlock ( array $params = [] ): Associates a CIDR block with your subnet.
AssociateTransitGatewayMulticastDomain ( array $params = [] ): Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
AssociateTransitGatewayPolicyTable ( array $params = [] ): Associates the specified transit gateway attachment with a transit gateway policy table.
AssociateTransitGatewayRouteTable ( array $params = [] ): Associates the specified attachment with the specified transit gateway route table.
AssociateTrunkInterface ( array $params = [] ): Associates a branch network interface with a trunk network interface.
AssociateVpcCidrBlock ( array $params = [] ): Associates a CIDR block with your VPC.
AttachClassicLinkVpc ( array $params = [] ): This action is deprecated.
AttachImageWatermark ( array $params = [] ): Attaches a watermark to a non-public AMI.
AttachInternetGateway ( array $params = [] ): Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
AttachNetworkInterface ( array $params = [] ): Attaches a network interface to an instance.
AttachVerifiedAccessTrustProvider ( array $params = [] ): Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
AttachVolume ( array $params = [] ): Attaches an Amazon EBS volume to a running or stopped instance, and exposes it to the instance with the specified device name.
AttachVpnGateway ( array $params = [] ): Attaches an available virtual private gateway to a VPC.
AuthorizeClientVpnIngress ( array $params = [] ): Adds an ingress authorization rule to a Client VPN endpoint.
AuthorizeSecurityGroupEgress ( array $params = [] ): Adds the specified outbound (egress) rules to a security group.
AuthorizeSecurityGroupIngress ( array $params = [] ): Adds the specified inbound (ingress) rules to a security group.
BatchModifyIpamRoutingPolicyRegistrations ( array $params = [] ): Modifies multiple routing policy registrations in a single operation.
BundleInstance ( array $params = [] ): Bundles an Amazon instance store-backed Windows instance.
CancelBundleTask ( array $params = [] ): Cancels a bundling operation for an instance store-backed Windows instance.
CancelCapacityReservation ( array $params = [] ): Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.
CancelCapacityReservationFleets ( array $params = [] ): Cancels one or more Capacity Reservation Fleets.
CancelConversionTask ( array $params = [] ): Cancels an active conversion task.
CancelDeclarativePoliciesReport ( array $params = [] ): Cancels the generation of an account status report.
CancelExportTask ( array $params = [] ): Cancels an active export task.
CancelImageLaunchPermission ( array $params = [] ): Removes your Amazon Web Services account from the launch permissions for the specified AMI.
CancelImportTask ( array $params = [] ): Cancels an in-process import virtual machine or import snapshot task.
CancelReservedInstancesListing ( array $params = [] ): Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
CancelSpotFleetRequests ( array $params = [] ): Cancels the specified Spot Fleet requests.
CancelSpotInstanceRequests ( array $params = [] ): Cancels one or more Spot Instance requests.
ConfirmProductInstance ( array $params = [] ): Determines whether a product code is associated with an instance.
CopyFpgaImage ( array $params = [] ): Copies the specified Amazon FPGA Image (AFI) to the current Region.
CopyImage ( array $params = [] ): Initiates an AMI copy operation.
CopySnapshot ( array $params = [] ): Creates an exact copy of an Amazon EBS snapshot.
CopyVolumes ( array $params = [] ): Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone.
CreateApplicationStatusCheck ( array $params = [] ): Creates an application status check for monitoring the health of applications running on your instances.
CreateCapacityManagerDataExport ( array $params = [] ): Creates a new data export configuration for EC2 Capacity Manager.
CreateCapacityReservation ( array $params = [] ): Creates a new Capacity Reservation with the specified attributes.
CreateCapacityReservationBySplitting ( array $params = [] ): Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation.
CreateCapacityReservationCancellationQuote ( array $params = [] ): Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration.
CreateCapacityReservationFleet ( array $params = [] ): Creates a Capacity Reservation Fleet.
CreateCarrierGateway ( array $params = [] ): Creates a carrier gateway.
CreateClientVpnEndpoint ( array $params = [] ): Creates a Client VPN endpoint.
CreateClientVpnRoute ( array $params = [] ): Adds a route to a network to a Client VPN endpoint.
CreateCoipCidr ( array $params = [] ): Creates a range of customer-owned IP addresses.
CreateCoipPool ( array $params = [] ): Creates a pool of customer-owned IP (CoIP) addresses.
CreateCustomerGateway ( array $params = [] ): Provides information to Amazon Web Services about your customer gateway device.
CreateDefaultSubnet ( array $params = [] ): Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC.
CreateDefaultVpc ( array $params = [] ): Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone.
CreateDelegateMacVolumeOwnershipTask ( array $params = [] ): Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.
CreateDhcpOptions ( array $params = [] ): Creates a custom set of DHCP options.
CreateEgressOnlyInternetGateway ( array $params = [] ): [IPv6 only] Creates an egress-only internet gateway for your VPC.
CreateFleet ( array $params = [] ): Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances.
CreateFlowLogs ( array $params = [] ): Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
CreateFpgaImage ( array $params = [] ): Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
CreateImage ( array $params = [] ): Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
CreateImageUsageReport ( array $params = [] ): Creates a report that shows how your image is used across other Amazon Web Services accounts.
CreateInstanceConnectEndpoint ( array $params = [] ): Creates an EC2 Instance Connect Endpoint.
CreateInstanceEventWindow ( array $params = [] ): Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
CreateInstanceExportTask ( array $params = [] ): Exports a running or stopped instance to an Amazon S3 bucket.
CreateInternetGateway ( array $params = [] ): Creates an internet gateway for use with a VPC.
CreateInterruptibleCapacityReservationAllocation ( array $params = [] ): Creates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation.
CreateIpam ( array $params = [] ): Create an IPAM.
CreateIpamExternalResourceVerificationToken ( array $params = [] ): Create a verification token.
CreateIpamInternetRegistryAssociation ( array $params = [] ): Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management.
CreateIpamPolicy ( array $params = [] ): Creates an IPAM policy.
CreateIpamPool ( array $params = [] ): Create an IP address pool for Amazon VPC IP Address Manager (IPAM).
CreateIpamPrefixListResolver ( array $params = [] ): Creates an IPAM prefix list resolver.
CreateIpamPrefixListResolverTarget ( array $params = [] ): Creates an IPAM prefix list resolver target.
CreateIpamResourceDiscovery ( array $params = [] ): Creates an IPAM resource discovery.
CreateIpamRoutingPolicyRegistration ( array $params = [] ): Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
CreateIpamScope ( array $params = [] ): Create an IPAM scope.
CreateKeyPair ( array $params = [] ): Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified format.
CreateLaunchTemplate ( array $params = [] ): Creates a launch template.
CreateLaunchTemplateVersion ( array $params = [] ): Creates a new version of a launch template.
CreateLocalGatewayRoute ( array $params = [] ): Creates a static route for the specified local gateway route table.
CreateLocalGatewayRouteTable ( array $params = [] ): Creates a local gateway route table.
CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation ( array $params = [] ): Creates a local gateway route table virtual interface group association.
CreateLocalGatewayRouteTableVpcAssociation ( array $params = [] ): Associates the specified VPC with the specified local gateway route table.
CreateLocalGatewayVirtualInterface ( array $params = [] ): Create a virtual interface for a local gateway.
CreateLocalGatewayVirtualInterfaceGroup ( array $params = [] ): Create a local gateway virtual interface group.
CreateMacSystemIntegrityProtectionModificationTask ( array $params = [] ): Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance.
CreateManagedPrefixList ( array $params = [] ): Creates a managed prefix list.
CreateNatGateway ( array $params = [] ): Creates a NAT gateway in the specified subnet.
CreateNetworkAcl ( array $params = [] ): Creates a network ACL in a VPC.
CreateNetworkAclEntry ( array $params = [] ): Creates an entry (a rule) in a network ACL with the specified rule number.
CreateNetworkInsightsAccessScope ( array $params = [] ): Creates a Network Access Scope.
CreateNetworkInsightsPath ( array $params = [] ): Creates a path to analyze for reachability.
CreateNetworkInterface ( array $params = [] ): Creates a network interface in the specified subnet.
CreateNetworkInterfacePermission ( array $params = [] ): Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
CreatePlacementGroup ( array $params = [] ): Creates a placement group in which to launch instances.
CreatePublicIpv4Pool ( array $params = [] ): Creates a public IPv4 address pool.
CreateReplaceRootVolumeTask ( array $params = [] ): Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, that is restored from an AMI that has the same key characteristics as that of the instance, or that is replaced by a specified volume.
CreateReservedInstancesListing ( array $params = [] ): Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.
CreateRestoreImageTask ( array $params = [] ): Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
CreateRoute ( array $params = [] ): Creates a route in a route table within a VPC.
CreateRouteServer ( array $params = [] ): Creates a new route server to manage dynamic routing in a VPC.
CreateRouteServerEndpoint ( array $params = [] ): Creates a new endpoint for a route server in a specified subnet.
CreateRouteServerPeer ( array $params = [] ): Creates a new BGP peer for a specified route server endpoint.
CreateRouteTable ( array $params = [] ): Creates a route table for the specified VPC.
CreateSecondaryNetwork ( array $params = [] ): Creates a secondary network.

Amazon Elastic Compute Cloud 2016-11-15

Operation Summary