Class: Aws::EC2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EC2::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb
Overview
An API client for EC2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::EC2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_address_transfer(params = {}) ⇒ Types::AcceptAddressTransferResult
Accepts an Elastic IP address transfer.
-
#accept_reserved_instances_exchange_quote(params = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
-
#accept_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::AcceptTransitGatewayMulticastDomainAssociationsResult
Accepts a request to associate subnets with a transit gateway multicast domain.
-
#accept_transit_gateway_peering_attachment(params = {}) ⇒ Types::AcceptTransitGatewayPeeringAttachmentResult
Accepts a transit gateway peering attachment request.
-
#accept_transit_gateway_vpc_attachment(params = {}) ⇒ Types::AcceptTransitGatewayVpcAttachmentResult
Accepts a request to attach a VPC to a transit gateway.
-
#accept_vpc_endpoint_connections(params = {}) ⇒ Types::AcceptVpcEndpointConnectionsResult
Accepts connection requests to your VPC endpoint service.
-
#accept_vpc_peering_connection(params = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
Accept a VPC peering connection request.
-
#advertise_byoip_cidr(params = {}) ⇒ Types::AdvertiseByoipCidrResult
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).
-
#allocate_address(params = {}) ⇒ Types::AllocateAddressResult
Allocates an Elastic IP address to your Amazon Web Services account.
-
#allocate_hosts(params = {}) ⇒ Types::AllocateHostsResult
Allocates a Dedicated Host to your account.
-
#allocate_ipam_pool_cidr(params = {}) ⇒ Types::AllocateIpamPoolCidrResult
Allocate a CIDR from an IPAM pool.
-
#apply_security_groups_to_client_vpn_target_network(params = {}) ⇒ Types::ApplySecurityGroupsToClientVpnTargetNetworkResult
Applies a security group to the association between the target network and the Client VPN endpoint.
-
#assign_ipv_6_addresses(params = {}) ⇒ Types::AssignIpv6AddressesResult
Assigns one or more IPv6 addresses to the specified network interface.
-
#assign_private_ip_addresses(params = {}) ⇒ Types::AssignPrivateIpAddressesResult
Assigns one or more secondary private IP addresses to the specified network interface.
-
#assign_private_nat_gateway_address(params = {}) ⇒ Types::AssignPrivateNatGatewayAddressResult
Assigns private IPv4 addresses to a private NAT gateway.
-
#associate_address(params = {}) ⇒ Types::AssociateAddressResult
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.
-
#associate_client_vpn_target_network(params = {}) ⇒ Types::AssociateClientVpnTargetNetworkResult
Associates a target network with a Client VPN endpoint.
-
#associate_dhcp_options(params = {}) ⇒ Struct
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
-
#associate_enclave_certificate_iam_role(params = {}) ⇒ Types::AssociateEnclaveCertificateIamRoleResult
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate.
-
#associate_iam_instance_profile(params = {}) ⇒ Types::AssociateIamInstanceProfileResult
Associates an IAM instance profile with a running or stopped instance.
-
#associate_instance_event_window(params = {}) ⇒ Types::AssociateInstanceEventWindowResult
Associates one or more targets with an event window.
-
#associate_ipam_byoasn(params = {}) ⇒ Types::AssociateIpamByoasnResult
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region.
-
#associate_ipam_resource_discovery(params = {}) ⇒ Types::AssociateIpamResourceDiscoveryResult
Associates an IPAM resource discovery with an Amazon VPC IPAM.
-
#associate_nat_gateway_address(params = {}) ⇒ Types::AssociateNatGatewayAddressResult
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway.
-
#associate_route_table(params = {}) ⇒ Types::AssociateRouteTableResult
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.
-
#associate_subnet_cidr_block(params = {}) ⇒ Types::AssociateSubnetCidrBlockResult
Associates a CIDR block with your subnet.
-
#associate_transit_gateway_multicast_domain(params = {}) ⇒ Types::AssociateTransitGatewayMulticastDomainResult
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
-
#associate_transit_gateway_policy_table(params = {}) ⇒ Types::AssociateTransitGatewayPolicyTableResult
Associates the specified transit gateway attachment with a transit gateway policy table.
-
#associate_transit_gateway_route_table(params = {}) ⇒ Types::AssociateTransitGatewayRouteTableResult
Associates the specified attachment with the specified transit gateway route table.
-
#associate_trunk_interface(params = {}) ⇒ Types::AssociateTrunkInterfaceResult
Associates a branch network interface with a trunk network interface.
-
#associate_vpc_cidr_block(params = {}) ⇒ Types::AssociateVpcCidrBlockResult
Associates a CIDR block with your VPC.
-
#attach_classic_link_vpc(params = {}) ⇒ Types::AttachClassicLinkVpcResult
This action is deprecated. -
#attach_internet_gateway(params = {}) ⇒ Struct
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
-
#attach_network_interface(params = {}) ⇒ Types::AttachNetworkInterfaceResult
Attaches a network interface to an instance.
-
#attach_verified_access_trust_provider(params = {}) ⇒ Types::AttachVerifiedAccessTrustProviderResult
Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
-
#attach_volume(params = {}) ⇒ Types::VolumeAttachment
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
-
#attach_vpn_gateway(params = {}) ⇒ Types::AttachVpnGatewayResult
Attaches a virtual private gateway to a VPC.
-
#authorize_client_vpn_ingress(params = {}) ⇒ Types::AuthorizeClientVpnIngressResult
Adds an ingress authorization rule to a Client VPN endpoint.
-
#authorize_security_group_egress(params = {}) ⇒ Types::AuthorizeSecurityGroupEgressResult
Adds the specified outbound (egress) rules to a security group.
-
#authorize_security_group_ingress(params = {}) ⇒ Types::AuthorizeSecurityGroupIngressResult
Adds the specified inbound (ingress) rules to a security group.
-
#bundle_instance(params = {}) ⇒ Types::BundleInstanceResult
Bundles an Amazon instance store-backed Windows instance.
-
#cancel_bundle_task(params = {}) ⇒ Types::CancelBundleTaskResult
Cancels a bundling operation for an instance store-backed Windows instance.
-
#cancel_capacity_reservation(params = {}) ⇒ Types::CancelCapacityReservationResult
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to
cancelled
. -
#cancel_capacity_reservation_fleets(params = {}) ⇒ Types::CancelCapacityReservationFleetsResult
Cancels one or more Capacity Reservation Fleets.
-
#cancel_conversion_task(params = {}) ⇒ Struct
Cancels an active conversion task.
-
#cancel_export_task(params = {}) ⇒ Struct
Cancels an active export task.
-
#cancel_image_launch_permission(params = {}) ⇒ Types::CancelImageLaunchPermissionResult
Removes your Amazon Web Services account from the launch permissions for the specified AMI.
-
#cancel_import_task(params = {}) ⇒ Types::CancelImportTaskResult
Cancels an in-process import virtual machine or import snapshot task.
-
#cancel_reserved_instances_listing(params = {}) ⇒ Types::CancelReservedInstancesListingResult
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
-
#cancel_spot_fleet_requests(params = {}) ⇒ Types::CancelSpotFleetRequestsResponse
Cancels the specified Spot Fleet requests.
-
#cancel_spot_instance_requests(params = {}) ⇒ Types::CancelSpotInstanceRequestsResult
Cancels one or more Spot Instance requests.
-
#confirm_product_instance(params = {}) ⇒ Types::ConfirmProductInstanceResult
Determines whether a product code is associated with an instance.
-
#copy_fpga_image(params = {}) ⇒ Types::CopyFpgaImageResult
Copies the specified Amazon FPGA Image (AFI) to the current Region.
-
#copy_image(params = {}) ⇒ Types::CopyImageResult
Initiates the copy of an AMI.
-
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.
-
#create_capacity_reservation(params = {}) ⇒ Types::CreateCapacityReservationResult
Creates a new Capacity Reservation with the specified attributes.
-
#create_capacity_reservation_fleet(params = {}) ⇒ Types::CreateCapacityReservationFleetResult
Creates a Capacity Reservation Fleet.
-
#create_carrier_gateway(params = {}) ⇒ Types::CreateCarrierGatewayResult
Creates a carrier gateway.
-
#create_client_vpn_endpoint(params = {}) ⇒ Types::CreateClientVpnEndpointResult
Creates a Client VPN endpoint.
-
#create_client_vpn_route(params = {}) ⇒ Types::CreateClientVpnRouteResult
Adds a route to a network to a Client VPN endpoint.
-
#create_coip_cidr(params = {}) ⇒ Types::CreateCoipCidrResult
Creates a range of customer-owned IP addresses.
-
#create_coip_pool(params = {}) ⇒ Types::CreateCoipPoolResult
Creates a pool of customer-owned IP (CoIP) addresses.
-
#create_customer_gateway(params = {}) ⇒ Types::CreateCustomerGatewayResult
Provides information to Amazon Web Services about your customer gateway device.
-
#create_default_subnet(params = {}) ⇒ Types::CreateDefaultSubnetResult
Creates a default subnet with a size
/20
IPv4 CIDR block in the specified Availability Zone in your default VPC. -
#create_default_vpc(params = {}) ⇒ Types::CreateDefaultVpcResult
Creates a default VPC with a size
/16
IPv4 CIDR block and a default subnet in each Availability Zone. -
#create_dhcp_options(params = {}) ⇒ Types::CreateDhcpOptionsResult
Creates a custom set of DHCP options.
-
#create_egress_only_internet_gateway(params = {}) ⇒ Types::CreateEgressOnlyInternetGatewayResult
[IPv6 only] Creates an egress-only internet gateway for your VPC.
-
#create_fleet(params = {}) ⇒ Types::CreateFleetResult
Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances.
-
#create_flow_logs(params = {}) ⇒ Types::CreateFlowLogsResult
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
-
#create_fpga_image(params = {}) ⇒ Types::CreateFpgaImageResult
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
-
#create_image(params = {}) ⇒ Types::CreateImageResult
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
-
#create_instance_connect_endpoint(params = {}) ⇒ Types::CreateInstanceConnectEndpointResult
Creates an EC2 Instance Connect Endpoint.
-
#create_instance_event_window(params = {}) ⇒ Types::CreateInstanceEventWindowResult
Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
-
#create_instance_export_task(params = {}) ⇒ Types::CreateInstanceExportTaskResult
Exports a running or stopped instance to an Amazon S3 bucket.
-
#create_internet_gateway(params = {}) ⇒ Types::CreateInternetGatewayResult
Creates an internet gateway for use with a VPC.
-
#create_ipam(params = {}) ⇒ Types::CreateIpamResult
Create an IPAM.
-
#create_ipam_pool(params = {}) ⇒ Types::CreateIpamPoolResult
Create an IP address pool for Amazon VPC IP Address Manager (IPAM).
-
#create_ipam_resource_discovery(params = {}) ⇒ Types::CreateIpamResourceDiscoveryResult
Creates an IPAM resource discovery.
-
#create_ipam_scope(params = {}) ⇒ Types::CreateIpamScopeResult
Create an IPAM scope.
-
#create_key_pair(params = {}) ⇒ Types::KeyPair
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format.
-
#create_launch_template(params = {}) ⇒ Types::CreateLaunchTemplateResult
Creates a launch template.
-
#create_launch_template_version(params = {}) ⇒ Types::CreateLaunchTemplateVersionResult
Creates a new version of a launch template.
-
#create_local_gateway_route(params = {}) ⇒ Types::CreateLocalGatewayRouteResult
Creates a static route for the specified local gateway route table.
-
#create_local_gateway_route_table(params = {}) ⇒ Types::CreateLocalGatewayRouteTableResult
Creates a local gateway route table.
-
#create_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult
Creates a local gateway route table virtual interface group association.
-
#create_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVpcAssociationResult
Associates the specified VPC with the specified local gateway route table.
-
#create_managed_prefix_list(params = {}) ⇒ Types::CreateManagedPrefixListResult
Creates a managed prefix list.
-
#create_nat_gateway(params = {}) ⇒ Types::CreateNatGatewayResult
Creates a NAT gateway in the specified subnet.
-
#create_network_acl(params = {}) ⇒ Types::CreateNetworkAclResult
Creates a network ACL in a VPC.
-
#create_network_acl_entry(params = {}) ⇒ Struct
Creates an entry (a rule) in a network ACL with the specified rule number.
-
#create_network_insights_access_scope(params = {}) ⇒ Types::CreateNetworkInsightsAccessScopeResult
Creates a Network Access Scope.
-
#create_network_insights_path(params = {}) ⇒ Types::CreateNetworkInsightsPathResult
Creates a path to analyze for reachability.
-
#create_network_interface(params = {}) ⇒ Types::CreateNetworkInterfaceResult
Creates a network interface in the specified subnet.
-
#create_network_interface_permission(params = {}) ⇒ Types::CreateNetworkInterfacePermissionResult
Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
-
#create_placement_group(params = {}) ⇒ Types::CreatePlacementGroupResult
Creates a placement group in which to launch instances.
-
#create_public_ipv_4_pool(params = {}) ⇒ Types::CreatePublicIpv4PoolResult
Creates a public IPv4 address pool.
-
#create_replace_root_volume_task(params = {}) ⇒ Types::CreateReplaceRootVolumeTaskResult
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, or that is restored from an AMI that has the same key characteristics as that of the instance. -
#create_reserved_instances_listing(params = {}) ⇒ Types::CreateReservedInstancesListingResult
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.
-
#create_restore_image_task(params = {}) ⇒ Types::CreateRestoreImageTaskResult
Starts a task that restores an AMI from an Amazon S3 object that was previously created by using [CreateStoreImageTask][1].
-
#create_route(params = {}) ⇒ Types::CreateRouteResult
Creates a route in a route table within a VPC.
-
#create_route_table(params = {}) ⇒ Types::CreateRouteTableResult
Creates a route table for the specified VPC.
-
#create_security_group(params = {}) ⇒ Types::CreateSecurityGroupResult
Creates a security group.
-
#create_snapshot(params = {}) ⇒ Types::Snapshot
Creates a snapshot of an EBS volume and stores it in Amazon S3.
-
#create_snapshots(params = {}) ⇒ Types::CreateSnapshotsResult
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.
-
#create_spot_datafeed_subscription(params = {}) ⇒ Types::CreateSpotDatafeedSubscriptionResult
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.
-
#create_store_image_task(params = {}) ⇒ Types::CreateStoreImageTaskResult
Stores an AMI as a single object in an Amazon S3 bucket.
-
#create_subnet(params = {}) ⇒ Types::CreateSubnetResult
Creates a subnet in the specified VPC.
-
#create_subnet_cidr_reservation(params = {}) ⇒ Types::CreateSubnetCidrReservationResult
Creates a subnet CIDR reservation.
-
#create_tags(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources.
-
#create_traffic_mirror_filter(params = {}) ⇒ Types::CreateTrafficMirrorFilterResult
Creates a Traffic Mirror filter.
-
#create_traffic_mirror_filter_rule(params = {}) ⇒ Types::CreateTrafficMirrorFilterRuleResult
Creates a Traffic Mirror filter rule.
-
#create_traffic_mirror_session(params = {}) ⇒ Types::CreateTrafficMirrorSessionResult
Creates a Traffic Mirror session.
-
#create_traffic_mirror_target(params = {}) ⇒ Types::CreateTrafficMirrorTargetResult
Creates a target for your Traffic Mirror session.
-
#create_transit_gateway(params = {}) ⇒ Types::CreateTransitGatewayResult
Creates a transit gateway.
-
#create_transit_gateway_connect(params = {}) ⇒ Types::CreateTransitGatewayConnectResult
Creates a Connect attachment from a specified transit gateway attachment.
-
#create_transit_gateway_connect_peer(params = {}) ⇒ Types::CreateTransitGatewayConnectPeerResult
Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
-
#create_transit_gateway_multicast_domain(params = {}) ⇒ Types::CreateTransitGatewayMulticastDomainResult
Creates a multicast domain using the specified transit gateway.
-
#create_transit_gateway_peering_attachment(params = {}) ⇒ Types::CreateTransitGatewayPeeringAttachmentResult
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).
-
#create_transit_gateway_policy_table(params = {}) ⇒ Types::CreateTransitGatewayPolicyTableResult
Creates a transit gateway policy table.
-
#create_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::CreateTransitGatewayPrefixListReferenceResult
Creates a reference (route) to a prefix list in a specified transit gateway route table.
-
#create_transit_gateway_route(params = {}) ⇒ Types::CreateTransitGatewayRouteResult
Creates a static route for the specified transit gateway route table.
-
#create_transit_gateway_route_table(params = {}) ⇒ Types::CreateTransitGatewayRouteTableResult
Creates a route table for the specified transit gateway.
-
#create_transit_gateway_route_table_announcement(params = {}) ⇒ Types::CreateTransitGatewayRouteTableAnnouncementResult
Advertises a new transit gateway route table.
-
#create_transit_gateway_vpc_attachment(params = {}) ⇒ Types::CreateTransitGatewayVpcAttachmentResult
Attaches the specified VPC to the specified transit gateway.
-
#create_verified_access_endpoint(params = {}) ⇒ Types::CreateVerifiedAccessEndpointResult
An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
-
#create_verified_access_group(params = {}) ⇒ Types::CreateVerifiedAccessGroupResult
An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements.
-
#create_verified_access_instance(params = {}) ⇒ Types::CreateVerifiedAccessInstanceResult
An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
-
#create_verified_access_trust_provider(params = {}) ⇒ Types::CreateVerifiedAccessTrustProviderResult
A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices.
-
#create_volume(params = {}) ⇒ Types::Volume
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
-
#create_vpc(params = {}) ⇒ Types::CreateVpcResult
Creates a VPC with the specified CIDR blocks.
-
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResult
Creates a VPC endpoint.
-
#create_vpc_endpoint_connection_notification(params = {}) ⇒ Types::CreateVpcEndpointConnectionNotificationResult
Creates a connection notification for a specified VPC endpoint or VPC endpoint service.
-
#create_vpc_endpoint_service_configuration(params = {}) ⇒ Types::CreateVpcEndpointServiceConfigurationResult
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.
-
#create_vpc_peering_connection(params = {}) ⇒ Types::CreateVpcPeeringConnectionResult
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.
-
#create_vpn_connection(params = {}) ⇒ Types::CreateVpnConnectionResult
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway.
-
#create_vpn_connection_route(params = {}) ⇒ Struct
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
#create_vpn_gateway(params = {}) ⇒ Types::CreateVpnGatewayResult
Creates a virtual private gateway.
-
#delete_carrier_gateway(params = {}) ⇒ Types::DeleteCarrierGatewayResult
Deletes a carrier gateway.
-
#delete_client_vpn_endpoint(params = {}) ⇒ Types::DeleteClientVpnEndpointResult
Deletes the specified Client VPN endpoint.
-
#delete_client_vpn_route(params = {}) ⇒ Types::DeleteClientVpnRouteResult
Deletes a route from a Client VPN endpoint.
-
#delete_coip_cidr(params = {}) ⇒ Types::DeleteCoipCidrResult
Deletes a range of customer-owned IP addresses.
-
#delete_coip_pool(params = {}) ⇒ Types::DeleteCoipPoolResult
Deletes a pool of customer-owned IP (CoIP) addresses.
-
#delete_customer_gateway(params = {}) ⇒ Struct
Deletes the specified customer gateway.
-
#delete_dhcp_options(params = {}) ⇒ Struct
Deletes the specified set of DHCP options.
-
#delete_egress_only_internet_gateway(params = {}) ⇒ Types::DeleteEgressOnlyInternetGatewayResult
Deletes an egress-only internet gateway.
-
#delete_fleets(params = {}) ⇒ Types::DeleteFleetsResult
Deletes the specified EC2 Fleets.
-
#delete_flow_logs(params = {}) ⇒ Types::DeleteFlowLogsResult
Deletes one or more flow logs.
-
#delete_fpga_image(params = {}) ⇒ Types::DeleteFpgaImageResult
Deletes the specified Amazon FPGA Image (AFI).
-
#delete_instance_connect_endpoint(params = {}) ⇒ Types::DeleteInstanceConnectEndpointResult
Deletes the specified EC2 Instance Connect Endpoint.
-
#delete_instance_event_window(params = {}) ⇒ Types::DeleteInstanceEventWindowResult
Deletes the specified event window.
-
#delete_internet_gateway(params = {}) ⇒ Struct
Deletes the specified internet gateway.
-
#delete_ipam(params = {}) ⇒ Types::DeleteIpamResult
Delete an IPAM.
-
#delete_ipam_pool(params = {}) ⇒ Types::DeleteIpamPoolResult
Delete an IPAM pool.
-
#delete_ipam_resource_discovery(params = {}) ⇒ Types::DeleteIpamResourceDiscoveryResult
Deletes an IPAM resource discovery.
-
#delete_ipam_scope(params = {}) ⇒ Types::DeleteIpamScopeResult
Delete the scope for an IPAM.
-
#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult
Deletes the specified key pair, by removing the public key from Amazon EC2.
-
#delete_launch_template(params = {}) ⇒ Types::DeleteLaunchTemplateResult
Deletes a launch template.
-
#delete_launch_template_versions(params = {}) ⇒ Types::DeleteLaunchTemplateVersionsResult
Deletes one or more versions of a launch template.
-
#delete_local_gateway_route(params = {}) ⇒ Types::DeleteLocalGatewayRouteResult
Deletes the specified route from the specified local gateway route table.
-
#delete_local_gateway_route_table(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableResult
Deletes a local gateway route table.
-
#delete_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult
Deletes a local gateway route table virtual interface group association.
-
#delete_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVpcAssociationResult
Deletes the specified association between a VPC and local gateway route table.
-
#delete_managed_prefix_list(params = {}) ⇒ Types::DeleteManagedPrefixListResult
Deletes the specified managed prefix list.
-
#delete_nat_gateway(params = {}) ⇒ Types::DeleteNatGatewayResult
Deletes the specified NAT gateway.
-
#delete_network_acl(params = {}) ⇒ Struct
Deletes the specified network ACL.
-
#delete_network_acl_entry(params = {}) ⇒ Struct
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
-
#delete_network_insights_access_scope(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeResult
Deletes the specified Network Access Scope.
-
#delete_network_insights_access_scope_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeAnalysisResult
Deletes the specified Network Access Scope analysis.
-
#delete_network_insights_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAnalysisResult
Deletes the specified network insights analysis.
-
#delete_network_insights_path(params = {}) ⇒ Types::DeleteNetworkInsightsPathResult
Deletes the specified path.
-
#delete_network_interface(params = {}) ⇒ Struct
Deletes the specified network interface.
-
#delete_network_interface_permission(params = {}) ⇒ Types::DeleteNetworkInterfacePermissionResult
Deletes a permission for a network interface.
-
#delete_placement_group(params = {}) ⇒ Struct
Deletes the specified placement group.
-
#delete_public_ipv_4_pool(params = {}) ⇒ Types::DeletePublicIpv4PoolResult
Delete a public IPv4 pool.
-
#delete_queued_reserved_instances(params = {}) ⇒ Types::DeleteQueuedReservedInstancesResult
Deletes the queued purchases for the specified Reserved Instances.
-
#delete_route(params = {}) ⇒ Struct
Deletes the specified route from the specified route table.
-
#delete_route_table(params = {}) ⇒ Struct
Deletes the specified route table.
-
#delete_security_group(params = {}) ⇒ Struct
Deletes a security group.
-
#delete_snapshot(params = {}) ⇒ Struct
Deletes the specified snapshot.
-
#delete_spot_datafeed_subscription(params = {}) ⇒ Struct
Deletes the data feed for Spot Instances.
-
#delete_subnet(params = {}) ⇒ Struct
Deletes the specified subnet.
-
#delete_subnet_cidr_reservation(params = {}) ⇒ Types::DeleteSubnetCidrReservationResult
Deletes a subnet CIDR reservation.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the specified set of tags from the specified set of resources.
-
#delete_traffic_mirror_filter(params = {}) ⇒ Types::DeleteTrafficMirrorFilterResult
Deletes the specified Traffic Mirror filter.
-
#delete_traffic_mirror_filter_rule(params = {}) ⇒ Types::DeleteTrafficMirrorFilterRuleResult
Deletes the specified Traffic Mirror rule.
-
#delete_traffic_mirror_session(params = {}) ⇒ Types::DeleteTrafficMirrorSessionResult
Deletes the specified Traffic Mirror session.
-
#delete_traffic_mirror_target(params = {}) ⇒ Types::DeleteTrafficMirrorTargetResult
Deletes the specified Traffic Mirror target.
-
#delete_transit_gateway(params = {}) ⇒ Types::DeleteTransitGatewayResult
Deletes the specified transit gateway.
-
#delete_transit_gateway_connect(params = {}) ⇒ Types::DeleteTransitGatewayConnectResult
Deletes the specified Connect attachment.
-
#delete_transit_gateway_connect_peer(params = {}) ⇒ Types::DeleteTransitGatewayConnectPeerResult
Deletes the specified Connect peer.
-
#delete_transit_gateway_multicast_domain(params = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult
Deletes the specified transit gateway multicast domain.
-
#delete_transit_gateway_peering_attachment(params = {}) ⇒ Types::DeleteTransitGatewayPeeringAttachmentResult
Deletes a transit gateway peering attachment.
-
#delete_transit_gateway_policy_table(params = {}) ⇒ Types::DeleteTransitGatewayPolicyTableResult
Deletes the specified transit gateway policy table.
-
#delete_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::DeleteTransitGatewayPrefixListReferenceResult
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
-
#delete_transit_gateway_route(params = {}) ⇒ Types::DeleteTransitGatewayRouteResult
Deletes the specified route from the specified transit gateway route table.
-
#delete_transit_gateway_route_table(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableResult
Deletes the specified transit gateway route table.
-
#delete_transit_gateway_route_table_announcement(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableAnnouncementResult
Advertises to the transit gateway that a transit gateway route table is deleted.
-
#delete_transit_gateway_vpc_attachment(params = {}) ⇒ Types::DeleteTransitGatewayVpcAttachmentResult
Deletes the specified VPC attachment.
-
#delete_verified_access_endpoint(params = {}) ⇒ Types::DeleteVerifiedAccessEndpointResult
Delete an Amazon Web Services Verified Access endpoint.
-
#delete_verified_access_group(params = {}) ⇒ Types::DeleteVerifiedAccessGroupResult
Delete an Amazon Web Services Verified Access group.
-
#delete_verified_access_instance(params = {}) ⇒ Types::DeleteVerifiedAccessInstanceResult
Delete an Amazon Web Services Verified Access instance.
-
#delete_verified_access_trust_provider(params = {}) ⇒ Types::DeleteVerifiedAccessTrustProviderResult
Delete an Amazon Web Services Verified Access trust provider.
-
#delete_volume(params = {}) ⇒ Struct
Deletes the specified EBS volume.
-
#delete_vpc(params = {}) ⇒ Struct
Deletes the specified VPC.
-
#delete_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DeleteVpcEndpointConnectionNotificationsResult
Deletes the specified VPC endpoint connection notifications.
-
#delete_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DeleteVpcEndpointServiceConfigurationsResult
Deletes the specified VPC endpoint service configurations.
-
#delete_vpc_endpoints(params = {}) ⇒ Types::DeleteVpcEndpointsResult
Deletes the specified VPC endpoints.
-
#delete_vpc_peering_connection(params = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
Deletes a VPC peering connection.
-
#delete_vpn_connection(params = {}) ⇒ Struct
Deletes the specified VPN connection.
-
#delete_vpn_connection_route(params = {}) ⇒ Struct
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
#delete_vpn_gateway(params = {}) ⇒ Struct
Deletes the specified virtual private gateway.
-
#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResult
Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
-
#deprovision_ipam_byoasn(params = {}) ⇒ Types::DeprovisionIpamByoasnResult
Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account.
-
#deprovision_ipam_pool_cidr(params = {}) ⇒ Types::DeprovisionIpamPoolCidrResult
Deprovision a CIDR provisioned from an IPAM pool.
-
#deprovision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::DeprovisionPublicIpv4PoolCidrResult
Deprovision a CIDR from a public IPv4 pool.
-
#deregister_image(params = {}) ⇒ Struct
Deregisters the specified AMI.
-
#deregister_instance_event_notification_attributes(params = {}) ⇒ Types::DeregisterInstanceEventNotificationAttributesResult
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
-
#deregister_transit_gateway_multicast_group_members(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupMembersResult
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
-
#deregister_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupSourcesResult
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
-
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your Amazon Web Services account.
-
#describe_address_transfers(params = {}) ⇒ Types::DescribeAddressTransfersResult
Describes an Elastic IP address transfer.
-
#describe_addresses(params = {}) ⇒ Types::DescribeAddressesResult
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
-
#describe_addresses_attribute(params = {}) ⇒ Types::DescribeAddressesAttributeResult
Describes the attributes of the specified Elastic IP addresses.
-
#describe_aggregate_id_format(params = {}) ⇒ Types::DescribeAggregateIdFormatResult
Describes the longer ID format settings for all resource types in a specific Region.
-
#describe_availability_zones(params = {}) ⇒ Types::DescribeAvailabilityZonesResult
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you.
-
#describe_aws_network_performance_metric_subscriptions(params = {}) ⇒ Types::DescribeAwsNetworkPerformanceMetricSubscriptionsResult
Describes the current Infrastructure Performance metric subscriptions.
-
#describe_bundle_tasks(params = {}) ⇒ Types::DescribeBundleTasksResult
Describes the specified bundle tasks or all of your bundle tasks.
-
#describe_byoip_cidrs(params = {}) ⇒ Types::DescribeByoipCidrsResult
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
-
#describe_capacity_block_offerings(params = {}) ⇒ Types::DescribeCapacityBlockOfferingsResult
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using.
-
#describe_capacity_reservation_fleets(params = {}) ⇒ Types::DescribeCapacityReservationFleetsResult
Describes one or more Capacity Reservation Fleets.
-
#describe_capacity_reservations(params = {}) ⇒ Types::DescribeCapacityReservationsResult
Describes one or more of your Capacity Reservations.
-
#describe_carrier_gateways(params = {}) ⇒ Types::DescribeCarrierGatewaysResult
Describes one or more of your carrier gateways.
-
#describe_classic_link_instances(params = {}) ⇒ Types::DescribeClassicLinkInstancesResult
This action is deprecated. -
#describe_client_vpn_authorization_rules(params = {}) ⇒ Types::DescribeClientVpnAuthorizationRulesResult
Describes the authorization rules for a specified Client VPN endpoint.
-
#describe_client_vpn_connections(params = {}) ⇒ Types::DescribeClientVpnConnectionsResult
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
-
#describe_client_vpn_endpoints(params = {}) ⇒ Types::DescribeClientVpnEndpointsResult
Describes one or more Client VPN endpoints in the account.
-
#describe_client_vpn_routes(params = {}) ⇒ Types::DescribeClientVpnRoutesResult
Describes the routes for the specified Client VPN endpoint.
-
#describe_client_vpn_target_networks(params = {}) ⇒ Types::DescribeClientVpnTargetNetworksResult
Describes the target networks associated with the specified Client VPN endpoint.
-
#describe_coip_pools(params = {}) ⇒ Types::DescribeCoipPoolsResult
Describes the specified customer-owned address pools or all of your customer-owned address pools.
-
#describe_conversion_tasks(params = {}) ⇒ Types::DescribeConversionTasksResult
Describes the specified conversion tasks or all your conversion tasks.
-
#describe_customer_gateways(params = {}) ⇒ Types::DescribeCustomerGatewaysResult
Describes one or more of your VPN customer gateways.
-
#describe_dhcp_options(params = {}) ⇒ Types::DescribeDhcpOptionsResult
Describes your DHCP option sets.
-
#describe_egress_only_internet_gateways(params = {}) ⇒ Types::DescribeEgressOnlyInternetGatewaysResult
Describes your egress-only internet gateways.
-
#describe_elastic_gpus(params = {}) ⇒ Types::DescribeElasticGpusResult
Amazon Elastic Graphics reached end of life on January 8, 2024. -
#describe_export_image_tasks(params = {}) ⇒ Types::DescribeExportImageTasksResult
Describes the specified export image tasks or all of your export image tasks.
-
#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResult
Describes the specified export instance tasks or all of your export instance tasks.
-
#describe_fast_launch_images(params = {}) ⇒ Types::DescribeFastLaunchImagesResult
Describe details for Windows AMIs that are configured for Windows fast launch.
-
#describe_fast_snapshot_restores(params = {}) ⇒ Types::DescribeFastSnapshotRestoresResult
Describes the state of fast snapshot restores for your snapshots.
-
#describe_fleet_history(params = {}) ⇒ Types::DescribeFleetHistoryResult
Describes the events for the specified EC2 Fleet during the specified time.
-
#describe_fleet_instances(params = {}) ⇒ Types::DescribeFleetInstancesResult
Describes the running instances for the specified EC2 Fleet.
-
#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult
Describes the specified EC2 Fleet or all of your EC2 Fleets.
-
#describe_flow_logs(params = {}) ⇒ Types::DescribeFlowLogsResult
Describes one or more flow logs.
-
#describe_fpga_image_attribute(params = {}) ⇒ Types::DescribeFpgaImageAttributeResult
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
-
#describe_fpga_images(params = {}) ⇒ Types::DescribeFpgaImagesResult
Describes the Amazon FPGA Images (AFIs) available to you.
-
#describe_host_reservation_offerings(params = {}) ⇒ Types::DescribeHostReservationOfferingsResult
Describes the Dedicated Host reservations that are available to purchase.
-
#describe_host_reservations(params = {}) ⇒ Types::DescribeHostReservationsResult
Describes reservations that are associated with Dedicated Hosts in your account.
-
#describe_hosts(params = {}) ⇒ Types::DescribeHostsResult
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
-
#describe_iam_instance_profile_associations(params = {}) ⇒ Types::DescribeIamInstanceProfileAssociationsResult
Describes your IAM instance profile associations.
-
#describe_id_format(params = {}) ⇒ Types::DescribeIdFormatResult
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs.
-
#describe_identity_id_format(params = {}) ⇒ Types::DescribeIdentityIdFormatResult
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user.
-
#describe_image_attribute(params = {}) ⇒ Types::ImageAttribute
Describes the specified attribute of the specified AMI.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResult
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
-
#describe_import_image_tasks(params = {}) ⇒ Types::DescribeImportImageTasksResult
Displays details about an import virtual machine or import snapshot tasks that are already created.
-
#describe_import_snapshot_tasks(params = {}) ⇒ Types::DescribeImportSnapshotTasksResult
Describes your import snapshot tasks.
-
#describe_instance_attribute(params = {}) ⇒ Types::InstanceAttribute
Describes the specified attribute of the specified instance.
-
#describe_instance_connect_endpoints(params = {}) ⇒ Types::DescribeInstanceConnectEndpointsResult
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
-
#describe_instance_credit_specifications(params = {}) ⇒ Types::DescribeInstanceCreditSpecificationsResult
Describes the credit option for CPU usage of the specified burstable performance instances.
-
#describe_instance_event_notification_attributes(params = {}) ⇒ Types::DescribeInstanceEventNotificationAttributesResult
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
-
#describe_instance_event_windows(params = {}) ⇒ Types::DescribeInstanceEventWindowsResult
Describes the specified event windows or all event windows.
-
#describe_instance_status(params = {}) ⇒ Types::DescribeInstanceStatusResult
Describes the status of the specified instances or all of your instances.
-
#describe_instance_topology(params = {}) ⇒ Types::DescribeInstanceTopologyResult
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone.
-
#describe_instance_type_offerings(params = {}) ⇒ Types::DescribeInstanceTypeOfferingsResult
Lists the instance types that are offered for the specified location.
-
#describe_instance_types(params = {}) ⇒ Types::DescribeInstanceTypesResult
Describes the specified instance types.
-
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Describes the specified instances or all instances.
-
#describe_internet_gateways(params = {}) ⇒ Types::DescribeInternetGatewaysResult
Describes your internet gateways.
-
#describe_ipam_byoasn(params = {}) ⇒ Types::DescribeIpamByoasnResult
Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated.
-
#describe_ipam_pools(params = {}) ⇒ Types::DescribeIpamPoolsResult
Get information about your IPAM pools.
-
#describe_ipam_resource_discoveries(params = {}) ⇒ Types::DescribeIpamResourceDiscoveriesResult
Describes IPAM resource discoveries.
-
#describe_ipam_resource_discovery_associations(params = {}) ⇒ Types::DescribeIpamResourceDiscoveryAssociationsResult
Describes resource discovery association with an Amazon VPC IPAM.
-
#describe_ipam_scopes(params = {}) ⇒ Types::DescribeIpamScopesResult
Get information about your IPAM scopes.
-
#describe_ipams(params = {}) ⇒ Types::DescribeIpamsResult
Get information about your IPAM pools.
-
#describe_ipv_6_pools(params = {}) ⇒ Types::DescribeIpv6PoolsResult
Describes your IPv6 address pools.
-
#describe_key_pairs(params = {}) ⇒ Types::DescribeKeyPairsResult
Describes the specified key pairs or all of your key pairs.
-
#describe_launch_template_versions(params = {}) ⇒ Types::DescribeLaunchTemplateVersionsResult
Describes one or more versions of a specified launch template.
-
#describe_launch_templates(params = {}) ⇒ Types::DescribeLaunchTemplatesResult
Describes one or more launch templates.
-
#describe_local_gateway_route_table_virtual_interface_group_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult
Describes the associations between virtual interface groups and local gateway route tables.
-
#describe_local_gateway_route_table_vpc_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVpcAssociationsResult
Describes the specified associations between VPCs and local gateway route tables.
-
#describe_local_gateway_route_tables(params = {}) ⇒ Types::DescribeLocalGatewayRouteTablesResult
Describes one or more local gateway route tables.
-
#describe_local_gateway_virtual_interface_groups(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfaceGroupsResult
Describes the specified local gateway virtual interface groups.
-
#describe_local_gateway_virtual_interfaces(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfacesResult
Describes the specified local gateway virtual interfaces.
-
#describe_local_gateways(params = {}) ⇒ Types::DescribeLocalGatewaysResult
Describes one or more local gateways.
-
#describe_locked_snapshots(params = {}) ⇒ Types::DescribeLockedSnapshotsResult
Describes the lock status for a snapshot.
-
#describe_mac_hosts(params = {}) ⇒ Types::DescribeMacHostsResult
Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
-
#describe_managed_prefix_lists(params = {}) ⇒ Types::DescribeManagedPrefixListsResult
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
-
#describe_moving_addresses(params = {}) ⇒ Types::DescribeMovingAddressesResult
This action is deprecated. -
#describe_nat_gateways(params = {}) ⇒ Types::DescribeNatGatewaysResult
Describes your NAT gateways.
-
#describe_network_acls(params = {}) ⇒ Types::DescribeNetworkAclsResult
Describes your network ACLs.
-
#describe_network_insights_access_scope_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopeAnalysesResult
Describes the specified Network Access Scope analyses.
-
#describe_network_insights_access_scopes(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopesResult
Describes the specified Network Access Scopes.
-
#describe_network_insights_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAnalysesResult
Describes one or more of your network insights analyses.
-
#describe_network_insights_paths(params = {}) ⇒ Types::DescribeNetworkInsightsPathsResult
Describes one or more of your paths.
-
#describe_network_interface_attribute(params = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult
Describes a network interface attribute.
-
#describe_network_interface_permissions(params = {}) ⇒ Types::DescribeNetworkInterfacePermissionsResult
Describes the permissions for your network interfaces.
-
#describe_network_interfaces(params = {}) ⇒ Types::DescribeNetworkInterfacesResult
Describes one or more of your network interfaces.
-
#describe_placement_groups(params = {}) ⇒ Types::DescribePlacementGroupsResult
Describes the specified placement groups or all of your placement groups.
-
#describe_prefix_lists(params = {}) ⇒ Types::DescribePrefixListsResult
Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
-
#describe_principal_id_format(params = {}) ⇒ Types::DescribePrincipalIdFormatResult
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
-
#describe_public_ipv_4_pools(params = {}) ⇒ Types::DescribePublicIpv4PoolsResult
Describes the specified IPv4 address pools.
-
#describe_regions(params = {}) ⇒ Types::DescribeRegionsResult
Describes the Regions that are enabled for your account, or all Regions.
-
#describe_replace_root_volume_tasks(params = {}) ⇒ Types::DescribeReplaceRootVolumeTasksResult
Describes a root volume replacement task.
-
#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResult
Describes one or more of the Reserved Instances that you purchased.
-
#describe_reserved_instances_listings(params = {}) ⇒ Types::DescribeReservedInstancesListingsResult
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
-
#describe_reserved_instances_modifications(params = {}) ⇒ Types::DescribeReservedInstancesModificationsResult
Describes the modifications made to your Reserved Instances.
-
#describe_reserved_instances_offerings(params = {}) ⇒ Types::DescribeReservedInstancesOfferingsResult
Describes Reserved Instance offerings that are available for purchase.
-
#describe_route_tables(params = {}) ⇒ Types::DescribeRouteTablesResult
Describes your route tables.
-
#describe_scheduled_instance_availability(params = {}) ⇒ Types::DescribeScheduledInstanceAvailabilityResult
Finds available schedules that meet the specified criteria.
-
#describe_scheduled_instances(params = {}) ⇒ Types::DescribeScheduledInstancesResult
Describes the specified Scheduled Instances or all your Scheduled Instances.
-
#describe_security_group_references(params = {}) ⇒ Types::DescribeSecurityGroupReferencesResult
Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
-
#describe_security_group_rules(params = {}) ⇒ Types::DescribeSecurityGroupRulesResult
Describes one or more of your security group rules.
-
#describe_security_groups(params = {}) ⇒ Types::DescribeSecurityGroupsResult
Describes the specified security groups or all of your security groups.
-
#describe_snapshot_attribute(params = {}) ⇒ Types::DescribeSnapshotAttributeResult
Describes the specified attribute of the specified snapshot.
-
#describe_snapshot_tier_status(params = {}) ⇒ Types::DescribeSnapshotTierStatusResult
Describes the storage tier status of one or more Amazon EBS snapshots.
-
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
-
#describe_spot_datafeed_subscription(params = {}) ⇒ Types::DescribeSpotDatafeedSubscriptionResult
Describes the data feed for Spot Instances.
-
#describe_spot_fleet_instances(params = {}) ⇒ Types::DescribeSpotFleetInstancesResponse
Describes the running instances for the specified Spot Fleet.
-
#describe_spot_fleet_request_history(params = {}) ⇒ Types::DescribeSpotFleetRequestHistoryResponse
Describes the events for the specified Spot Fleet request during the specified time.
-
#describe_spot_fleet_requests(params = {}) ⇒ Types::DescribeSpotFleetRequestsResponse
Describes your Spot Fleet requests.
-
#describe_spot_instance_requests(params = {}) ⇒ Types::DescribeSpotInstanceRequestsResult
Describes the specified Spot Instance requests.
-
#describe_spot_price_history(params = {}) ⇒ Types::DescribeSpotPriceHistoryResult
Describes the Spot price history.
-
#describe_stale_security_groups(params = {}) ⇒ Types::DescribeStaleSecurityGroupsResult
Describes the stale security group rules for security groups in a specified VPC.
-
#describe_store_image_tasks(params = {}) ⇒ Types::DescribeStoreImageTasksResult
Describes the progress of the AMI store tasks.
-
#describe_subnets(params = {}) ⇒ Types::DescribeSubnetsResult
Describes your subnets.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsResult
Describes the specified tags for your EC2 resources.
-
#describe_traffic_mirror_filter_rules(params = {}) ⇒ Types::DescribeTrafficMirrorFilterRulesResult
Describe traffic mirror filters that determine the traffic that is mirrored.
-
#describe_traffic_mirror_filters(params = {}) ⇒ Types::DescribeTrafficMirrorFiltersResult
Describes one or more Traffic Mirror filters.
-
#describe_traffic_mirror_sessions(params = {}) ⇒ Types::DescribeTrafficMirrorSessionsResult
Describes one or more Traffic Mirror sessions.
-
#describe_traffic_mirror_targets(params = {}) ⇒ Types::DescribeTrafficMirrorTargetsResult
Information about one or more Traffic Mirror targets.
-
#describe_transit_gateway_attachments(params = {}) ⇒ Types::DescribeTransitGatewayAttachmentsResult
Describes one or more attachments between resources and transit gateways.
-
#describe_transit_gateway_connect_peers(params = {}) ⇒ Types::DescribeTransitGatewayConnectPeersResult
Describes one or more Connect peers.
-
#describe_transit_gateway_connects(params = {}) ⇒ Types::DescribeTransitGatewayConnectsResult
Describes one or more Connect attachments.
-
#describe_transit_gateway_multicast_domains(params = {}) ⇒ Types::DescribeTransitGatewayMulticastDomainsResult
Describes one or more transit gateway multicast domains.
-
#describe_transit_gateway_peering_attachments(params = {}) ⇒ Types::DescribeTransitGatewayPeeringAttachmentsResult
Describes your transit gateway peering attachments.
-
#describe_transit_gateway_policy_tables(params = {}) ⇒ Types::DescribeTransitGatewayPolicyTablesResult
Describes one or more transit gateway route policy tables.
-
#describe_transit_gateway_route_table_announcements(params = {}) ⇒ Types::DescribeTransitGatewayRouteTableAnnouncementsResult
Describes one or more transit gateway route table advertisements.
-
#describe_transit_gateway_route_tables(params = {}) ⇒ Types::DescribeTransitGatewayRouteTablesResult
Describes one or more transit gateway route tables.
-
#describe_transit_gateway_vpc_attachments(params = {}) ⇒ Types::DescribeTransitGatewayVpcAttachmentsResult
Describes one or more VPC attachments.
-
#describe_transit_gateways(params = {}) ⇒ Types::DescribeTransitGatewaysResult
Describes one or more transit gateways.
-
#describe_trunk_interface_associations(params = {}) ⇒ Types::DescribeTrunkInterfaceAssociationsResult
Describes one or more network interface trunk associations.
-
#describe_verified_access_endpoints(params = {}) ⇒ Types::DescribeVerifiedAccessEndpointsResult
Describes the specified Amazon Web Services Verified Access endpoints.
-
#describe_verified_access_groups(params = {}) ⇒ Types::DescribeVerifiedAccessGroupsResult
Describes the specified Verified Access groups.
-
#describe_verified_access_instance_logging_configurations(params = {}) ⇒ Types::DescribeVerifiedAccessInstanceLoggingConfigurationsResult
Describes the specified Amazon Web Services Verified Access instances.
-
#describe_verified_access_instances(params = {}) ⇒ Types::DescribeVerifiedAccessInstancesResult
Describes the specified Amazon Web Services Verified Access instances.
-
#describe_verified_access_trust_providers(params = {}) ⇒ Types::DescribeVerifiedAccessTrustProvidersResult
Describes the specified Amazon Web Services Verified Access trust providers.
-
#describe_volume_attribute(params = {}) ⇒ Types::DescribeVolumeAttributeResult
Describes the specified attribute of the specified volume.
-
#describe_volume_status(params = {}) ⇒ Types::DescribeVolumeStatusResult
Describes the status of the specified volumes.
-
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes the specified EBS volumes or all of your EBS volumes.
-
#describe_volumes_modifications(params = {}) ⇒ Types::DescribeVolumesModificationsResult
Describes the most recent volume modification request for the specified EBS volumes.
-
#describe_vpc_attribute(params = {}) ⇒ Types::DescribeVpcAttributeResult
Describes the specified attribute of the specified VPC.
-
#describe_vpc_classic_link(params = {}) ⇒ Types::DescribeVpcClassicLinkResult
This action is deprecated. -
#describe_vpc_classic_link_dns_support(params = {}) ⇒ Types::DescribeVpcClassicLinkDnsSupportResult
This action is deprecated. -
#describe_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DescribeVpcEndpointConnectionNotificationsResult
Describes the connection notifications for VPC endpoints and VPC endpoint services.
-
#describe_vpc_endpoint_connections(params = {}) ⇒ Types::DescribeVpcEndpointConnectionsResult
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
-
#describe_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DescribeVpcEndpointServiceConfigurationsResult
Describes the VPC endpoint service configurations in your account (your services).
-
#describe_vpc_endpoint_service_permissions(params = {}) ⇒ Types::DescribeVpcEndpointServicePermissionsResult
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
-
#describe_vpc_endpoint_services(params = {}) ⇒ Types::DescribeVpcEndpointServicesResult
Describes available services to which you can create a VPC endpoint.
-
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResult
Describes your VPC endpoints.
-
#describe_vpc_peering_connections(params = {}) ⇒ Types::DescribeVpcPeeringConnectionsResult
Describes your VPC peering connections.
-
#describe_vpcs(params = {}) ⇒ Types::DescribeVpcsResult
Describes your VPCs.
-
#describe_vpn_connections(params = {}) ⇒ Types::DescribeVpnConnectionsResult
Describes one or more of your VPN connections.
-
#describe_vpn_gateways(params = {}) ⇒ Types::DescribeVpnGatewaysResult
Describes one or more of your virtual private gateways.
-
#detach_classic_link_vpc(params = {}) ⇒ Types::DetachClassicLinkVpcResult
This action is deprecated. -
#detach_internet_gateway(params = {}) ⇒ Struct
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC.
-
#detach_network_interface(params = {}) ⇒ Struct
Detaches a network interface from an instance.
-
#detach_verified_access_trust_provider(params = {}) ⇒ Types::DetachVerifiedAccessTrustProviderResult
Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.
-
#detach_volume(params = {}) ⇒ Types::VolumeAttachment
Detaches an EBS volume from an instance.
-
#detach_vpn_gateway(params = {}) ⇒ Struct
Detaches a virtual private gateway from a VPC.
-
#disable_address_transfer(params = {}) ⇒ Types::DisableAddressTransferResult
Disables Elastic IP address transfer.
-
#disable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::DisableAwsNetworkPerformanceMetricSubscriptionResult
Disables Infrastructure Performance metric subscriptions.
-
#disable_ebs_encryption_by_default(params = {}) ⇒ Types::DisableEbsEncryptionByDefaultResult
Disables EBS encryption by default for your account in the current Region.
-
#disable_fast_launch(params = {}) ⇒ Types::DisableFastLaunchResult
Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots.
-
#disable_fast_snapshot_restores(params = {}) ⇒ Types::DisableFastSnapshotRestoresResult
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
-
#disable_image(params = {}) ⇒ Types::DisableImageResult
Sets the AMI state to
disabled
and removes all launch permissions from the AMI. -
#disable_image_block_public_access(params = {}) ⇒ Types::DisableImageBlockPublicAccessResult
Disables block public access for AMIs at the account level in the specified Amazon Web Services Region.
-
#disable_image_deprecation(params = {}) ⇒ Types::DisableImageDeprecationResult
Cancels the deprecation of the specified AMI.
-
#disable_image_deregistration_protection(params = {}) ⇒ Types::DisableImageDeregistrationProtectionResult
Disables deregistration protection for an AMI.
-
#disable_ipam_organization_admin_account(params = {}) ⇒ Types::DisableIpamOrganizationAdminAccountResult
Disable the IPAM account.
-
#disable_serial_console_access(params = {}) ⇒ Types::DisableSerialConsoleAccessResult
Disables access to the EC2 serial console of all instances for your account.
-
#disable_snapshot_block_public_access(params = {}) ⇒ Types::DisableSnapshotBlockPublicAccessResult
Disables the block public access for snapshots setting at the account level for the specified Amazon Web Services Region.
-
#disable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::DisableTransitGatewayRouteTablePropagationResult
Disables the specified resource attachment from propagating routes to the specified propagation route table.
-
#disable_vgw_route_propagation(params = {}) ⇒ Struct
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
-
#disable_vpc_classic_link(params = {}) ⇒ Types::DisableVpcClassicLinkResult
This action is deprecated. -
#disable_vpc_classic_link_dns_support(params = {}) ⇒ Types::DisableVpcClassicLinkDnsSupportResult
This action is deprecated. -
#disassociate_address(params = {}) ⇒ Struct
Disassociates an Elastic IP address from the instance or network interface it's associated with.
-
#disassociate_client_vpn_target_network(params = {}) ⇒ Types::DisassociateClientVpnTargetNetworkResult
Disassociates a target network from the specified Client VPN endpoint.
-
#disassociate_enclave_certificate_iam_role(params = {}) ⇒ Types::DisassociateEnclaveCertificateIamRoleResult
Disassociates an IAM role from an Certificate Manager (ACM) certificate.
-
#disassociate_iam_instance_profile(params = {}) ⇒ Types::DisassociateIamInstanceProfileResult
Disassociates an IAM instance profile from a running or stopped instance.
-
#disassociate_instance_event_window(params = {}) ⇒ Types::DisassociateInstanceEventWindowResult
Disassociates one or more targets from an event window.
-
#disassociate_ipam_byoasn(params = {}) ⇒ Types::DisassociateIpamByoasnResult
Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR.
-
#disassociate_ipam_resource_discovery(params = {}) ⇒ Types::DisassociateIpamResourceDiscoveryResult
Disassociates a resource discovery from an Amazon VPC IPAM.
-
#disassociate_nat_gateway_address(params = {}) ⇒ Types::DisassociateNatGatewayAddressResult
Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway.
-
#disassociate_route_table(params = {}) ⇒ Struct
Disassociates a subnet or gateway from a route table.
-
#disassociate_subnet_cidr_block(params = {}) ⇒ Types::DisassociateSubnetCidrBlockResult
Disassociates a CIDR block from a subnet.
-
#disassociate_transit_gateway_multicast_domain(params = {}) ⇒ Types::DisassociateTransitGatewayMulticastDomainResult
Disassociates the specified subnets from the transit gateway multicast domain.
-
#disassociate_transit_gateway_policy_table(params = {}) ⇒ Types::DisassociateTransitGatewayPolicyTableResult
Removes the association between an an attachment and a policy table.
-
#disassociate_transit_gateway_route_table(params = {}) ⇒ Types::DisassociateTransitGatewayRouteTableResult
Disassociates a resource attachment from a transit gateway route table.
-
#disassociate_trunk_interface(params = {}) ⇒ Types::DisassociateTrunkInterfaceResult
Removes an association between a branch network interface with a trunk network interface.
-
#disassociate_vpc_cidr_block(params = {}) ⇒ Types::DisassociateVpcCidrBlockResult
Disassociates a CIDR block from a VPC.
-
#enable_address_transfer(params = {}) ⇒ Types::EnableAddressTransferResult
Enables Elastic IP address transfer.
-
#enable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::EnableAwsNetworkPerformanceMetricSubscriptionResult
Enables Infrastructure Performance subscriptions.
-
#enable_ebs_encryption_by_default(params = {}) ⇒ Types::EnableEbsEncryptionByDefaultResult
Enables EBS encryption by default for your account in the current Region.
-
#enable_fast_launch(params = {}) ⇒ Types::EnableFastLaunchResult
When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster.
-
#enable_fast_snapshot_restores(params = {}) ⇒ Types::EnableFastSnapshotRestoresResult
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
-
#enable_image(params = {}) ⇒ Types::EnableImageResult
Re-enables a disabled AMI.
-
#enable_image_block_public_access(params = {}) ⇒ Types::EnableImageBlockPublicAccessResult
Enables block public access for AMIs at the account level in the specified Amazon Web Services Region.
-
#enable_image_deprecation(params = {}) ⇒ Types::EnableImageDeprecationResult
Enables deprecation of the specified AMI at the specified date and time.
-
#enable_image_deregistration_protection(params = {}) ⇒ Types::EnableImageDeregistrationProtectionResult
Enables deregistration protection for an AMI.
-
#enable_ipam_organization_admin_account(params = {}) ⇒ Types::EnableIpamOrganizationAdminAccountResult
Enable an Organizations member account as the IPAM admin account.
-
#enable_reachability_analyzer_organization_sharing(params = {}) ⇒ Types::EnableReachabilityAnalyzerOrganizationSharingResult
Establishes a trust relationship between Reachability Analyzer and Organizations.
-
#enable_serial_console_access(params = {}) ⇒ Types::EnableSerialConsoleAccessResult
Enables access to the EC2 serial console of all instances for your account.
-
#enable_snapshot_block_public_access(params = {}) ⇒ Types::EnableSnapshotBlockPublicAccessResult
Enables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region.
-
#enable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::EnableTransitGatewayRouteTablePropagationResult
Enables the specified attachment to propagate routes to the specified propagation route table.
-
#enable_vgw_route_propagation(params = {}) ⇒ Struct
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
-
#enable_volume_io(params = {}) ⇒ Struct
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
-
#enable_vpc_classic_link(params = {}) ⇒ Types::EnableVpcClassicLinkResult
This action is deprecated. -
#enable_vpc_classic_link_dns_support(params = {}) ⇒ Types::EnableVpcClassicLinkDnsSupportResult
This action is deprecated. -
#export_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ExportClientVpnClientCertificateRevocationListResult
Downloads the client certificate revocation list for the specified Client VPN endpoint.
-
#export_client_vpn_client_configuration(params = {}) ⇒ Types::ExportClientVpnClientConfigurationResult
Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint.
-
#export_image(params = {}) ⇒ Types::ExportImageResult
Exports an Amazon Machine Image (AMI) to a VM file.
-
#export_transit_gateway_routes(params = {}) ⇒ Types::ExportTransitGatewayRoutesResult
Exports routes from the specified transit gateway route table to the specified S3 bucket.
-
#get_associated_enclave_certificate_iam_roles(params = {}) ⇒ Types::GetAssociatedEnclaveCertificateIamRolesResult
Returns the IAM roles that are associated with the specified ACM (ACM) certificate.
-
#get_associated_ipv_6_pool_cidrs(params = {}) ⇒ Types::GetAssociatedIpv6PoolCidrsResult
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
-
#get_aws_network_performance_data(params = {}) ⇒ Types::GetAwsNetworkPerformanceDataResult
Gets network performance data.
-
#get_capacity_reservation_usage(params = {}) ⇒ Types::GetCapacityReservationUsageResult
Gets usage information about a Capacity Reservation.
-
#get_coip_pool_usage(params = {}) ⇒ Types::GetCoipPoolUsageResult
Describes the allocations from the specified customer-owned address pool.
-
#get_console_output(params = {}) ⇒ Types::GetConsoleOutputResult
Gets the console output for the specified instance.
-
#get_console_screenshot(params = {}) ⇒ Types::GetConsoleScreenshotResult
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
-
#get_default_credit_specification(params = {}) ⇒ Types::GetDefaultCreditSpecificationResult
Describes the default credit option for CPU usage of a burstable performance instance family.
-
#get_ebs_default_kms_key_id(params = {}) ⇒ Types::GetEbsDefaultKmsKeyIdResult
Describes the default KMS key for EBS encryption by default for your account in this Region.
-
#get_ebs_encryption_by_default(params = {}) ⇒ Types::GetEbsEncryptionByDefaultResult
Describes whether EBS encryption by default is enabled for your account in the current Region.
-
#get_flow_logs_integration_template(params = {}) ⇒ Types::GetFlowLogsIntegrationTemplateResult
Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena.
-
#get_groups_for_capacity_reservation(params = {}) ⇒ Types::GetGroupsForCapacityReservationResult
Lists the resource groups to which a Capacity Reservation has been added.
-
#get_host_reservation_purchase_preview(params = {}) ⇒ Types::GetHostReservationPurchasePreviewResult
Preview a reservation purchase with configurations that match those of your Dedicated Host.
-
#get_image_block_public_access_state(params = {}) ⇒ Types::GetImageBlockPublicAccessStateResult
Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.
-
#get_instance_metadata_defaults(params = {}) ⇒ Types::GetInstanceMetadataDefaultsResult
Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.
-
#get_instance_tpm_ek_pub(params = {}) ⇒ Types::GetInstanceTpmEkPubResult
Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
-
#get_instance_types_from_instance_requirements(params = {}) ⇒ Types::GetInstanceTypesFromInstanceRequirementsResult
Returns a list of instance types with the specified instance attributes.
-
#get_instance_uefi_data(params = {}) ⇒ Types::GetInstanceUefiDataResult
A binary representation of the UEFI variable store.
-
#get_ipam_address_history(params = {}) ⇒ Types::GetIpamAddressHistoryResult
Retrieve historical information about a CIDR within an IPAM scope.
-
#get_ipam_discovered_accounts(params = {}) ⇒ Types::GetIpamDiscoveredAccountsResult
Gets IPAM discovered accounts.
-
#get_ipam_discovered_public_addresses(params = {}) ⇒ Types::GetIpamDiscoveredPublicAddressesResult
Gets the public IP addresses that have been discovered by IPAM.
-
#get_ipam_discovered_resource_cidrs(params = {}) ⇒ Types::GetIpamDiscoveredResourceCidrsResult
Returns the resource CIDRs that are monitored as part of a resource discovery.
-
#get_ipam_pool_allocations(params = {}) ⇒ Types::GetIpamPoolAllocationsResult
Get a list of all the CIDR allocations in an IPAM pool.
-
#get_ipam_pool_cidrs(params = {}) ⇒ Types::GetIpamPoolCidrsResult
Get the CIDRs provisioned to an IPAM pool.
-
#get_ipam_resource_cidrs(params = {}) ⇒ Types::GetIpamResourceCidrsResult
Returns resource CIDRs managed by IPAM in a given scope.
-
#get_launch_template_data(params = {}) ⇒ Types::GetLaunchTemplateDataResult
Retrieves the configuration data of the specified instance.
-
#get_managed_prefix_list_associations(params = {}) ⇒ Types::GetManagedPrefixListAssociationsResult
Gets information about the resources that are associated with the specified managed prefix list.
-
#get_managed_prefix_list_entries(params = {}) ⇒ Types::GetManagedPrefixListEntriesResult
Gets information about the entries for a specified managed prefix list.
-
#get_network_insights_access_scope_analysis_findings(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeAnalysisFindingsResult
Gets the findings for the specified Network Access Scope analysis.
-
#get_network_insights_access_scope_content(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeContentResult
Gets the content for the specified Network Access Scope.
-
#get_password_data(params = {}) ⇒ Types::GetPasswordDataResult
Retrieves the encrypted administrator password for a running Windows instance.
-
#get_reserved_instances_exchange_quote(params = {}) ⇒ Types::GetReservedInstancesExchangeQuoteResult
Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance.
-
#get_security_groups_for_vpc(params = {}) ⇒ Types::GetSecurityGroupsForVpcResult
Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.
-
#get_serial_console_access_status(params = {}) ⇒ Types::GetSerialConsoleAccessStatusResult
Retrieves the access status of your account to the EC2 serial console of all instances.
-
#get_snapshot_block_public_access_state(params = {}) ⇒ Types::GetSnapshotBlockPublicAccessStateResult
Gets the current state of block public access for snapshots setting for the account and Region.
-
#get_spot_placement_scores(params = {}) ⇒ Types::GetSpotPlacementScoresResult
Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
-
#get_subnet_cidr_reservations(params = {}) ⇒ Types::GetSubnetCidrReservationsResult
Gets information about the subnet CIDR reservations.
-
#get_transit_gateway_attachment_propagations(params = {}) ⇒ Types::GetTransitGatewayAttachmentPropagationsResult
Lists the route tables to which the specified resource attachment propagates routes.
-
#get_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::GetTransitGatewayMulticastDomainAssociationsResult
Gets information about the associations for the transit gateway multicast domain.
-
#get_transit_gateway_policy_table_associations(params = {}) ⇒ Types::GetTransitGatewayPolicyTableAssociationsResult
Gets a list of the transit gateway policy table associations.
-
#get_transit_gateway_policy_table_entries(params = {}) ⇒ Types::GetTransitGatewayPolicyTableEntriesResult
Returns a list of transit gateway policy table entries.
-
#get_transit_gateway_prefix_list_references(params = {}) ⇒ Types::GetTransitGatewayPrefixListReferencesResult
Gets information about the prefix list references in a specified transit gateway route table.
-
#get_transit_gateway_route_table_associations(params = {}) ⇒ Types::GetTransitGatewayRouteTableAssociationsResult
Gets information about the associations for the specified transit gateway route table.
-
#get_transit_gateway_route_table_propagations(params = {}) ⇒ Types::GetTransitGatewayRouteTablePropagationsResult
Gets information about the route table propagations for the specified transit gateway route table.
-
#get_verified_access_endpoint_policy(params = {}) ⇒ Types::GetVerifiedAccessEndpointPolicyResult
Get the Verified Access policy associated with the endpoint.
-
#get_verified_access_group_policy(params = {}) ⇒ Types::GetVerifiedAccessGroupPolicyResult
Shows the contents of the Verified Access policy associated with the group.
-
#get_vpn_connection_device_sample_configuration(params = {}) ⇒ Types::GetVpnConnectionDeviceSampleConfigurationResult
Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
-
#get_vpn_connection_device_types(params = {}) ⇒ Types::GetVpnConnectionDeviceTypesResult
Obtain a list of customer gateway devices for which sample configuration files can be provided.
-
#get_vpn_tunnel_replacement_status(params = {}) ⇒ Types::GetVpnTunnelReplacementStatusResult
Get details of available tunnel endpoint maintenance.
-
#import_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ImportClientVpnClientCertificateRevocationListResult
Uploads a client certificate revocation list to the specified Client VPN endpoint.
-
#import_image(params = {}) ⇒ Types::ImportImageResult
To import your virtual machines (VMs) with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the [Migration Hub Orchestrator console][1]. -
#import_instance(params = {}) ⇒ Types::ImportInstanceResult
We recommend that you use the [ ImportImage
][1] API. -
#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult
Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool.
-
#import_snapshot(params = {}) ⇒ Types::ImportSnapshotResult
Imports a disk into an EBS snapshot.
-
#import_volume(params = {}) ⇒ Types::ImportVolumeResult
Creates an import volume task using metadata from the specified disk image.
-
#list_images_in_recycle_bin(params = {}) ⇒ Types::ListImagesInRecycleBinResult
Lists one or more AMIs that are currently in the Recycle Bin.
-
#list_snapshots_in_recycle_bin(params = {}) ⇒ Types::ListSnapshotsInRecycleBinResult
Lists one or more snapshots that are currently in the Recycle Bin.
-
#lock_snapshot(params = {}) ⇒ Types::LockSnapshotResult
Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration.
-
#modify_address_attribute(params = {}) ⇒ Types::ModifyAddressAttributeResult
Modifies an attribute of the specified Elastic IP address.
-
#modify_availability_zone_group(params = {}) ⇒ Types::ModifyAvailabilityZoneGroupResult
Changes the opt-in status of the specified zone group for your account.
-
#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationResult
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released.
-
#modify_capacity_reservation_fleet(params = {}) ⇒ Types::ModifyCapacityReservationFleetResult
Modifies a Capacity Reservation Fleet.
-
#modify_client_vpn_endpoint(params = {}) ⇒ Types::ModifyClientVpnEndpointResult
Modifies the specified Client VPN endpoint.
-
#modify_default_credit_specification(params = {}) ⇒ Types::ModifyDefaultCreditSpecificationResult
Modifies the default credit option for CPU usage of burstable performance instances.
-
#modify_ebs_default_kms_key_id(params = {}) ⇒ Types::ModifyEbsDefaultKmsKeyIdResult
Changes the default KMS key for EBS encryption by default for your account in this Region.
-
#modify_fleet(params = {}) ⇒ Types::ModifyFleetResult
Modifies the specified EC2 Fleet.
-
#modify_fpga_image_attribute(params = {}) ⇒ Types::ModifyFpgaImageAttributeResult
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
-
#modify_hosts(params = {}) ⇒ Types::ModifyHostsResult
Modify the auto-placement setting of a Dedicated Host.
-
#modify_id_format(params = {}) ⇒ Struct
Modifies the ID format for the specified resource on a per-Region basis.
-
#modify_identity_id_format(params = {}) ⇒ Struct
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account.
-
#modify_image_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified AMI.
-
#modify_instance_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified instance.
-
#modify_instance_capacity_reservation_attributes(params = {}) ⇒ Types::ModifyInstanceCapacityReservationAttributesResult
Modifies the Capacity Reservation settings for a stopped instance.
-
#modify_instance_credit_specification(params = {}) ⇒ Types::ModifyInstanceCreditSpecificationResult
Modifies the credit option for CPU usage on a running or stopped burstable performance instance.
-
#modify_instance_event_start_time(params = {}) ⇒ Types::ModifyInstanceEventStartTimeResult
Modifies the start time for a scheduled Amazon EC2 instance event.
-
#modify_instance_event_window(params = {}) ⇒ Types::ModifyInstanceEventWindowResult
Modifies the specified event window.
-
#modify_instance_maintenance_options(params = {}) ⇒ Types::ModifyInstanceMaintenanceOptionsResult
Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default.
-
#modify_instance_metadata_defaults(params = {}) ⇒ Types::ModifyInstanceMetadataDefaultsResult
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
-
#modify_instance_metadata_options(params = {}) ⇒ Types::ModifyInstanceMetadataOptionsResult
Modify the instance metadata parameters on a running or stopped instance.
-
#modify_instance_placement(params = {}) ⇒ Types::ModifyInstancePlacementResult
Modifies the placement attributes for a specified instance.
-
#modify_ipam(params = {}) ⇒ Types::ModifyIpamResult
Modify the configurations of an IPAM.
-
#modify_ipam_pool(params = {}) ⇒ Types::ModifyIpamPoolResult
Modify the configurations of an IPAM pool.
-
#modify_ipam_resource_cidr(params = {}) ⇒ Types::ModifyIpamResourceCidrResult
Modify a resource CIDR.
-
#modify_ipam_resource_discovery(params = {}) ⇒ Types::ModifyIpamResourceDiscoveryResult
Modifies a resource discovery.
-
#modify_ipam_scope(params = {}) ⇒ Types::ModifyIpamScopeResult
Modify an IPAM scope.
-
#modify_launch_template(params = {}) ⇒ Types::ModifyLaunchTemplateResult
Modifies a launch template.
-
#modify_local_gateway_route(params = {}) ⇒ Types::ModifyLocalGatewayRouteResult
Modifies the specified local gateway route.
-
#modify_managed_prefix_list(params = {}) ⇒ Types::ModifyManagedPrefixListResult
Modifies the specified managed prefix list.
-
#modify_network_interface_attribute(params = {}) ⇒ Struct
Modifies the specified network interface attribute.
-
#modify_private_dns_name_options(params = {}) ⇒ Types::ModifyPrivateDnsNameOptionsResult
Modifies the options for instance hostnames for the specified instance.
-
#modify_reserved_instances(params = {}) ⇒ Types::ModifyReservedInstancesResult
Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type.
-
#modify_security_group_rules(params = {}) ⇒ Types::ModifySecurityGroupRulesResult
Modifies the rules of a security group.
-
#modify_snapshot_attribute(params = {}) ⇒ Struct
Adds or removes permission settings for the specified snapshot.
-
#modify_snapshot_tier(params = {}) ⇒ Types::ModifySnapshotTierResult
Archives an Amazon EBS snapshot.
-
#modify_spot_fleet_request(params = {}) ⇒ Types::ModifySpotFleetRequestResponse
Modifies the specified Spot Fleet request.
-
#modify_subnet_attribute(params = {}) ⇒ Struct
Modifies a subnet attribute.
-
#modify_traffic_mirror_filter_network_services(params = {}) ⇒ Types::ModifyTrafficMirrorFilterNetworkServicesResult
Allows or restricts mirroring network services.
-
#modify_traffic_mirror_filter_rule(params = {}) ⇒ Types::ModifyTrafficMirrorFilterRuleResult
Modifies the specified Traffic Mirror rule.
-
#modify_traffic_mirror_session(params = {}) ⇒ Types::ModifyTrafficMirrorSessionResult
Modifies a Traffic Mirror session.
-
#modify_transit_gateway(params = {}) ⇒ Types::ModifyTransitGatewayResult
Modifies the specified transit gateway.
-
#modify_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::ModifyTransitGatewayPrefixListReferenceResult
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
-
#modify_transit_gateway_vpc_attachment(params = {}) ⇒ Types::ModifyTransitGatewayVpcAttachmentResult
Modifies the specified VPC attachment.
-
#modify_verified_access_endpoint(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointResult
Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
-
#modify_verified_access_endpoint_policy(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointPolicyResult
Modifies the specified Amazon Web Services Verified Access endpoint policy.
-
#modify_verified_access_group(params = {}) ⇒ Types::ModifyVerifiedAccessGroupResult
Modifies the specified Amazon Web Services Verified Access group configuration.
-
#modify_verified_access_group_policy(params = {}) ⇒ Types::ModifyVerifiedAccessGroupPolicyResult
Modifies the specified Amazon Web Services Verified Access group policy.
-
#modify_verified_access_instance(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceResult
Modifies the configuration of the specified Amazon Web Services Verified Access instance.
-
#modify_verified_access_instance_logging_configuration(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceLoggingConfigurationResult
Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
-
#modify_verified_access_trust_provider(params = {}) ⇒ Types::ModifyVerifiedAccessTrustProviderResult
Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
-
#modify_volume(params = {}) ⇒ Types::ModifyVolumeResult
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity.
-
#modify_volume_attribute(params = {}) ⇒ Struct
Modifies a volume attribute.
-
#modify_vpc_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified VPC.
-
#modify_vpc_endpoint(params = {}) ⇒ Types::ModifyVpcEndpointResult
Modifies attributes of a specified VPC endpoint.
-
#modify_vpc_endpoint_connection_notification(params = {}) ⇒ Types::ModifyVpcEndpointConnectionNotificationResult
Modifies a connection notification for VPC endpoint or VPC endpoint service.
-
#modify_vpc_endpoint_service_configuration(params = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult
Modifies the attributes of your VPC endpoint service configuration.
-
#modify_vpc_endpoint_service_payer_responsibility(params = {}) ⇒ Types::ModifyVpcEndpointServicePayerResponsibilityResult
Modifies the payer responsibility for your VPC endpoint service.
-
#modify_vpc_endpoint_service_permissions(params = {}) ⇒ Types::ModifyVpcEndpointServicePermissionsResult
Modifies the permissions for your VPC endpoint service.
-
#modify_vpc_peering_connection_options(params = {}) ⇒ Types::ModifyVpcPeeringConnectionOptionsResult
Modifies the VPC peering connection options on one side of a VPC peering connection.
-
#modify_vpc_tenancy(params = {}) ⇒ Types::ModifyVpcTenancyResult
Modifies the instance tenancy attribute of the specified VPC.
-
#modify_vpn_connection(params = {}) ⇒ Types::ModifyVpnConnectionResult
Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection.
-
#modify_vpn_connection_options(params = {}) ⇒ Types::ModifyVpnConnectionOptionsResult
Modifies the connection options for your Site-to-Site VPN connection.
-
#modify_vpn_tunnel_certificate(params = {}) ⇒ Types::ModifyVpnTunnelCertificateResult
Modifies the VPN tunnel endpoint certificate.
-
#modify_vpn_tunnel_options(params = {}) ⇒ Types::ModifyVpnTunnelOptionsResult
Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection.
-
#monitor_instances(params = {}) ⇒ Types::MonitorInstancesResult
Enables detailed monitoring for a running instance.
-
#move_address_to_vpc(params = {}) ⇒ Types::MoveAddressToVpcResult
This action is deprecated. -
#move_byoip_cidr_to_ipam(params = {}) ⇒ Types::MoveByoipCidrToIpamResult
Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.
-
#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResult
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.
-
#provision_ipam_byoasn(params = {}) ⇒ Types::ProvisionIpamByoasnResult
Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account.
-
#provision_ipam_pool_cidr(params = {}) ⇒ Types::ProvisionIpamPoolCidrResult
Provision a CIDR to an IPAM pool.
-
#provision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::ProvisionPublicIpv4PoolCidrResult
Provision a CIDR to a public IPv4 pool.
-
#purchase_capacity_block(params = {}) ⇒ Types::PurchaseCapacityBlockResult
Purchase the Capacity Block for use with your account.
-
#purchase_host_reservation(params = {}) ⇒ Types::PurchaseHostReservationResult
Purchase a reservation with configurations that match those of your Dedicated Host.
-
#purchase_reserved_instances_offering(params = {}) ⇒ Types::PurchaseReservedInstancesOfferingResult
Purchases a Reserved Instance for use with your account.
-
#purchase_scheduled_instances(params = {}) ⇒ Types::PurchaseScheduledInstancesResult
You can no longer purchase Scheduled Instances. -
#reboot_instances(params = {}) ⇒ Struct
Requests a reboot of the specified instances.
-
#register_image(params = {}) ⇒ Types::RegisterImageResult
Registers an AMI.
-
#register_instance_event_notification_attributes(params = {}) ⇒ Types::RegisterInstanceEventNotificationAttributesResult
Registers a set of tag keys to include in scheduled event notifications for your resources.
-
#register_transit_gateway_multicast_group_members(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupMembersResult
Registers members (network interfaces) with the transit gateway multicast group.
-
#register_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupSourcesResult
Registers sources (network interfaces) with the specified transit gateway multicast group.
-
#reject_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::RejectTransitGatewayMulticastDomainAssociationsResult
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
-
#reject_transit_gateway_peering_attachment(params = {}) ⇒ Types::RejectTransitGatewayPeeringAttachmentResult
Rejects a transit gateway peering attachment request.
-
#reject_transit_gateway_vpc_attachment(params = {}) ⇒ Types::RejectTransitGatewayVpcAttachmentResult
Rejects a request to attach a VPC to a transit gateway.
-
#reject_vpc_endpoint_connections(params = {}) ⇒ Types::RejectVpcEndpointConnectionsResult
Rejects VPC endpoint connection requests to your VPC endpoint service.
-
#reject_vpc_peering_connection(params = {}) ⇒ Types::RejectVpcPeeringConnectionResult
Rejects a VPC peering connection request.
-
#release_address(params = {}) ⇒ Struct
Releases the specified Elastic IP address.
-
#release_hosts(params = {}) ⇒ Types::ReleaseHostsResult
When you no longer want to use an On-Demand Dedicated Host it can be released.
-
#release_ipam_pool_allocation(params = {}) ⇒ Types::ReleaseIpamPoolAllocationResult
Release an allocation within an IPAM pool.
-
#replace_iam_instance_profile_association(params = {}) ⇒ Types::ReplaceIamInstanceProfileAssociationResult
Replaces an IAM instance profile for the specified running instance.
-
#replace_network_acl_association(params = {}) ⇒ Types::ReplaceNetworkAclAssociationResult
Changes which network ACL a subnet is associated with.
-
#replace_network_acl_entry(params = {}) ⇒ Struct
Replaces an entry (rule) in a network ACL.
-
#replace_route(params = {}) ⇒ Struct
Replaces an existing route within a route table in a VPC.
-
#replace_route_table_association(params = {}) ⇒ Types::ReplaceRouteTableAssociationResult
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC.
-
#replace_transit_gateway_route(params = {}) ⇒ Types::ReplaceTransitGatewayRouteResult
Replaces the specified route in the specified transit gateway route table.
-
#replace_vpn_tunnel(params = {}) ⇒ Types::ReplaceVpnTunnelResult
Trigger replacement of specified VPN tunnel.
-
#report_instance_status(params = {}) ⇒ Struct
Submits feedback about the status of an instance.
-
#request_spot_fleet(params = {}) ⇒ Types::RequestSpotFleetResponse
Creates a Spot Fleet request.
-
#request_spot_instances(params = {}) ⇒ Types::RequestSpotInstancesResult
Creates a Spot Instance request.
-
#reset_address_attribute(params = {}) ⇒ Types::ResetAddressAttributeResult
Resets the attribute of the specified IP address.
-
#reset_ebs_default_kms_key_id(params = {}) ⇒ Types::ResetEbsDefaultKmsKeyIdResult
Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
-
#reset_fpga_image_attribute(params = {}) ⇒ Types::ResetFpgaImageAttributeResult
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.
-
#reset_image_attribute(params = {}) ⇒ Struct
Resets an attribute of an AMI to its default value.
-
#reset_instance_attribute(params = {}) ⇒ Struct
Resets an attribute of an instance to its default value.
-
#reset_network_interface_attribute(params = {}) ⇒ Struct
Resets a network interface attribute.
-
#reset_snapshot_attribute(params = {}) ⇒ Struct
Resets permission settings for the specified snapshot.
-
#restore_address_to_classic(params = {}) ⇒ Types::RestoreAddressToClassicResult
This action is deprecated. -
#restore_image_from_recycle_bin(params = {}) ⇒ Types::RestoreImageFromRecycleBinResult
Restores an AMI from the Recycle Bin.
-
#restore_managed_prefix_list_version(params = {}) ⇒ Types::RestoreManagedPrefixListVersionResult
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
-
#restore_snapshot_from_recycle_bin(params = {}) ⇒ Types::RestoreSnapshotFromRecycleBinResult
Restores a snapshot from the Recycle Bin.
-
#restore_snapshot_tier(params = {}) ⇒ Types::RestoreSnapshotTierResult
Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
-
#revoke_client_vpn_ingress(params = {}) ⇒ Types::RevokeClientVpnIngressResult
Removes an ingress authorization rule from a Client VPN endpoint.
-
#revoke_security_group_egress(params = {}) ⇒ Types::RevokeSecurityGroupEgressResult
Removes the specified outbound (egress) rules from the specified security group.
-
#revoke_security_group_ingress(params = {}) ⇒ Types::RevokeSecurityGroupIngressResult
Removes the specified inbound (ingress) rules from a security group.
-
#run_instances(params = {}) ⇒ Types::Reservation
Launches the specified number of instances using an AMI for which you have permissions.
-
#run_scheduled_instances(params = {}) ⇒ Types::RunScheduledInstancesResult
Launches the specified Scheduled Instances.
-
#search_local_gateway_routes(params = {}) ⇒ Types::SearchLocalGatewayRoutesResult
Searches for routes in the specified local gateway route table.
-
#search_transit_gateway_multicast_groups(params = {}) ⇒ Types::SearchTransitGatewayMulticastGroupsResult
Searches one or more transit gateway multicast groups and returns the group membership information.
-
#search_transit_gateway_routes(params = {}) ⇒ Types::SearchTransitGatewayRoutesResult
Searches for routes in the specified transit gateway route table.
-
#send_diagnostic_interrupt(params = {}) ⇒ Struct
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances).
-
#start_instances(params = {}) ⇒ Types::StartInstancesResult
Starts an Amazon EBS-backed instance that you've previously stopped.
-
#start_network_insights_access_scope_analysis(params = {}) ⇒ Types::StartNetworkInsightsAccessScopeAnalysisResult
Starts analyzing the specified Network Access Scope.
-
#start_network_insights_analysis(params = {}) ⇒ Types::StartNetworkInsightsAnalysisResult
Starts analyzing the specified path.
-
#start_vpc_endpoint_service_private_dns_verification(params = {}) ⇒ Types::StartVpcEndpointServicePrivateDnsVerificationResult
Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
-
#stop_instances(params = {}) ⇒ Types::StopInstancesResult
Stops an Amazon EBS-backed instance.
-
#terminate_client_vpn_connections(params = {}) ⇒ Types::TerminateClientVpnConnectionsResult
Terminates active Client VPN endpoint connections.
-
#terminate_instances(params = {}) ⇒ Types::TerminateInstancesResult
Shuts down the specified instances.
-
#unassign_ipv_6_addresses(params = {}) ⇒ Types::UnassignIpv6AddressesResult
Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
-
#unassign_private_ip_addresses(params = {}) ⇒ Struct
Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.
-
#unassign_private_nat_gateway_address(params = {}) ⇒ Types::UnassignPrivateNatGatewayAddressResult
Unassigns secondary private IPv4 addresses from a private NAT gateway.
-
#unlock_snapshot(params = {}) ⇒ Types::UnlockSnapshotResult
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period.
-
#unmonitor_instances(params = {}) ⇒ Types::UnmonitorInstancesResult
Disables detailed monitoring for a running instance.
-
#update_security_group_rule_descriptions_egress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsEgressResult
Updates the description of an egress (outbound) security group rule.
-
#update_security_group_rule_descriptions_ingress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsIngressResult
Updates the description of an ingress (inbound) security group rule.
-
#withdraw_byoip_cidr(params = {}) ⇒ Types::WithdrawByoipCidrResult
Stops advertising an address range that is provisioned as an address pool.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
414 415 416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 414 def initialize(*args) super end |
Instance Method Details
#accept_address_transfer(params = {}) ⇒ Types::AcceptAddressTransferResult
Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
479 480 481 482 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 479 def accept_address_transfer(params = {}, = {}) req = build_request(:accept_address_transfer, params) req.send_request() end |
#accept_reserved_instances_exchange_quote(params = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
526 527 528 529 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 526 def accept_reserved_instances_exchange_quote(params = {}, = {}) req = build_request(:accept_reserved_instances_exchange_quote, params) req.send_request() end |
#accept_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::AcceptTransitGatewayMulticastDomainAssociationsResult
Accepts a request to associate subnets with a transit gateway multicast domain.
578 579 580 581 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 578 def accept_transit_gateway_multicast_domain_associations(params = {}, = {}) req = build_request(:accept_transit_gateway_multicast_domain_associations, params) req.send_request() end |
#accept_transit_gateway_peering_attachment(params = {}) ⇒ Types::AcceptTransitGatewayPeeringAttachmentResult
Accepts a transit gateway peering attachment request. The peering
attachment must be in the pendingAcceptance
state.
631 632 633 634 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 631 def (params = {}, = {}) req = build_request(:accept_transit_gateway_peering_attachment, params) req.send_request() end |
#accept_transit_gateway_vpc_attachment(params = {}) ⇒ Types::AcceptTransitGatewayVpcAttachmentResult
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance
state. Use
DescribeTransitGatewayVpcAttachments to view your pending VPC
attachment requests. Use RejectTransitGatewayVpcAttachment to reject a
VPC attachment request.
685 686 687 688 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 685 def (params = {}, = {}) req = build_request(:accept_transit_gateway_vpc_attachment, params) req.send_request() end |
#accept_vpc_endpoint_connections(params = {}) ⇒ Types::AcceptVpcEndpointConnectionsResult
Accepts connection requests to your VPC endpoint service.
727 728 729 730 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 727 def accept_vpc_endpoint_connections(params = {}, = {}) req = build_request(:accept_vpc_endpoint_connections, params) req.send_request() end |
#accept_vpc_peering_connection(params = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
Accept a VPC peering connection request. To accept a request, the VPC
peering connection must be in the pending-acceptance
state, and you
must be the owner of the peer VPC. Use DescribeVpcPeeringConnections
to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
797 798 799 800 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 797 def accept_vpc_peering_connection(params = {}, = {}) req = build_request(:accept_vpc_peering_connection, params) req.send_request() end |
#advertise_byoip_cidr(params = {}) ⇒ Types::AdvertiseByoipCidrResult
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).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
891 892 893 894 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 891 def advertise_byoip_cidr(params = {}, = {}) req = build_request(:advertise_byoip_cidr, params) req.send_request() end |
#allocate_address(params = {}) ⇒ Types::AllocateAddressResult
Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
1025 1026 1027 1028 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1025 def allocate_address(params = {}, = {}) req = build_request(:allocate_address, params) req.send_request() end |
#allocate_hosts(params = {}) ⇒ Types::AllocateHostsResult
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1172 def allocate_hosts(params = {}, = {}) req = build_request(:allocate_hosts, params) req.send_request() end |
#allocate_ipam_pool_cidr(params = {}) ⇒ Types::AllocateIpamPoolCidrResult
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1290 def allocate_ipam_pool_cidr(params = {}, = {}) req = build_request(:allocate_ipam_pool_cidr, params) req.send_request() end |
#apply_security_groups_to_client_vpn_target_network(params = {}) ⇒ Types::ApplySecurityGroupsToClientVpnTargetNetworkResult
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1338 def apply_security_groups_to_client_vpn_target_network(params = {}, = {}) req = build_request(:apply_security_groups_to_client_vpn_target_network, params) req.send_request() end |
#assign_ipv_6_addresses(params = {}) ⇒ Types::AssignIpv6AddressesResult
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1414 def assign_ipv_6_addresses(params = {}, = {}) req = build_request(:assign_ipv_6_addresses, params) req.send_request() end |
#assign_private_ip_addresses(params = {}) ⇒ Types::AssignPrivateIpAddressesResult
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an
IP address from one network interface to another, check
network/interfaces/macs/mac/local-ipv4s
in the instance metadata to
confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1533 def assign_private_ip_addresses(params = {}, = {}) req = build_request(:assign_private_ip_addresses, params) req.send_request() end |
#assign_private_nat_gateway_address(params = {}) ⇒ Types::AssignPrivateNatGatewayAddressResult
Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1595 def assign_private_nat_gateway_address(params = {}, = {}) req = build_request(:assign_private_nat_gateway_address, params) req.send_request() end |
#associate_address(params = {}) ⇒ Types::AssociateAddressResult
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. Before you can use an Elastic IP address, you must allocate it to your account.
If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
1715 1716 1717 1718 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1715 def associate_address(params = {}, = {}) req = build_request(:associate_address, params) req.send_request() end |
#associate_client_vpn_target_network(params = {}) ⇒ Types::AssociateClientVpnTargetNetworkResult
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
1780 1781 1782 1783 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1780 def associate_client_vpn_target_network(params = {}, = {}) req = build_request(:associate_client_vpn_target_network, params) req.send_request() end |
#associate_dhcp_options(params = {}) ⇒ Struct
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP option sets in the Amazon VPC User Guide.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1848 def (params = {}, = {}) req = build_request(:associate_dhcp_options, params) req.send_request() end |
#associate_enclave_certificate_iam_role(params = {}) ⇒ Types::AssociateEnclaveCertificateIamRoleResult
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant
it permission to call s3:GetObject
on the Amazon S3 bucket returned
by the command. To enable the IAM role to access the KMS key, you must
grant it permission to call kms:Decrypt
on the KMS key returned by
the command. For more information, see Grant the role permission to
access the certificate and encryption key in the Amazon Web
Services Nitro Enclaves User Guide.
1916 1917 1918 1919 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1916 def associate_enclave_certificate_iam_role(params = {}, = {}) req = build_request(:associate_enclave_certificate_iam_role, params) req.send_request() end |
#associate_iam_instance_profile(params = {}) ⇒ Types::AssociateIamInstanceProfileResult
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
1983 1984 1985 1986 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1983 def associate_iam_instance_profile(params = {}, = {}) req = build_request(:associate_iam_instance_profile, params) req.send_request() end |
#associate_instance_event_window(params = {}) ⇒ Types::AssociateInstanceEventWindowResult
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
2058 2059 2060 2061 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2058 def associate_instance_event_window(params = {}, = {}) req = build_request(:associate_instance_event_window, params) req.send_request() end |
#associate_ipam_byoasn(params = {}) ⇒ Types::AssociateIpamByoasnResult
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
2113 2114 2115 2116 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2113 def associate_ipam_byoasn(params = {}, = {}) req = build_request(:associate_ipam_byoasn, params) req.send_request() end |
#associate_ipam_resource_discovery(params = {}) ⇒ Types::AssociateIpamResourceDiscoveryResult
Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2187 def associate_ipam_resource_discovery(params = {}, = {}) req = build_request(:associate_ipam_resource_discovery, params) req.send_request() end |
#associate_nat_gateway_address(params = {}) ⇒ Types::AssociateNatGatewayAddressResult
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
2264 2265 2266 2267 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2264 def associate_nat_gateway_address(params = {}, = {}) req = build_request(:associate_nat_gateway_address, params) req.send_request() end |
#associate_route_table(params = {}) ⇒ Types::AssociateRouteTableResult
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. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon VPC User Guide.
2337 2338 2339 2340 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2337 def associate_route_table(params = {}, = {}) req = build_request(:associate_route_table, params) req.send_request() end |
#associate_subnet_cidr_block(params = {}) ⇒ Types::AssociateSubnetCidrBlockResult
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.
2383 2384 2385 2386 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2383 def associate_subnet_cidr_block(params = {}, = {}) req = build_request(:associate_subnet_cidr_block, params) req.send_request() end |
#associate_transit_gateway_multicast_domain(params = {}) ⇒ Types::AssociateTransitGatewayMulticastDomainResult
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2444 def associate_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:associate_transit_gateway_multicast_domain, params) req.send_request() end |
#associate_transit_gateway_policy_table(params = {}) ⇒ Types::AssociateTransitGatewayPolicyTableResult
Associates the specified transit gateway attachment with a transit gateway policy table.
2490 2491 2492 2493 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2490 def associate_transit_gateway_policy_table(params = {}, = {}) req = build_request(:associate_transit_gateway_policy_table, params) req.send_request() end |
#associate_transit_gateway_route_table(params = {}) ⇒ Types::AssociateTransitGatewayRouteTableResult
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
2535 2536 2537 2538 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2535 def associate_transit_gateway_route_table(params = {}, = {}) req = build_request(:associate_transit_gateway_route_table, params) req.send_request() end |
#associate_trunk_interface(params = {}) ⇒ Types::AssociateTrunkInterfaceResult
Associates a branch network interface with a trunk network interface.
Before you create the association, use CreateNetworkInterface
command and set the interface type to trunk
. You must also create a
network interface for each branch network interface that you want to
associate with the trunk network interface.
2614 2615 2616 2617 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2614 def associate_trunk_interface(params = {}, = {}) req = build_request(:associate_trunk_interface, params) req.send_request() end |
#associate_vpc_cidr_block(params = {}) ⇒ Types::AssociateVpcCidrBlockResult
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2743 def associate_vpc_cidr_block(params = {}, = {}) req = build_request(:associate_vpc_cidr_block, params) req.send_request() end |
#attach_classic_link_vpc(params = {}) ⇒ Types::AttachClassicLinkVpcResult
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one
or more of the VPC security groups. You cannot link an EC2-Classic
instance to more than one VPC at a time. You can only link an instance
that's in the running
state. An instance is automatically unlinked
from a VPC when it's stopped - you can link it to the VPC again when
you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2803 def attach_classic_link_vpc(params = {}, = {}) req = build_request(:attach_classic_link_vpc, params) req.send_request() end |
#attach_internet_gateway(params = {}) ⇒ Struct
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.
2853 2854 2855 2856 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2853 def attach_internet_gateway(params = {}, = {}) req = build_request(:attach_internet_gateway, params) req.send_request() end |
#attach_network_interface(params = {}) ⇒ Types::AttachNetworkInterfaceResult
Attaches a network interface to an instance.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2930 def attach_network_interface(params = {}, = {}) req = build_request(:attach_network_interface, params) req.send_request() end |
#attach_verified_access_trust_provider(params = {}) ⇒ Types::AttachVerifiedAccessTrustProviderResult
Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
3020 3021 3022 3023 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3020 def attach_verified_access_trust_provider(params = {}, = {}) req = build_request(:attach_verified_access_trust_provider, params) req.send_request() end |
#attach_volume(params = {}) ⇒ Types::VolumeAttachment
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.
3128 3129 3130 3131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3128 def attach_volume(params = {}, = {}) req = build_request(:attach_volume, params) req.send_request() end |
#attach_vpn_gateway(params = {}) ⇒ Types::AttachVpnGatewayResult
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
3176 3177 3178 3179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3176 def attach_vpn_gateway(params = {}, = {}) req = build_request(:attach_vpn_gateway, params) req.send_request() end |
#authorize_client_vpn_ingress(params = {}) ⇒ Types::AuthorizeClientVpnIngressResult
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
3251 3252 3253 3254 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3251 def (params = {}, = {}) req = build_request(:authorize_client_vpn_ingress, params) req.send_request() end |
#authorize_security_group_egress(params = {}) ⇒ Types::AuthorizeSecurityGroupEgressResult
Adds the specified outbound (egress) rules to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules.
You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
3461 3462 3463 3464 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3461 def (params = {}, = {}) req = build_request(:authorize_security_group_egress, params) req.send_request() end |
#authorize_security_group_ingress(params = {}) ⇒ Types::AuthorizeSecurityGroupIngressResult
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules.
You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
3746 3747 3748 3749 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3746 def (params = {}, = {}) req = build_request(:authorize_security_group_ingress, params) req.send_request() end |
#bundle_instance(params = {}) ⇒ Types::BundleInstanceResult
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.
3818 3819 3820 3821 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3818 def bundle_instance(params = {}, = {}) req = build_request(:bundle_instance, params) req.send_request() end |
#cancel_bundle_task(params = {}) ⇒ Types::CancelBundleTaskResult
Cancels a bundling operation for an instance store-backed Windows instance.
3866 3867 3868 3869 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3866 def cancel_bundle_task(params = {}, = {}) req = build_request(:cancel_bundle_task, params) req.send_request() end |
#cancel_capacity_reservation(params = {}) ⇒ Types::CancelCapacityReservationResult
Cancels the specified Capacity Reservation, releases the reserved
capacity, and changes the Capacity Reservation's state to
cancelled
.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
3910 3911 3912 3913 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3910 def cancel_capacity_reservation(params = {}, = {}) req = build_request(:cancel_capacity_reservation, params) req.send_request() end |
#cancel_capacity_reservation_fleets(params = {}) ⇒ Types::CancelCapacityReservationFleetsResult
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet's status changes to
cancelled
.The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
3962 3963 3964 3965 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3962 def cancel_capacity_reservation_fleets(params = {}, = {}) req = build_request(:cancel_capacity_reservation_fleets, params) req.send_request() end |
#cancel_conversion_task(params = {}) ⇒ Struct
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
4006 4007 4008 4009 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4006 def cancel_conversion_task(params = {}, = {}) req = build_request(:cancel_conversion_task, params) req.send_request() end |
#cancel_export_task(params = {}) ⇒ Struct
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
4032 4033 4034 4035 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4032 def cancel_export_task(params = {}, = {}) req = build_request(:cancel_export_task, params) req.send_request() end |
#cancel_image_launch_permission(params = {}) ⇒ Types::CancelImageLaunchPermissionResult
Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
4075 4076 4077 4078 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4075 def (params = {}, = {}) req = build_request(:cancel_image_launch_permission, params) req.send_request() end |
#cancel_import_task(params = {}) ⇒ Types::CancelImportTaskResult
Cancels an in-process import virtual machine or import snapshot task.
4118 4119 4120 4121 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4118 def cancel_import_task(params = {}, = {}) req = build_request(:cancel_import_task, params) req.send_request() end |
#cancel_reserved_instances_listing(params = {}) ⇒ Types::CancelReservedInstancesListingResult
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
4172 4173 4174 4175 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4172 def cancel_reserved_instances_listing(params = {}, = {}) req = build_request(:cancel_reserved_instances_listing, params) req.send_request() end |
#cancel_spot_fleet_requests(params = {}) ⇒ Types::CancelSpotFleetRequestsResponse
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should
terminate its instances. If you choose to terminate the instances, the
Spot Fleet request enters the cancelled_terminating
state.
Otherwise, the Spot Fleet request enters the cancelled_running
state
and the instances continue to run until they are interrupted or you
terminate them manually.
Restrictions
- You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
^
4287 4288 4289 4290 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4287 def cancel_spot_fleet_requests(params = {}, = {}) req = build_request(:cancel_spot_fleet_requests, params) req.send_request() end |
#cancel_spot_instance_requests(params = {}) ⇒ Types::CancelSpotInstanceRequestsResult
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
4348 4349 4350 4351 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4348 def cancel_spot_instance_requests(params = {}, = {}) req = build_request(:cancel_spot_instance_requests, params) req.send_request() end |
#confirm_product_instance(params = {}) ⇒ Types::ConfirmProductInstanceResult
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
4407 4408 4409 4410 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4407 def confirm_product_instance(params = {}, = {}) req = build_request(:confirm_product_instance, params) req.send_request() end |
#copy_fpga_image(params = {}) ⇒ Types::CopyFpgaImageResult
Copies the specified Amazon FPGA Image (AFI) to the current Region.
4464 4465 4466 4467 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4464 def copy_fpga_image(params = {}, = {}) req = build_request(:copy_fpga_image, params) req.send_request() end |
#copy_image(params = {}) ⇒ Types::CopyImageResult
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region
using the SourceRegion parameter, and specify the destination
Region using its endpoint. Copies of encrypted backing snapshots for
the AMI are encrypted. Copies of unencrypted backing snapshots remain
unencrypted, unless you set Encrypted
during the copy operation. You
cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
4667 4668 4669 4670 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4667 def copy_image(params = {}, = {}) req = build_request(:copy_image, params) req.send_request() end |
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
4888 4889 4890 4891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4888 def copy_snapshot(params = {}, = {}) req = build_request(:copy_snapshot, params) req.send_request() end |
#create_capacity_reservation(params = {}) ⇒ Types::CreateCapacityReservationResult
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
5114 5115 5116 5117 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5114 def create_capacity_reservation(params = {}, = {}) req = build_request(:create_capacity_reservation, params) req.send_request() end |
#create_capacity_reservation_fleet(params = {}) ⇒ Types::CreateCapacityReservationFleetResult
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
5290 5291 5292 5293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5290 def create_capacity_reservation_fleet(params = {}, = {}) req = build_request(:create_capacity_reservation_fleet, params) req.send_request() end |
#create_carrier_gateway(params = {}) ⇒ Types::CreateCarrierGatewayResult
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
5364 5365 5366 5367 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5364 def create_carrier_gateway(params = {}, = {}) req = build_request(:create_carrier_gateway, params) req.send_request() end |
#create_client_vpn_endpoint(params = {}) ⇒ Types::CreateClientVpnEndpointResult
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
5570 5571 5572 5573 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5570 def create_client_vpn_endpoint(params = {}, = {}) req = build_request(:create_client_vpn_endpoint, params) req.send_request() end |
#create_client_vpn_route(params = {}) ⇒ Types::CreateClientVpnRouteResult
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
5650 5651 5652 5653 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5650 def create_client_vpn_route(params = {}, = {}) req = build_request(:create_client_vpn_route, params) req.send_request() end |
#create_coip_cidr(params = {}) ⇒ Types::CreateCoipCidrResult
Creates a range of customer-owned IP addresses.
5691 5692 5693 5694 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5691 def create_coip_cidr(params = {}, = {}) req = build_request(:create_coip_cidr, params) req.send_request() end |
#create_coip_pool(params = {}) ⇒ Types::CreateCoipPoolResult
Creates a pool of customer-owned IP (CoIP) addresses.
5747 5748 5749 5750 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5747 def create_coip_pool(params = {}, = {}) req = build_request(:create_coip_pool, params) req.send_request() end |
#create_customer_gateway(params = {}) ⇒ Types::CreateCustomerGatewayResult
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
5894 5895 5896 5897 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5894 def create_customer_gateway(params = {}, = {}) req = build_request(:create_customer_gateway, params) req.send_request() end |
#create_default_subnet(params = {}) ⇒ Types::CreateDefaultSubnetResult
Creates a default subnet with a size /20
IPv4 CIDR block in the
specified Availability Zone in your default VPC. You can have only one
default subnet per Availability Zone. For more information, see
Create a default subnet in the Amazon VPC User Guide.
5970 5971 5972 5973 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5970 def create_default_subnet(params = {}, = {}) req = build_request(:create_default_subnet, params) req.send_request() end |
#create_default_vpc(params = {}) ⇒ Types::CreateDefaultVpcResult
Creates a default VPC with a size /16
IPv4 CIDR block and a default
subnet in each Availability Zone. For more information about the
components of a default VPC, see Default VPCs in the Amazon VPC
User Guide. You cannot specify the components of the default VPC
yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
6033 6034 6035 6036 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6033 def create_default_vpc(params = {}, = {}) req = build_request(:create_default_vpc, params) req.send_request() end |
#create_dhcp_options(params = {}) ⇒ Types::CreateDhcpOptionsResult
Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP option sets in the Amazon VPC User Guide.
domain-name
- If you're using AmazonProvidedDNS inus-east-1
, specifyec2.internal
. If you're using AmazonProvidedDNS in any other Region, specifyregion.compute.internal
. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers
- The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified indomain-name
, you must specify a custom DNS server.ntp-servers
- The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).netbios-name-servers
- The IP addresses of up to four NetBIOS name servers.netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.ipv6-address-preferred-lease-time
- A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
6184 6185 6186 6187 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6184 def (params = {}, = {}) req = build_request(:create_dhcp_options, params) req.send_request() end |
#create_egress_only_internet_gateway(params = {}) ⇒ Types::CreateEgressOnlyInternetGatewayResult
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
6256 6257 6258 6259 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6256 def create_egress_only_internet_gateway(params = {}, = {}) req = build_request(:create_egress_only_internet_gateway, params) req.send_request() end |
#create_fleet(params = {}) ⇒ Types::CreateFleetResult
Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.
A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
6645 6646 6647 6648 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6645 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#create_flow_logs(params = {}) ⇒ Types::CreateFlowLogsResult
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon VPC User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon VPC User Guide.
6843 6844 6845 6846 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6843 def create_flow_logs(params = {}, = {}) req = build_request(:create_flow_logs, params) req.send_request() end |
#create_fpga_image(params = {}) ⇒ Types::CreateFpgaImageResult
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
6936 6937 6938 6939 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6936 def create_fpga_image(params = {}, = {}) req = build_request(:create_fpga_image, params) req.send_request() end |
#create_image(params = {}) ⇒ Types::CreateImageResult
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Create an Amazon EBS-backed Linux AMI in the Amazon Elastic Compute Cloud User Guide.
7111 7112 7113 7114 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7111 def create_image(params = {}, = {}) req = build_request(:create_image, params) req.send_request() end |
#create_instance_connect_endpoint(params = {}) ⇒ Types::CreateInstanceConnectEndpointResult
Creates an EC2 Instance Connect Endpoint.
An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
7219 7220 7221 7222 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7219 def create_instance_connect_endpoint(params = {}, = {}) req = build_request(:create_instance_connect_endpoint, params) req.send_request() end |
#create_instance_event_window(params = {}) ⇒ Types::CreateInstanceEventWindowResult
Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.
You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.
You can create up to 200 event windows per Amazon Web Services Region.
When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.
Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.
Event windows are not applicable for:
Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
7357 7358 7359 7360 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7357 def create_instance_event_window(params = {}, = {}) req = build_request(:create_instance_event_window, params) req.send_request() end |
#create_instance_export_task(params = {}) ⇒ Types::CreateInstanceExportTaskResult
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
7438 7439 7440 7441 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7438 def create_instance_export_task(params = {}, = {}) req = build_request(:create_instance_export_task, params) req.send_request() end |
#create_internet_gateway(params = {}) ⇒ Types::CreateInternetGatewayResult
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information, see Internet gateways in the Amazon VPC User Guide.
7517 7518 7519 7520 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7517 def create_internet_gateway(params = {}, = {}) req = build_request(:create_internet_gateway, params) req.send_request() end |
#create_ipam(params = {}) ⇒ Types::CreateIpamResult
Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.
For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.
7640 7641 7642 7643 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7640 def create_ipam(params = {}, = {}) req = build_request(:create_ipam, params) req.send_request() end |
#create_ipam_pool(params = {}) ⇒ Types::CreateIpamPoolResult
Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.
For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.
7863 7864 7865 7866 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7863 def create_ipam_pool(params = {}, = {}) req = build_request(:create_ipam_pool, params) req.send_request() end |
#create_ipam_resource_discovery(params = {}) ⇒ Types::CreateIpamResourceDiscoveryResult
Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
7943 7944 7945 7946 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7943 def create_ipam_resource_discovery(params = {}, = {}) req = build_request(:create_ipam_resource_discovery, params) req.send_request() end |
#create_ipam_scope(params = {}) ⇒ Types::CreateIpamScopeResult
Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see Add a scope in the Amazon VPC IPAM User Guide.
8038 8039 8040 8041 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8038 def create_ipam_scope(params = {}, = {}) req = build_request(:create_ipam_scope, params) req.send_request() end |
#create_key_pair(params = {}) ⇒ Types::KeyPair
Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
You can have up to 5,000 key pairs per Amazon Web Services Region.
For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
8141 8142 8143 8144 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8141 def create_key_pair(params = {}, = {}) req = build_request(:create_key_pair, params) req.send_request() end |
#create_launch_template(params = {}) ⇒ Types::CreateLaunchTemplateResult
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon EC2 User Guide.
To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon EC2 User Guide.
8520 8521 8522 8523 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8520 def create_launch_template(params = {}, = {}) req = build_request(:create_launch_template, params) req.send_request() end |
#create_launch_template_version(params = {}) ⇒ Types::CreateLaunchTemplateVersionResult
Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed.
Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions.
Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon EC2 User Guide.
9059 9060 9061 9062 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9059 def create_launch_template_version(params = {}, = {}) req = build_request(:create_launch_template_version, params) req.send_request() end |
#create_local_gateway_route(params = {}) ⇒ Types::CreateLocalGatewayRouteResult
Creates a static route for the specified local gateway route table. You must specify one of the following targets:
LocalGatewayVirtualInterfaceGroupId
NetworkInterfaceId
9128 9129 9130 9131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9128 def create_local_gateway_route(params = {}, = {}) req = build_request(:create_local_gateway_route, params) req.send_request() end |
#create_local_gateway_route_table(params = {}) ⇒ Types::CreateLocalGatewayRouteTableResult
Creates a local gateway route table.
9192 9193 9194 9195 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9192 def create_local_gateway_route_table(params = {}, = {}) req = build_request(:create_local_gateway_route_table, params) req.send_request() end |
#create_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult
Creates a local gateway route table virtual interface group association.
9257 9258 9259 9260 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9257 def create_local_gateway_route_table_virtual_interface_group_association(params = {}, = {}) req = build_request(:create_local_gateway_route_table_virtual_interface_group_association, params) req.send_request() end |
#create_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::CreateLocalGatewayRouteTableVpcAssociationResult
Associates the specified VPC with the specified local gateway route table.
9320 9321 9322 9323 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9320 def create_local_gateway_route_table_vpc_association(params = {}, = {}) req = build_request(:create_local_gateway_route_table_vpc_association, params) req.send_request() end |
#create_managed_prefix_list(params = {}) ⇒ Types::CreateManagedPrefixListResult
Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
9419 9420 9421 9422 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9419 def create_managed_prefix_list(params = {}, = {}) req = build_request(:create_managed_prefix_list, params) req.send_request() end |
#create_nat_gateway(params = {}) ⇒ Types::CreateNatGatewayResult
Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon VPC User Guide.
When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
9617 9618 9619 9620 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9617 def create_nat_gateway(params = {}, = {}) req = build_request(:create_nat_gateway, params) req.send_request() end |
#create_network_acl(params = {}) ⇒ Types::CreateNetworkAclResult
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon VPC User Guide.
9749 9750 9751 9752 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9749 def create_network_acl(params = {}, = {}) req = build_request(:create_network_acl, params) req.send_request() end |
#create_network_acl_entry(params = {}) ⇒ Struct
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon VPC User Guide.
9875 9876 9877 9878 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9875 def create_network_acl_entry(params = {}, = {}) req = build_request(:create_network_acl_entry, params) req.send_request() end |
#create_network_insights_access_scope(params = {}) ⇒ Types::CreateNetworkInsightsAccessScopeResult
Creates a Network Access Scope.
Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.
10125 10126 10127 10128 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10125 def create_network_insights_access_scope(params = {}, = {}) req = build_request(:create_network_insights_access_scope, params) req.send_request() end |
#create_network_insights_path(params = {}) ⇒ Types::CreateNetworkInsightsPathResult
Creates a path to analyze for reachability.
Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide.
10276 10277 10278 10279 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10276 def create_network_insights_path(params = {}, = {}) req = build_request(:create_network_insights_path, params) req.send_request() end |
#create_network_interface(params = {}) ⇒ Types::CreateNetworkInterfaceResult
Creates a network interface in the specified subnet.
The number of IP addresses you can assign to a network interface varies by instance type.
For more information about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.
10597 10598 10599 10600 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10597 def create_network_interface(params = {}, = {}) req = build_request(:create_network_interface, params) req.send_request() end |
#create_network_interface_permission(params = {}) ⇒ Types::CreateNetworkInterfacePermissionResult
Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single Amazon Web Services account only, and only one account at a time.
10654 10655 10656 10657 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10654 def (params = {}, = {}) req = build_request(:create_network_interface_permission, params) req.send_request() end |
#create_placement_group(params = {}) ⇒ Types::CreatePlacementGroupResult
Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster
placement group is a logical grouping of instances within
a single Availability Zone that benefit from low network latency, high
network throughput. A spread
placement group places instances on
distinct hardware. A partition
placement group places groups of
instances in different partitions, where instances in one partition do
not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
10762 10763 10764 10765 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10762 def create_placement_group(params = {}, = {}) req = build_request(:create_placement_group, params) req.send_request() end |
#create_public_ipv_4_pool(params = {}) ⇒ Types::CreatePublicIpv4PoolResult
Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.
10819 10820 10821 10822 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10819 def create_public_ipv_4_pool(params = {}, = {}) req = build_request(:create_public_ipv_4_pool, params) req.send_request() end |
#create_replace_root_volume_task(params = {}) ⇒ Types::CreateReplaceRootVolumeTaskResult
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, or that is restored from an AMI that has the same key
characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon EC2 User Guide.
10931 10932 10933 10934 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10931 def create_replace_root_volume_task(params = {}, = {}) req = build_request(:create_replace_root_volume_task, params) req.send_request() end |
#create_reserved_instances_listing(params = {}) ⇒ Types::CreateReservedInstancesListingResult
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
11036 11037 11038 11039 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11036 def create_reserved_instances_listing(params = {}, = {}) req = build_request(:create_reserved_instances_listing, params) req.send_request() end |
#create_restore_image_task(params = {}) ⇒ Types::CreateRestoreImageTaskResult
Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
11116 11117 11118 11119 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11116 def create_restore_image_task(params = {}, = {}) req = build_request(:create_restore_image_task, params) req.send_request() end |
#create_route(params = {}) ⇒ Types::CreateRouteResult
Creates a route in a route table within a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list.
When determining how to route traffic, we use the route with the most
specific match. For example, traffic is destined for the IPv4 address
192.0.2.3
, and the route table includes the following two IPv4
routes:
192.0.2.0/24
(goes to some target A)192.0.2.0/28
(goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3
. However,
the second route in the list covers a smaller number of IP addresses
and is therefore more specific, so we use that route to determine
where to target the traffic.
For more information about route tables, see Route tables in the Amazon VPC User Guide.
11255 11256 11257 11258 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11255 def create_route(params = {}, = {}) req = build_request(:create_route, params) req.send_request() end |
#create_route_table(params = {}) ⇒ Types::CreateRouteTableResult
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route tables in the Amazon VPC User Guide.
11389 11390 11391 11392 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11389 def create_route_table(params = {}, = {}) req = build_request(:create_route_table, params) req.send_request() end |
#create_security_group(params = {}) ⇒ Types::CreateSecurityGroupResult
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name.
You have a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
11505 11506 11507 11508 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11505 def create_security_group(params = {}, = {}) req = build_request(:create_security_group, params) req.send_request() end |
#create_snapshot(params = {}) ⇒ Types::Snapshot
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However,
snapshots only capture data that has been written to your Amazon EBS
volume at the time the snapshot command is issued; this might exclude
any data that has been cached by any applications or the operating
system. If you can pause any file systems on the volume long enough to
take a snapshot, your snapshot should be complete. However, if you
cannot pause all file writes to the volume, you should unmount the
volume from within the instance, issue the snapshot command, and then
remount the volume to ensure a consistent and complete snapshot. You
may remount and use your volume while the snapshot status is
pending
.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Amazon EBS and Amazon EBS encryption in the Amazon EBS User Guide.
11687 11688 11689 11690 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11687 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#create_snapshots(params = {}) ⇒ Types::CreateSnapshotsResult
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.
You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.
You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
11801 11802 11803 11804 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11801 def create_snapshots(params = {}, = {}) req = build_request(:create_snapshots, params) req.send_request() end |
#create_spot_datafeed_subscription(params = {}) ⇒ Types::CreateSpotDatafeedSubscriptionResult
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.
11878 11879 11880 11881 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11878 def create_spot_datafeed_subscription(params = {}, = {}) req = build_request(:create_spot_datafeed_subscription, params) req.send_request() end |
#create_store_image_task(params = {}) ⇒ Types::CreateStoreImageTaskResult
Stores an AMI as a single object in an Amazon S3 bucket.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
11942 11943 11944 11945 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11942 def create_store_image_task(params = {}, = {}) req = build_request(:create_store_image_task, params) req.send_request() end |
#create_subnet(params = {}) ⇒ Types::CreateSubnetResult
Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.
A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block.
The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use.
If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information, see Subnets in the Amazon VPC User Guide.
12135 12136 12137 12138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12135 def create_subnet(params = {}, = {}) req = build_request(:create_subnet, params) req.send_request() end |
#create_subnet_cidr_reservation(params = {}) ⇒ Types::CreateSubnetCidrReservationResult
Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon VPC User Guide and Assign prefixes to network interfaces in the Amazon EC2 User Guide.
12218 12219 12220 12221 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12218 def create_subnet_cidr_reservation(params = {}, = {}) req = build_request(:create_subnet_cidr_reservation, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide.
12295 12296 12297 12298 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12295 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_traffic_mirror_filter(params = {}) ⇒ Types::CreateTrafficMirrorFilterResult
Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
12413 12414 12415 12416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12413 def create_traffic_mirror_filter(params = {}, = {}) req = build_request(:create_traffic_mirror_filter, params) req.send_request() end |
#create_traffic_mirror_filter_rule(params = {}) ⇒ Types::CreateTrafficMirrorFilterRuleResult
Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
12548 12549 12550 12551 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12548 def create_traffic_mirror_filter_rule(params = {}, = {}) req = build_request(:create_traffic_mirror_filter_rule, params) req.send_request() end |
#create_traffic_mirror_session(params = {}) ⇒ Types::CreateTrafficMirrorSessionResult
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
12686 12687 12688 12689 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12686 def create_traffic_mirror_session(params = {}, = {}) req = build_request(:create_traffic_mirror_session, params) req.send_request() end |
#create_traffic_mirror_target(params = {}) ⇒ Types::CreateTrafficMirrorTargetResult
Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
12787 12788 12789 12790 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12787 def create_traffic_mirror_target(params = {}, = {}) req = build_request(:create_traffic_mirror_target, params) req.send_request() end |
#create_transit_gateway(params = {}) ⇒ Types::CreateTransitGatewayResult
Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private
clouds (VPC) and on-premises networks. After the transit gateway
enters the available
state, you can attach your VPCs and VPN
connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
12892 12893 12894 12895 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12892 def create_transit_gateway(params = {}, = {}) req = build_request(:create_transit_gateway, params) req.send_request() end |
#create_transit_gateway_connect(params = {}) ⇒ Types::CreateTransitGatewayConnectResult
Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
12962 12963 12964 12965 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12962 def create_transit_gateway_connect(params = {}, = {}) req = build_request(:create_transit_gateway_connect, params) req.send_request() end |
#create_transit_gateway_connect_peer(params = {}) ⇒ Types::CreateTransitGatewayConnectPeerResult
Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.
13065 13066 13067 13068 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13065 def create_transit_gateway_connect_peer(params = {}, = {}) req = build_request(:create_transit_gateway_connect_peer, params) req.send_request() end |
#create_transit_gateway_multicast_domain(params = {}) ⇒ Types::CreateTransitGatewayMulticastDomainResult
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
13141 13142 13143 13144 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13141 def create_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:create_transit_gateway_multicast_domain, params) req.send_request() end |
#create_transit_gateway_peering_attachment(params = {}) ⇒ Types::CreateTransitGatewayPeeringAttachmentResult
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
13233 13234 13235 13236 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13233 def (params = {}, = {}) req = build_request(:create_transit_gateway_peering_attachment, params) req.send_request() end |
#create_transit_gateway_policy_table(params = {}) ⇒ Types::CreateTransitGatewayPolicyTableResult
Creates a transit gateway policy table.
13289 13290 13291 13292 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13289 def create_transit_gateway_policy_table(params = {}, = {}) req = build_request(:create_transit_gateway_policy_table, params) req.send_request() end |
#create_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::CreateTransitGatewayPrefixListReferenceResult
Creates a reference (route) to a prefix list in a specified transit gateway route table.
13344 13345 13346 13347 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13344 def create_transit_gateway_prefix_list_reference(params = {}, = {}) req = build_request(:create_transit_gateway_prefix_list_reference, params) req.send_request() end |
#create_transit_gateway_route(params = {}) ⇒ Types::CreateTransitGatewayRouteResult
Creates a static route for the specified transit gateway route table.
13400 13401 13402 13403 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13400 def create_transit_gateway_route(params = {}, = {}) req = build_request(:create_transit_gateway_route, params) req.send_request() end |
#create_transit_gateway_route_table(params = {}) ⇒ Types::CreateTransitGatewayRouteTableResult
Creates a route table for the specified transit gateway.
13457 13458 13459 13460 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13457 def create_transit_gateway_route_table(params = {}, = {}) req = build_request(:create_transit_gateway_route_table, params) req.send_request() end |
#create_transit_gateway_route_table_announcement(params = {}) ⇒ Types::CreateTransitGatewayRouteTableAnnouncementResult
Advertises a new transit gateway route table.
13523 13524 13525 13526 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13523 def create_transit_gateway_route_table_announcement(params = {}, = {}) req = build_request(:create_transit_gateway_route_table_announcement, params) req.send_request() end |
#create_transit_gateway_vpc_attachment(params = {}) ⇒ Types::CreateTransitGatewayVpcAttachmentResult
Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
13613 13614 13615 13616 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13613 def (params = {}, = {}) req = build_request(:create_transit_gateway_vpc_attachment, params) req.send_request() end |
#create_verified_access_endpoint(params = {}) ⇒ Types::CreateVerifiedAccessEndpointResult
An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
13768 13769 13770 13771 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13768 def create_verified_access_endpoint(params = {}, = {}) req = build_request(:create_verified_access_endpoint, params) req.send_request() end |
#create_verified_access_group(params = {}) ⇒ Types::CreateVerifiedAccessGroupResult
An Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy.
13862 13863 13864 13865 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13862 def create_verified_access_group(params = {}, = {}) req = build_request(:create_verified_access_group, params) req.send_request() end |
#create_verified_access_instance(params = {}) ⇒ Types::CreateVerifiedAccessInstanceResult
An Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.
13944 13945 13946 13947 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13944 def create_verified_access_instance(params = {}, = {}) req = build_request(:create_verified_access_instance, params) req.send_request() end |
#create_verified_access_trust_provider(params = {}) ⇒ Types::CreateVerifiedAccessTrustProviderResult
A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.
14077 14078 14079 14080 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14077 def create_verified_access_trust_provider(params = {}, = {}) req = build_request(:create_verified_access_trust_provider, params) req.send_request() end |
#create_volume(params = {}) ⇒ Types::Volume
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
For more information, see Create an Amazon EBS volume in the Amazon EBS User Guide.
14400 14401 14402 14403 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14400 def create_volume(params = {}, = {}) req = build_request(:create_volume, params) req.send_request() end |
#create_vpc(params = {}) ⇒ Types::CreateVpcResult
Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the Amazon VPC User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon EC2 User Guide.
14603 14604 14605 14606 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14603 def create_vpc(params = {}, = {}) req = build_request(:create_vpc, params) req.send_request() end |
#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResult
Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.
14773 14774 14775 14776 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14773 def create_vpc_endpoint(params = {}, = {}) req = build_request(:create_vpc_endpoint, params) req.send_request() end |
#create_vpc_endpoint_connection_notification(params = {}) ⇒ Types::CreateVpcEndpointConnectionNotificationResult
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide.
You can create a connection notification for interface endpoints only.
14850 14851 14852 14853 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14850 def create_vpc_endpoint_connection_notification(params = {}, = {}) req = build_request(:create_vpc_endpoint_connection_notification, params) req.send_request() end |
#create_vpc_endpoint_service_configuration(params = {}) ⇒ Types::CreateVpcEndpointServiceConfigurationResult
Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.
Before you create an endpoint service, you must create one of the following for your service:
A Network Load Balancer. Service consumers connect to your service using an interface endpoint.
A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.
If you set the private DNS name, you must prove that you own the private DNS domain name.
For more information, see the Amazon Web Services PrivateLink Guide.
14977 14978 14979 14980 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14977 def create_vpc_endpoint_service_configuration(params = {}, = {}) req = build_request(:create_vpc_endpoint_service_configuration, params) req.send_request() end |
#create_vpc_peering_connection(params = {}) ⇒ Types::CreateVpcPeeringConnectionResult
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with
overlapping CIDR blocks, the VPC peering connection has a status of
failed
.
15095 15096 15097 15098 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15095 def create_vpc_peering_connection(params = {}, = {}) req = build_request(:create_vpc_peering_connection, params) req.send_request() end |
#create_vpn_connection(params = {}) ⇒ Types::CreateVpnConnectionResult
Creates a VPN connection between an existing virtual private gateway
or transit gateway and a customer gateway. The supported connection
type is ipsec.1
.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
15317 15318 15319 15320 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15317 def create_vpn_connection(params = {}, = {}) req = build_request(:create_vpn_connection, params) req.send_request() end |
#create_vpn_connection_route(params = {}) ⇒ Struct
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
15354 15355 15356 15357 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15354 def create_vpn_connection_route(params = {}, = {}) req = build_request(:create_vpn_connection_route, params) req.send_request() end |
#create_vpn_gateway(params = {}) ⇒ Types::CreateVpnGatewayResult
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
15435 15436 15437 15438 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15435 def create_vpn_gateway(params = {}, = {}) req = build_request(:create_vpn_gateway, params) req.send_request() end |
#delete_carrier_gateway(params = {}) ⇒ Types::DeleteCarrierGatewayResult
Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
15484 15485 15486 15487 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15484 def delete_carrier_gateway(params = {}, = {}) req = build_request(:delete_carrier_gateway, params) req.send_request() end |
#delete_client_vpn_endpoint(params = {}) ⇒ Types::DeleteClientVpnEndpointResult
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
15521 15522 15523 15524 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15521 def delete_client_vpn_endpoint(params = {}, = {}) req = build_request(:delete_client_vpn_endpoint, params) req.send_request() end |
#delete_client_vpn_route(params = {}) ⇒ Types::DeleteClientVpnRouteResult
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
15570 15571 15572 15573 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15570 def delete_client_vpn_route(params = {}, = {}) req = build_request(:delete_client_vpn_route, params) req.send_request() end |
#delete_coip_cidr(params = {}) ⇒ Types::DeleteCoipCidrResult
Deletes a range of customer-owned IP addresses.
15611 15612 15613 15614 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15611 def delete_coip_cidr(params = {}, = {}) req = build_request(:delete_coip_cidr, params) req.send_request() end |
#delete_coip_pool(params = {}) ⇒ Types::DeleteCoipPoolResult
Deletes a pool of customer-owned IP (CoIP) addresses.
15653 15654 15655 15656 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15653 def delete_coip_pool(params = {}, = {}) req = build_request(:delete_coip_pool, params) req.send_request() end |
#delete_customer_gateway(params = {}) ⇒ Struct
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
15692 15693 15694 15695 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15692 def delete_customer_gateway(params = {}, = {}) req = build_request(:delete_customer_gateway, params) req.send_request() end |
#delete_dhcp_options(params = {}) ⇒ Struct
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
15733 15734 15735 15736 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15733 def (params = {}, = {}) req = build_request(:delete_dhcp_options, params) req.send_request() end |
#delete_egress_only_internet_gateway(params = {}) ⇒ Types::DeleteEgressOnlyInternetGatewayResult
Deletes an egress-only internet gateway.
15768 15769 15770 15771 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15768 def delete_egress_only_internet_gateway(params = {}, = {}) req = build_request(:delete_egress_only_internet_gateway, params) req.send_request() end |
#delete_fleets(params = {}) ⇒ Types::DeleteFleetsResult
Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its
instances. If you choose to terminate the instances, the EC2 Fleet
enters the deleted_terminating
state. Otherwise, the EC2 Fleet
enters the deleted_running
state, and the instances continue to run
until they are interrupted or you terminate them manually.
For instant
fleets, EC2 Fleet must terminate the instances when the
fleet is deleted. Up to 1000 instances can be terminated in a single
request to delete instant
fleets. A deleted instant
fleet with
running instances is not supported.
Restrictions
You can delete up to 25 fleets of type
instant
in a single request.You can delete up to 100 fleets of type
maintain
orrequest
in a single request.You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
15860 15861 15862 15863 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15860 def delete_fleets(params = {}, = {}) req = build_request(:delete_fleets, params) req.send_request() end |
#delete_flow_logs(params = {}) ⇒ Types::DeleteFlowLogsResult
Deletes one or more flow logs.
15900 15901 15902 15903 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15900 def delete_flow_logs(params = {}, = {}) req = build_request(:delete_flow_logs, params) req.send_request() end |
#delete_fpga_image(params = {}) ⇒ Types::DeleteFpgaImageResult
Deletes the specified Amazon FPGA Image (AFI).
15935 15936 15937 15938 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15935 def delete_fpga_image(params = {}, = {}) req = build_request(:delete_fpga_image, params) req.send_request() end |
#delete_instance_connect_endpoint(params = {}) ⇒ Types::DeleteInstanceConnectEndpointResult
Deletes the specified EC2 Instance Connect Endpoint.
15988 15989 15990 15991 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15988 def delete_instance_connect_endpoint(params = {}, = {}) req = build_request(:delete_instance_connect_endpoint, params) req.send_request() end |
#delete_instance_event_window(params = {}) ⇒ Types::DeleteInstanceEventWindowResult
Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
16036 16037 16038 16039 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16036 def delete_instance_event_window(params = {}, = {}) req = build_request(:delete_instance_event_window, params) req.send_request() end |
#delete_internet_gateway(params = {}) ⇒ Struct
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
16075 16076 16077 16078 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16075 def delete_internet_gateway(params = {}, = {}) req = build_request(:delete_internet_gateway, params) req.send_request() end |
#delete_ipam(params = {}) ⇒ Types::DeleteIpamResult
Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.
For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.
16161 16162 16163 16164 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16161 def delete_ipam(params = {}, = {}) req = build_request(:delete_ipam, params) req.send_request() end |
#delete_ipam_pool(params = {}) ⇒ Types::DeleteIpamPoolResult
Delete an IPAM pool.
For more information, see Delete a pool in the Amazon VPC IPAM User Guide.
16251 16252 16253 16254 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16251 def delete_ipam_pool(params = {}, = {}) req = build_request(:delete_ipam_pool, params) req.send_request() end |
#delete_ipam_resource_discovery(params = {}) ⇒ Types::DeleteIpamResourceDiscoveryResult
Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
16299 16300 16301 16302 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16299 def delete_ipam_resource_discovery(params = {}, = {}) req = build_request(:delete_ipam_resource_discovery, params) req.send_request() end |
#delete_ipam_scope(params = {}) ⇒ Types::DeleteIpamScopeResult
Delete the scope for an IPAM. You cannot delete the default scopes.
For more information, see Delete a scope in the Amazon VPC IPAM User Guide.
16353 16354 16355 16356 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16353 def delete_ipam_scope(params = {}, = {}) req = build_request(:delete_ipam_scope, params) req.send_request() end |
#delete_key_pair(params = {}) ⇒ Types::DeleteKeyPairResult
Deletes the specified key pair, by removing the public key from Amazon EC2.
16404 16405 16406 16407 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16404 def delete_key_pair(params = {}, = {}) req = build_request(:delete_key_pair, params) req.send_request() end |
#delete_launch_template(params = {}) ⇒ Types::DeleteLaunchTemplateResult
Deletes a launch template. Deleting a launch template deletes all of its versions.
16479 16480 16481 16482 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16479 def delete_launch_template(params = {}, = {}) req = build_request(:delete_launch_template, params) req.send_request() end |
#delete_launch_template_versions(params = {}) ⇒ Types::DeleteLaunchTemplateVersionsResult
Deletes one or more versions of a launch template.
You can't delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the launch template and all of its versions.
For more information, see Delete a launch template version in the Amazon EC2 User Guide.
16581 16582 16583 16584 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16581 def delete_launch_template_versions(params = {}, = {}) req = build_request(:delete_launch_template_versions, params) req.send_request() end |
#delete_local_gateway_route(params = {}) ⇒ Types::DeleteLocalGatewayRouteResult
Deletes the specified route from the specified local gateway route table.
16638 16639 16640 16641 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16638 def delete_local_gateway_route(params = {}, = {}) req = build_request(:delete_local_gateway_route, params) req.send_request() end |
#delete_local_gateway_route_table(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableResult
Deletes a local gateway route table.
16684 16685 16686 16687 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16684 def delete_local_gateway_route_table(params = {}, = {}) req = build_request(:delete_local_gateway_route_table, params) req.send_request() end |
#delete_local_gateway_route_table_virtual_interface_group_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult
Deletes a local gateway route table virtual interface group association.
16730 16731 16732 16733 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16730 def delete_local_gateway_route_table_virtual_interface_group_association(params = {}, = {}) req = build_request(:delete_local_gateway_route_table_virtual_interface_group_association, params) req.send_request() end |
#delete_local_gateway_route_table_vpc_association(params = {}) ⇒ Types::DeleteLocalGatewayRouteTableVpcAssociationResult
Deletes the specified association between a VPC and local gateway route table.
16775 16776 16777 16778 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16775 def delete_local_gateway_route_table_vpc_association(params = {}, = {}) req = build_request(:delete_local_gateway_route_table_vpc_association, params) req.send_request() end |
#delete_managed_prefix_list(params = {}) ⇒ Types::DeleteManagedPrefixListResult
Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
16822 16823 16824 16825 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16822 def delete_managed_prefix_list(params = {}, = {}) req = build_request(:delete_managed_prefix_list, params) req.send_request() end |
#delete_nat_gateway(params = {}) ⇒ Types::DeleteNatGatewayResult
Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
16874 16875 16876 16877 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16874 def delete_nat_gateway(params = {}, = {}) req = build_request(:delete_nat_gateway, params) req.send_request() end |
#delete_network_acl(params = {}) ⇒ Struct
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
16914 16915 16916 16917 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16914 def delete_network_acl(params = {}, = {}) req = build_request(:delete_network_acl, params) req.send_request() end |
#delete_network_acl_entry(params = {}) ⇒ Struct
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
16963 16964 16965 16966 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16963 def delete_network_acl_entry(params = {}, = {}) req = build_request(:delete_network_acl_entry, params) req.send_request() end |
#delete_network_insights_access_scope(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeResult
Deletes the specified Network Access Scope.
16998 16999 17000 17001 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16998 def delete_network_insights_access_scope(params = {}, = {}) req = build_request(:delete_network_insights_access_scope, params) req.send_request() end |
#delete_network_insights_access_scope_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAccessScopeAnalysisResult
Deletes the specified Network Access Scope analysis.
17033 17034 17035 17036 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17033 def delete_network_insights_access_scope_analysis(params = {}, = {}) req = build_request(:delete_network_insights_access_scope_analysis, params) req.send_request() end |
#delete_network_insights_analysis(params = {}) ⇒ Types::DeleteNetworkInsightsAnalysisResult
Deletes the specified network insights analysis.
17068 17069 17070 17071 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17068 def delete_network_insights_analysis(params = {}, = {}) req = build_request(:delete_network_insights_analysis, params) req.send_request() end |
#delete_network_insights_path(params = {}) ⇒ Types::DeleteNetworkInsightsPathResult
Deletes the specified path.
17103 17104 17105 17106 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17103 def delete_network_insights_path(params = {}, = {}) req = build_request(:delete_network_insights_path, params) req.send_request() end |
#delete_network_interface(params = {}) ⇒ Struct
Deletes the specified network interface. You must detach the network interface before you can delete it.
17142 17143 17144 17145 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17142 def delete_network_interface(params = {}, = {}) req = build_request(:delete_network_interface, params) req.send_request() end |
#delete_network_interface_permission(params = {}) ⇒ Types::DeleteNetworkInterfacePermissionResult
Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
17185 17186 17187 17188 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17185 def (params = {}, = {}) req = build_request(:delete_network_interface_permission, params) req.send_request() end |
#delete_placement_group(params = {}) ⇒ Struct
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.
17234 17235 17236 17237 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17234 def delete_placement_group(params = {}, = {}) req = build_request(:delete_placement_group, params) req.send_request() end |
#delete_public_ipv_4_pool(params = {}) ⇒ Types::DeletePublicIpv4PoolResult
Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.
17272 17273 17274 17275 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17272 def delete_public_ipv_4_pool(params = {}, = {}) req = build_request(:delete_public_ipv_4_pool, params) req.send_request() end |
#delete_queued_reserved_instances(params = {}) ⇒ Types::DeleteQueuedReservedInstancesResult
Deletes the queued purchases for the specified Reserved Instances.
17313 17314 17315 17316 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17313 def delete_queued_reserved_instances(params = {}, = {}) req = build_request(:delete_queued_reserved_instances, params) req.send_request() end |
#delete_route(params = {}) ⇒ Struct
Deletes the specified route from the specified route table.
17366 17367 17368 17369 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17366 def delete_route(params = {}, = {}) req = build_request(:delete_route, params) req.send_request() end |
#delete_route_table(params = {}) ⇒ Struct
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
17406 17407 17408 17409 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17406 def delete_route_table(params = {}, = {}) req = build_request(:delete_route_table, params) req.send_request() end |
#delete_security_group(params = {}) ⇒ Struct
Deletes a security group.
If you attempt to delete a security group that is associated with an
instance or network interface or is referenced by another security
group, the operation fails with DependencyViolation
.
17458 17459 17460 17461 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17458 def delete_security_group(params = {}, = {}) req = build_request(:delete_security_group, params) req.send_request() end |
#delete_snapshot(params = {}) ⇒ Struct
Deletes the specified snapshot.
When you make periodic snapshots of a volume, 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 volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.
17520 17521 17522 17523 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17520 def delete_snapshot(params = {}, = {}) req = build_request(:delete_snapshot, params) req.send_request() end |
#delete_spot_datafeed_subscription(params = {}) ⇒ Struct
Deletes the data feed for Spot Instances.
17553 17554 17555 17556 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17553 def delete_spot_datafeed_subscription(params = {}, = {}) req = build_request(:delete_spot_datafeed_subscription, params) req.send_request() end |
#delete_subnet(params = {}) ⇒ Struct
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
17592 17593 17594 17595 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17592 def delete_subnet(params = {}, = {}) req = build_request(:delete_subnet, params) req.send_request() end |
#delete_subnet_cidr_reservation(params = {}) ⇒ Types::DeleteSubnetCidrReservationResult
Deletes a subnet CIDR reservation.
17635 17636 17637 17638 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17635 def delete_subnet_cidr_reservation(params = {}, = {}) req = build_request(:delete_subnet_cidr_reservation, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
17711 17712 17713 17714 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17711 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_traffic_mirror_filter(params = {}) ⇒ Types::DeleteTrafficMirrorFilterResult
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
17749 17750 17751 17752 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17749 def delete_traffic_mirror_filter(params = {}, = {}) req = build_request(:delete_traffic_mirror_filter, params) req.send_request() end |
#delete_traffic_mirror_filter_rule(params = {}) ⇒ Types::DeleteTrafficMirrorFilterRuleResult
Deletes the specified Traffic Mirror rule.
17784 17785 17786 17787 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17784 def delete_traffic_mirror_filter_rule(params = {}, = {}) req = build_request(:delete_traffic_mirror_filter_rule, params) req.send_request() end |
#delete_traffic_mirror_session(params = {}) ⇒ Types::DeleteTrafficMirrorSessionResult
Deletes the specified Traffic Mirror session.
17819 17820 17821 17822 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17819 def delete_traffic_mirror_session(params = {}, = {}) req = build_request(:delete_traffic_mirror_session, params) req.send_request() end |
#delete_traffic_mirror_target(params = {}) ⇒ Types::DeleteTrafficMirrorTargetResult
Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
17857 17858 17859 17860 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17857 def delete_traffic_mirror_target(params = {}, = {}) req = build_request(:delete_traffic_mirror_target, params) req.send_request() end |
#delete_transit_gateway(params = {}) ⇒ Types::DeleteTransitGatewayResult
Deletes the specified transit gateway.
17912 17913 17914 17915 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17912 def delete_transit_gateway(params = {}, = {}) req = build_request(:delete_transit_gateway, params) req.send_request() end |
#delete_transit_gateway_connect(params = {}) ⇒ Types::DeleteTransitGatewayConnectResult
Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
17956 17957 17958 17959 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17956 def delete_transit_gateway_connect(params = {}, = {}) req = build_request(:delete_transit_gateway_connect, params) req.send_request() end |
#delete_transit_gateway_connect_peer(params = {}) ⇒ Types::DeleteTransitGatewayConnectPeerResult
Deletes the specified Connect peer.
18008 18009 18010 18011 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18008 def delete_transit_gateway_connect_peer(params = {}, = {}) req = build_request(:delete_transit_gateway_connect_peer, params) req.send_request() end |
#delete_transit_gateway_multicast_domain(params = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult
Deletes the specified transit gateway multicast domain.
18054 18055 18056 18057 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18054 def delete_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:delete_transit_gateway_multicast_domain, params) req.send_request() end |
#delete_transit_gateway_peering_attachment(params = {}) ⇒ Types::DeleteTransitGatewayPeeringAttachmentResult
Deletes a transit gateway peering attachment.
18106 18107 18108 18109 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18106 def (params = {}, = {}) req = build_request(:delete_transit_gateway_peering_attachment, params) req.send_request() end |
#delete_transit_gateway_policy_table(params = {}) ⇒ Types::DeleteTransitGatewayPolicyTableResult
Deletes the specified transit gateway policy table.
18147 18148 18149 18150 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18147 def delete_transit_gateway_policy_table(params = {}, = {}) req = build_request(:delete_transit_gateway_policy_table, params) req.send_request() end |
#delete_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::DeleteTransitGatewayPrefixListReferenceResult
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
18194 18195 18196 18197 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18194 def delete_transit_gateway_prefix_list_reference(params = {}, = {}) req = build_request(:delete_transit_gateway_prefix_list_reference, params) req.send_request() end |
#delete_transit_gateway_route(params = {}) ⇒ Types::DeleteTransitGatewayRouteResult
Deletes the specified route from the specified transit gateway route table.
18243 18244 18245 18246 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18243 def delete_transit_gateway_route(params = {}, = {}) req = build_request(:delete_transit_gateway_route, params) req.send_request() end |
#delete_transit_gateway_route_table(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableResult
Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.
18290 18291 18292 18293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18290 def delete_transit_gateway_route_table(params = {}, = {}) req = build_request(:delete_transit_gateway_route_table, params) req.send_request() end |
#delete_transit_gateway_route_table_announcement(params = {}) ⇒ Types::DeleteTransitGatewayRouteTableAnnouncementResult
Advertises to the transit gateway that a transit gateway route table is deleted.
18338 18339 18340 18341 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18338 def delete_transit_gateway_route_table_announcement(params = {}, = {}) req = build_request(:delete_transit_gateway_route_table_announcement, params) req.send_request() end |
#delete_transit_gateway_vpc_attachment(params = {}) ⇒ Types::DeleteTransitGatewayVpcAttachmentResult
Deletes the specified VPC attachment.
18387 18388 18389 18390 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18387 def (params = {}, = {}) req = build_request(:delete_transit_gateway_vpc_attachment, params) req.send_request() end |
#delete_verified_access_endpoint(params = {}) ⇒ Types::DeleteVerifiedAccessEndpointResult
Delete an Amazon Web Services Verified Access endpoint.
18464 18465 18466 18467 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18464 def delete_verified_access_endpoint(params = {}, = {}) req = build_request(:delete_verified_access_endpoint, params) req.send_request() end |
#delete_verified_access_group(params = {}) ⇒ Types::DeleteVerifiedAccessGroupResult
Delete an Amazon Web Services Verified Access group.
18524 18525 18526 18527 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18524 def delete_verified_access_group(params = {}, = {}) req = build_request(:delete_verified_access_group, params) req.send_request() end |
#delete_verified_access_instance(params = {}) ⇒ Types::DeleteVerifiedAccessInstanceResult
Delete an Amazon Web Services Verified Access instance.
18585 18586 18587 18588 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18585 def delete_verified_access_instance(params = {}, = {}) req = build_request(:delete_verified_access_instance, params) req.send_request() end |
#delete_verified_access_trust_provider(params = {}) ⇒ Types::DeleteVerifiedAccessTrustProviderResult
Delete an Amazon Web Services Verified Access trust provider.
18654 18655 18656 18657 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18654 def delete_verified_access_trust_provider(params = {}, = {}) req = build_request(:delete_verified_access_trust_provider, params) req.send_request() end |
#delete_volume(params = {}) ⇒ Struct
Deletes the specified EBS volume. The volume must be in the
available
state (not attached to an instance).
The volume can remain in the deleting
state for several minutes.
For more information, see Delete an Amazon EBS volume in the Amazon EBS User Guide.
18707 18708 18709 18710 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18707 def delete_volume(params = {}, = {}) req = build_request(:delete_volume, params) req.send_request() end |
#delete_vpc(params = {}) ⇒ Struct
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.
18751 18752 18753 18754 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18751 def delete_vpc(params = {}, = {}) req = build_request(:delete_vpc, params) req.send_request() end |
#delete_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DeleteVpcEndpointConnectionNotificationsResult
Deletes the specified VPC endpoint connection notifications.
18789 18790 18791 18792 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18789 def delete_vpc_endpoint_connection_notifications(params = {}, = {}) req = build_request(:delete_vpc_endpoint_connection_notifications, params) req.send_request() end |
#delete_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DeleteVpcEndpointServiceConfigurationsResult
Deletes the specified VPC endpoint service configurations. Before you
can delete an endpoint service configuration, you must reject any
Available
or PendingAcceptance
interface endpoint connections that
are attached to the service.
18830 18831 18832 18833 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18830 def delete_vpc_endpoint_service_configurations(params = {}, = {}) req = build_request(:delete_vpc_endpoint_service_configurations, params) req.send_request() end |
#delete_vpc_endpoints(params = {}) ⇒ Types::DeleteVpcEndpointsResult
Deletes the specified VPC endpoints.
When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint.
When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.
When you delete an interface endpoint, we delete its endpoint network interfaces.
18879 18880 18881 18882 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18879 def delete_vpc_endpoints(params = {}, = {}) req = build_request(:delete_vpc_endpoints, params) req.send_request() end |
#delete_vpc_peering_connection(params = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
Deletes a VPC peering connection. Either the owner of the requester
VPC or the owner of the accepter VPC can delete the VPC peering
connection if it's in the active
state. The owner of the requester
VPC can delete a VPC peering connection in the pending-acceptance
state. You cannot delete a VPC peering connection that's in the
failed
or rejected
state.
18919 18920 18921 18922 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18919 def delete_vpc_peering_connection(params = {}, = {}) req = build_request(:delete_vpc_peering_connection, params) req.send_request() end |
#delete_vpn_connection(params = {}) ⇒ Struct
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.
18963 18964 18965 18966 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18963 def delete_vpn_connection(params = {}, = {}) req = build_request(:delete_vpn_connection, params) req.send_request() end |
#delete_vpn_connection_route(params = {}) ⇒ Struct
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
18993 18994 18995 18996 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18993 def delete_vpn_connection_route(params = {}, = {}) req = build_request(:delete_vpn_connection_route, params) req.send_request() end |
#delete_vpn_gateway(params = {}) ⇒ Struct
Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
19025 19026 19027 19028 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19025 def delete_vpn_gateway(params = {}, = {}) req = build_request(:delete_vpn_gateway, params) req.send_request() end |
#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResult
Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
19076 19077 19078 19079 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19076 def deprovision_byoip_cidr(params = {}, = {}) req = build_request(:deprovision_byoip_cidr, params) req.send_request() end |
#deprovision_ipam_byoasn(params = {}) ⇒ Types::DeprovisionIpamByoasnResult
Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
19127 19128 19129 19130 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19127 def deprovision_ipam_byoasn(params = {}, = {}) req = build_request(:deprovision_ipam_byoasn, params) req.send_request() end |
#deprovision_ipam_pool_cidr(params = {}) ⇒ Types::DeprovisionIpamPoolCidrResult
Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
19178 19179 19180 19181 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19178 def deprovision_ipam_pool_cidr(params = {}, = {}) req = build_request(:deprovision_ipam_pool_cidr, params) req.send_request() end |
#deprovision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::DeprovisionPublicIpv4PoolCidrResult
Deprovision a CIDR from a public IPv4 pool.
19224 19225 19226 19227 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19224 def deprovision_public_ipv_4_pool_cidr(params = {}, = {}) req = build_request(:deprovision_public_ipv_4_pool_cidr, params) req.send_request() end |
#deregister_image(params = {}) ⇒ Struct
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.
When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
19273 19274 19275 19276 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19273 def deregister_image(params = {}, = {}) req = build_request(:deregister_image, params) req.send_request() end |
#deregister_instance_event_notification_attributes(params = {}) ⇒ Types::DeregisterInstanceEventNotificationAttributesResult
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
19315 19316 19317 19318 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19315 def deregister_instance_event_notification_attributes(params = {}, = {}) req = build_request(:deregister_instance_event_notification_attributes, params) req.send_request() end |
#deregister_transit_gateway_multicast_group_members(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupMembersResult
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
19362 19363 19364 19365 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19362 def deregister_transit_gateway_multicast_group_members(params = {}, = {}) req = build_request(:deregister_transit_gateway_multicast_group_members, params) req.send_request() end |
#deregister_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupSourcesResult
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
19409 19410 19411 19412 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19409 def deregister_transit_gateway_multicast_group_sources(params = {}, = {}) req = build_request(:deregister_transit_gateway_multicast_group_sources, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
default-vpc
: The ID of the default VPC for your account, ornone
.max-instances
: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.max-elastic-ips
: The maximum number of Elastic IP addresses that you can allocate.supported-platforms
: This attribute is deprecated.vpc-max-elastic-ips
: The maximum number of Elastic IP addresses that you can allocate.vpc-max-security-groups-per-interface
: The maximum number of security groups that you can assign to a network interface.
19569 19570 19571 19572 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19569 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_address_transfers(params = {}) ⇒ Types::DescribeAddressTransfersResult
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for three days after the transfers have been accepted.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19639 19640 19641 19642 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19639 def describe_address_transfers(params = {}, = {}) req = build_request(:describe_address_transfers, params) req.send_request() end |
#describe_addresses(params = {}) ⇒ Types::DescribeAddressesResult
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
19767 19768 19769 19770 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19767 def describe_addresses(params = {}, = {}) req = build_request(:describe_addresses, params) req.send_request() end |
#describe_addresses_attribute(params = {}) ⇒ Types::DescribeAddressesAttributeResult
Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19831 19832 19833 19834 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19831 def describe_addresses_attribute(params = {}, = {}) req = build_request(:describe_addresses_attribute, params) req.send_request() end |
#describe_aggregate_id_format(params = {}) ⇒ Types::DescribeAggregateIdFormatResult
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle
|
conversion-task
| customer-gateway
| dhcp-options
|
elastic-ip-allocation
| elastic-ip-association
| export-task
| flow-log
| image
| import-task
| instance
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
| route-table-association
|
security-group
| snapshot
| subnet
|
subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
19885 19886 19887 19888 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19885 def describe_aggregate_id_format(params = {}, = {}) req = build_request(:describe_aggregate_id_format, params) req.send_request() end |
#describe_availability_zones(params = {}) ⇒ Types::DescribeAvailabilityZonesResult
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon EC2 User Guide.
20050 20051 20052 20053 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20050 def describe_availability_zones(params = {}, = {}) req = build_request(:describe_availability_zones, params) req.send_request() end |
#describe_aws_network_performance_metric_subscriptions(params = {}) ⇒ Types::DescribeAwsNetworkPerformanceMetricSubscriptionsResult
Describes the current Infrastructure Performance metric subscriptions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20109 20110 20111 20112 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20109 def describe_aws_network_performance_metric_subscriptions(params = {}, = {}) req = build_request(:describe_aws_network_performance_metric_subscriptions, params) req.send_request() end |
#describe_bundle_tasks(params = {}) ⇒ Types::DescribeBundleTasksResult
Describes the specified bundle tasks or all of your bundle tasks.
RegisterImage
with the Amazon S3 bucket name and
image manifest name you provided to the bundle task.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- bundle_task_complete
20210 20211 20212 20213 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20210 def describe_bundle_tasks(params = {}, = {}) req = build_request(:describe_bundle_tasks, params) req.send_request() end |
#describe_byoip_cidrs(params = {}) ⇒ Types::DescribeByoipCidrsResult
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20269 20270 20271 20272 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20269 def describe_byoip_cidrs(params = {}, = {}) req = build_request(:describe_byoip_cidrs, params) req.send_request() end |
#describe_capacity_block_offerings(params = {}) ⇒ Types::DescribeCapacityBlockOfferingsResult
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20351 20352 20353 20354 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20351 def describe_capacity_block_offerings(params = {}, = {}) req = build_request(:describe_capacity_block_offerings, params) req.send_request() end |
#describe_capacity_reservation_fleets(params = {}) ⇒ Types::DescribeCapacityReservationFleetsResult
Describes one or more Capacity Reservation Fleets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20450 20451 20452 20453 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20450 def describe_capacity_reservation_fleets(params = {}, = {}) req = build_request(:describe_capacity_reservation_fleets, params) req.send_request() end |
#describe_capacity_reservations(params = {}) ⇒ Types::DescribeCapacityReservationsResult
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20625 20626 20627 20628 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20625 def describe_capacity_reservations(params = {}, = {}) req = build_request(:describe_capacity_reservations, params) req.send_request() end |
#describe_carrier_gateways(params = {}) ⇒ Types::DescribeCarrierGatewaysResult
Describes one or more of your carrier gateways.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20710 20711 20712 20713 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20710 def describe_carrier_gateways(params = {}, = {}) req = build_request(:describe_carrier_gateways, params) req.send_request() end |
#describe_classic_link_instances(params = {}) ⇒ Types::DescribeClassicLinkInstancesResult
Describes your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20809 20810 20811 20812 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20809 def describe_classic_link_instances(params = {}, = {}) req = build_request(:describe_classic_link_instances, params) req.send_request() end |
#describe_client_vpn_authorization_rules(params = {}) ⇒ Types::DescribeClientVpnAuthorizationRulesResult
Describes the authorization rules for a specified Client VPN endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20882 20883 20884 20885 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20882 def (params = {}, = {}) req = build_request(:describe_client_vpn_authorization_rules, params) req.send_request() end |
#describe_client_vpn_connections(params = {}) ⇒ Types::DescribeClientVpnConnectionsResult
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20963 20964 20965 20966 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20963 def describe_client_vpn_connections(params = {}, = {}) req = build_request(:describe_client_vpn_connections, params) req.send_request() end |
#describe_client_vpn_endpoints(params = {}) ⇒ Types::DescribeClientVpnEndpointsResult
Describes one or more Client VPN endpoints in the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21066 21067 21068 21069 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21066 def describe_client_vpn_endpoints(params = {}, = {}) req = build_request(:describe_client_vpn_endpoints, params) req.send_request() end |
#describe_client_vpn_routes(params = {}) ⇒ Types::DescribeClientVpnRoutesResult
Describes the routes for the specified Client VPN endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21140 21141 21142 21143 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21140 def describe_client_vpn_routes(params = {}, = {}) req = build_request(:describe_client_vpn_routes, params) req.send_request() end |
#describe_client_vpn_target_networks(params = {}) ⇒ Types::DescribeClientVpnTargetNetworksResult
Describes the target networks associated with the specified Client VPN endpoint.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21218 21219 21220 21221 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21218 def describe_client_vpn_target_networks(params = {}, = {}) req = build_request(:describe_client_vpn_target_networks, params) req.send_request() end |
#describe_coip_pools(params = {}) ⇒ Types::DescribeCoipPoolsResult
Describes the specified customer-owned address pools or all of your customer-owned address pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21290 21291 21292 21293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21290 def describe_coip_pools(params = {}, = {}) req = build_request(:describe_coip_pools, params) req.send_request() end |
#describe_conversion_tasks(params = {}) ⇒ Types::DescribeConversionTasksResult
Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- conversion_task_cancelled
- conversion_task_completed
- conversion_task_deleted
21372 21373 21374 21375 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21372 def describe_conversion_tasks(params = {}, = {}) req = build_request(:describe_conversion_tasks, params) req.send_request() end |
#describe_customer_gateways(params = {}) ⇒ Types::DescribeCustomerGatewaysResult
Describes one or more of your VPN customer gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- customer_gateway_available
21489 21490 21491 21492 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21489 def describe_customer_gateways(params = {}, = {}) req = build_request(:describe_customer_gateways, params) req.send_request() end |
#describe_dhcp_options(params = {}) ⇒ Types::DescribeDhcpOptionsResult
Describes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria.
For more information, see DHCP option sets in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21623 21624 21625 21626 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21623 def (params = {}, = {}) req = build_request(:describe_dhcp_options, params) req.send_request() end |
#describe_egress_only_internet_gateways(params = {}) ⇒ Types::DescribeEgressOnlyInternetGatewaysResult
Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21707 21708 21709 21710 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21707 def describe_egress_only_internet_gateways(params = {}, = {}) req = build_request(:describe_egress_only_internet_gateways, params) req.send_request() end |
#describe_elastic_gpus(params = {}) ⇒ Types::DescribeElasticGpusResult
Describes the Elastic Graphics accelerator associated with your instances.
21796 21797 21798 21799 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21796 def describe_elastic_gpus(params = {}, = {}) req = build_request(:describe_elastic_gpus, params) req.send_request() end |
#describe_export_image_tasks(params = {}) ⇒ Types::DescribeExportImageTasksResult
Describes the specified export image tasks or all of your export image tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21865 21866 21867 21868 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21865 def describe_export_image_tasks(params = {}, = {}) req = build_request(:describe_export_image_tasks, params) req.send_request() end |
#describe_export_tasks(params = {}) ⇒ Types::DescribeExportTasksResult
Describes the specified export instance tasks or all of your export instance tasks.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- export_task_cancelled
- export_task_completed
21922 21923 21924 21925 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21922 def describe_export_tasks(params = {}, = {}) req = build_request(:describe_export_tasks, params) req.send_request() end |
#describe_fast_launch_images(params = {}) ⇒ Types::DescribeFastLaunchImagesResult
Describe details for Windows AMIs that are configured for Windows fast launch.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22003 22004 22005 22006 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22003 def describe_fast_launch_images(params = {}, = {}) req = build_request(:describe_fast_launch_images, params) req.send_request() end |
#describe_fast_snapshot_restores(params = {}) ⇒ Types::DescribeFastSnapshotRestoresResult
Describes the state of fast snapshot restores for your snapshots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22084 22085 22086 22087 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22084 def describe_fast_snapshot_restores(params = {}, = {}) req = build_request(:describe_fast_snapshot_restores, params) req.send_request() end |
#describe_fleet_history(params = {}) ⇒ Types::DescribeFleetHistoryResult
Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
22169 22170 22171 22172 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22169 def describe_fleet_history(params = {}, = {}) req = build_request(:describe_fleet_history, params) req.send_request() end |
#describe_fleet_instances(params = {}) ⇒ Types::DescribeFleetInstancesResult
Describes the running instances for the specified EC2 Fleet.
DescribeFleetInstances
does not support fleets of type
instant
. Instead, use DescribeFleets
, specifying the instant
fleet ID in the request.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
22253 22254 22255 22256 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22253 def describe_fleet_instances(params = {}, = {}) req = build_request(:describe_fleet_instances, params) req.send_request() end |
#describe_fleets(params = {}) ⇒ Types::DescribeFleetsResult
Describes the specified EC2 Fleet or all of your EC2 Fleets.
If a fleet is of type instant
, you must specify the fleet ID in the
request, otherwise the fleet does not appear in the response.
For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22552 22553 22554 22555 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22552 def describe_fleets(params = {}, = {}) req = build_request(:describe_fleets, params) req.send_request() end |
#describe_flow_logs(params = {}) ⇒ Types::DescribeFlowLogsResult
Describes one or more flow logs.
To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22666 22667 22668 22669 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22666 def describe_flow_logs(params = {}, = {}) req = build_request(:describe_flow_logs, params) req.send_request() end |
#describe_fpga_image_attribute(params = {}) ⇒ Types::DescribeFpgaImageAttributeResult
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
22714 22715 22716 22717 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22714 def describe_fpga_image_attribute(params = {}, = {}) req = build_request(:describe_fpga_image_attribute, params) req.send_request() end |
#describe_fpga_images(params = {}) ⇒ Types::DescribeFpgaImagesResult
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22834 22835 22836 22837 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22834 def describe_fpga_images(params = {}, = {}) req = build_request(:describe_fpga_images, params) req.send_request() end |
#describe_host_reservation_offerings(params = {}) ⇒ Types::DescribeHostReservationOfferingsResult
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
22929 22930 22931 22932 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22929 def describe_host_reservation_offerings(params = {}, = {}) req = build_request(:describe_host_reservation_offerings, params) req.send_request() end |
#describe_host_reservations(params = {}) ⇒ Types::DescribeHostReservationsResult
Describes reservations that are associated with Dedicated Hosts in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23018 23019 23020 23021 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23018 def describe_host_reservations(params = {}, = {}) req = build_request(:describe_host_reservations, params) req.send_request() end |
#describe_hosts(params = {}) ⇒ Types::DescribeHostsResult
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're
currently using. All listed instances consume capacity on your
Dedicated Host. Dedicated Hosts that have recently been released are
listed with the state released
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23135 23136 23137 23138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23135 def describe_hosts(params = {}, = {}) req = build_request(:describe_hosts, params) req.send_request() end |
#describe_iam_instance_profile_associations(params = {}) ⇒ Types::DescribeIamInstanceProfileAssociationsResult
Describes your IAM instance profile associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23228 23229 23230 23231 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23228 def describe_iam_instance_profile_associations(params = {}, = {}) req = build_request(:describe_iam_instance_profile_associations, params) req.send_request() end |
#describe_id_format(params = {}) ⇒ Types::DescribeIdFormatResult
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle
|
conversion-task
| customer-gateway
| dhcp-options
|
elastic-ip-allocation
| elastic-ip-association
| export-task
| flow-log
| image
| import-task
| instance
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
| route-table-association
|
security-group
| snapshot
| subnet
|
subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
These settings apply to the IAM user who makes the request; they do
not apply to the entire Amazon Web Services account. By default, an
IAM user defaults to the same settings as the root user, unless they
explicitly override the settings by running the ModifyIdFormat
command. Resources created with longer IDs are visible to all IAM
users, regardless of these settings and provided that they have
permission to use the relevant Describe
command for the resource
type.
23293 23294 23295 23296 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23293 def describe_id_format(params = {}, = {}) req = build_request(:describe_id_format, params) req.send_request() end |
#describe_identity_id_format(params = {}) ⇒ Types::DescribeIdentityIdFormatResult
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle
|
conversion-task
| customer-gateway
| dhcp-options
|
elastic-ip-allocation
| elastic-ip-association
| export-task
| flow-log
| image
| import-task
| instance
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
| route-table-association
|
security-group
| snapshot
| subnet
|
subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
23363 23364 23365 23366 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23363 def describe_identity_id_format(params = {}, = {}) req = build_request(:describe_identity_id_format, params) req.send_request() end |
#describe_image_attribute(params = {}) ⇒ Types::ImageAttribute
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
23478 23479 23480 23481 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23478 def describe_image_attribute(params = {}, = {}) req = build_request(:describe_image_attribute, params) req.send_request() end |
#describe_images(params = {}) ⇒ Types::DescribeImagesResult
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- image_available
- image_exists
23809 23810 23811 23812 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23809 def describe_images(params = {}, = {}) req = build_request(:describe_images, params) req.send_request() end |
#describe_import_image_tasks(params = {}) ⇒ Types::DescribeImportImageTasksResult
Displays details about an import virtual machine or import snapshot tasks that are already created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
23898 23899 23900 23901 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23898 def describe_import_image_tasks(params = {}, = {}) req = build_request(:describe_import_image_tasks, params) req.send_request() end |
#describe_import_snapshot_tasks(params = {}) ⇒ Types::DescribeImportSnapshotTasksResult
Describes your import snapshot tasks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- snapshot_imported
23978 23979 23980 23981 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23978 def describe_import_snapshot_tasks(params = {}, = {}) req = build_request(:describe_import_snapshot_tasks, params) req.send_request() end |
#describe_instance_attribute(params = {}) ⇒ Types::InstanceAttribute
Describes the specified attribute of the specified instance. You can
specify only one attribute at a time. Valid attribute values are:
instanceType
| kernel
| ramdisk
| userData
|
disableApiTermination
| instanceInitiatedShutdownBehavior
|
rootDeviceName
| blockDeviceMapping
| productCodes
|
sourceDestCheck
| groupSet
| ebsOptimized
| sriovNetSupport
24136 24137 24138 24139 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24136 def describe_instance_attribute(params = {}, = {}) req = build_request(:describe_instance_attribute, params) req.send_request() end |
#describe_instance_connect_endpoints(params = {}) ⇒ Types::DescribeInstanceConnectEndpointsResult
Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24246 24247 24248 24249 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24246 def describe_instance_connect_endpoints(params = {}, = {}) req = build_request(:describe_instance_connect_endpoints, params) req.send_request() end |
#describe_instance_credit_specifications(params = {}) ⇒ Types::DescribeInstanceCreditSpecificationsResult
Describes the credit option for CPU usage of the specified burstable
performance instances. The credit options are standard
and
unlimited
.
If you do not specify an instance ID, Amazon EC2 returns burstable
performance instances with the unlimited
credit option, as well as
instances that were previously configured as T2, T3, and T3a with the
unlimited
credit option. For example, if you resize a T2 instance,
while it is configured as unlimited
, to an M4 instance, Amazon EC2
returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit
option (standard
or unlimited
) of those instances. If you specify
an instance ID that is not valid, such as an instance that is not a
burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24351 24352 24353 24354 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24351 def describe_instance_credit_specifications(params = {}, = {}) req = build_request(:describe_instance_credit_specifications, params) req.send_request() end |
#describe_instance_event_notification_attributes(params = {}) ⇒ Types::DescribeInstanceEventNotificationAttributesResult
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
24385 24386 24387 24388 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24385 def describe_instance_event_notification_attributes(params = {}, = {}) req = build_request(:describe_instance_event_notification_attributes, params) req.send_request() end |
#describe_instance_event_windows(params = {}) ⇒ Types::DescribeInstanceEventWindowsResult
Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24510 24511 24512 24513 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24510 def describe_instance_event_windows(params = {}, = {}) req = build_request(:describe_instance_event_windows, params) req.send_request() end |
#describe_instance_status(params = {}) ⇒ Types::DescribeInstanceStatusResult
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- instance_status_ok
- system_status_ok
24737 24738 24739 24740 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24737 def describe_instance_status(params = {}, = {}) req = build_request(:describe_instance_status, params) req.send_request() end |
#describe_instance_topology(params = {}) ⇒ Types::DescribeInstanceTopologyResult
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge
|hpc6id.32xlarge
|hpc7a.12xlarge
|hpc7a.24xlarge
|hpc7a.48xlarge
|hpc7a.96xlarge
|hpc7g.4xlarge
|hpc7g.8xlarge
|hpc7g.16xlarge
p3dn.24xlarge
|p4d.24xlarge
|p4de.24xlarge
|p5.48xlarge
trn1.2xlarge
|trn1.32xlarge
|trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24865 24866 24867 24868 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24865 def describe_instance_topology(params = {}, = {}) req = build_request(:describe_instance_topology, params) req.send_request() end |
#describe_instance_type_offerings(params = {}) ⇒ Types::DescribeInstanceTypeOfferingsResult
Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
24957 24958 24959 24960 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24957 def describe_instance_type_offerings(params = {}, = {}) req = build_request(:describe_instance_type_offerings, params) req.send_request() end |
#describe_instance_types(params = {}) ⇒ Types::DescribeInstanceTypesResult
Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
25283 25284 25285 25286 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25283 def describe_instance_types(params = {}, = {}) req = build_request(:describe_instance_types, params) req.send_request() end |
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- instance_exists
- instance_running
- instance_stopped
- instance_terminated
26033 26034 26035 26036 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26033 def describe_instances(params = {}, = {}) req = build_request(:describe_instances, params) req.send_request() end |
#describe_internet_gateways(params = {}) ⇒ Types::DescribeInternetGatewaysResult
Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- internet_gateway_exists
26168 26169 26170 26171 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26168 def describe_internet_gateways(params = {}, = {}) req = build_request(:describe_internet_gateways, params) req.send_request() end |
#describe_ipam_byoasn(params = {}) ⇒ Types::DescribeIpamByoasnResult
Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
26222 26223 26224 26225 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26222 def describe_ipam_byoasn(params = {}, = {}) req = build_request(:describe_ipam_byoasn, params) req.send_request() end |
#describe_ipam_pools(params = {}) ⇒ Types::DescribeIpamPoolsResult
Get information about your IPAM pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26314 26315 26316 26317 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26314 def describe_ipam_pools(params = {}, = {}) req = build_request(:describe_ipam_pools, params) req.send_request() end |
#describe_ipam_resource_discoveries(params = {}) ⇒ Types::DescribeIpamResourceDiscoveriesResult
Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26386 26387 26388 26389 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26386 def describe_ipam_resource_discoveries(params = {}, = {}) req = build_request(:describe_ipam_resource_discoveries, params) req.send_request() end |
#describe_ipam_resource_discovery_associations(params = {}) ⇒ Types::DescribeIpamResourceDiscoveryAssociationsResult
Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26459 26460 26461 26462 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26459 def describe_ipam_resource_discovery_associations(params = {}, = {}) req = build_request(:describe_ipam_resource_discovery_associations, params) req.send_request() end |
#describe_ipam_scopes(params = {}) ⇒ Types::DescribeIpamScopesResult
Get information about your IPAM scopes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26533 26534 26535 26536 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26533 def describe_ipam_scopes(params = {}, = {}) req = build_request(:describe_ipam_scopes, params) req.send_request() end |
#describe_ipams(params = {}) ⇒ Types::DescribeIpamsResult
Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26620 26621 26622 26623 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26620 def describe_ipams(params = {}, = {}) req = build_request(:describe_ipams, params) req.send_request() end |
#describe_ipv_6_pools(params = {}) ⇒ Types::DescribeIpv6PoolsResult
Describes your IPv6 address pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
26695 26696 26697 26698 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26695 def describe_ipv_6_pools(params = {}, = {}) req = build_request(:describe_ipv_6_pools, params) req.send_request() end |
#describe_key_pairs(params = {}) ⇒ Types::DescribeKeyPairsResult
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- key_pair_exists
26809 26810 26811 26812 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26809 def describe_key_pairs(params = {}, = {}) req = build_request(:describe_key_pairs, params) req.send_request() end |
#describe_launch_template_versions(params = {}) ⇒ Types::DescribeLaunchTemplateVersionsResult
Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27180 27181 27182 27183 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27180 def describe_launch_template_versions(params = {}, = {}) req = build_request(:describe_launch_template_versions, params) req.send_request() end |
#describe_launch_templates(params = {}) ⇒ Types::DescribeLaunchTemplatesResult
Describes one or more launch templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27290 27291 27292 27293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27290 def describe_launch_templates(params = {}, = {}) req = build_request(:describe_launch_templates, params) req.send_request() end |
#describe_local_gateway_route_table_virtual_interface_group_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult
Describes the associations between virtual interface groups and local gateway route tables.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27378 27379 27380 27381 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27378 def describe_local_gateway_route_table_virtual_interface_group_associations(params = {}, = {}) req = build_request(:describe_local_gateway_route_table_virtual_interface_group_associations, params) req.send_request() end |
#describe_local_gateway_route_table_vpc_associations(params = {}) ⇒ Types::DescribeLocalGatewayRouteTableVpcAssociationsResult
Describes the specified associations between VPCs and local gateway route tables.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27465 27466 27467 27468 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27465 def describe_local_gateway_route_table_vpc_associations(params = {}, = {}) req = build_request(:describe_local_gateway_route_table_vpc_associations, params) req.send_request() end |
#describe_local_gateway_route_tables(params = {}) ⇒ Types::DescribeLocalGatewayRouteTablesResult
Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27552 27553 27554 27555 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27552 def describe_local_gateway_route_tables(params = {}, = {}) req = build_request(:describe_local_gateway_route_tables, params) req.send_request() end |
#describe_local_gateway_virtual_interface_groups(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfaceGroupsResult
Describes the specified local gateway virtual interface groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27629 27630 27631 27632 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27629 def describe_local_gateway_virtual_interface_groups(params = {}, = {}) req = build_request(:describe_local_gateway_virtual_interface_groups, params) req.send_request() end |
#describe_local_gateway_virtual_interfaces(params = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfacesResult
Describes the specified local gateway virtual interfaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27717 27718 27719 27720 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27717 def describe_local_gateway_virtual_interfaces(params = {}, = {}) req = build_request(:describe_local_gateway_virtual_interfaces, params) req.send_request() end |
#describe_local_gateways(params = {}) ⇒ Types::DescribeLocalGatewaysResult
Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27792 27793 27794 27795 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27792 def describe_local_gateways(params = {}, = {}) req = build_request(:describe_local_gateways, params) req.send_request() end |
#describe_locked_snapshots(params = {}) ⇒ Types::DescribeLockedSnapshotsResult
Describes the lock status for a snapshot.
27867 27868 27869 27870 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27867 def describe_locked_snapshots(params = {}, = {}) req = build_request(:describe_locked_snapshots, params) req.send_request() end |
#describe_mac_hosts(params = {}) ⇒ Types::DescribeMacHostsResult
Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27930 27931 27932 27933 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27930 def describe_mac_hosts(params = {}, = {}) req = build_request(:describe_mac_hosts, params) req.send_request() end |
#describe_managed_prefix_lists(params = {}) ⇒ Types::DescribeManagedPrefixListsResult
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28010 28011 28012 28013 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28010 def describe_managed_prefix_lists(params = {}, = {}) req = build_request(:describe_managed_prefix_lists, params) req.send_request() end |
#describe_moving_addresses(params = {}) ⇒ Types::DescribeMovingAddressesResult
Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28103 28104 28105 28106 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28103 def describe_moving_addresses(params = {}, = {}) req = build_request(:describe_moving_addresses, params) req.send_request() end |
#describe_nat_gateways(params = {}) ⇒ Types::DescribeNatGatewaysResult
Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- nat_gateway_available
- nat_gateway_deleted
28257 28258 28259 28260 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28257 def describe_nat_gateways(params = {}, = {}) req = build_request(:describe_nat_gateways, params) req.send_request() end |
#describe_network_acls(params = {}) ⇒ Types::DescribeNetworkAclsResult
Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria.
For more information, see Network ACLs in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28454 28455 28456 28457 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28454 def describe_network_acls(params = {}, = {}) req = build_request(:describe_network_acls, params) req.send_request() end |
#describe_network_insights_access_scope_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopeAnalysesResult
Describes the specified Network Access Scope analyses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28539 28540 28541 28542 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28539 def describe_network_insights_access_scope_analyses(params = {}, = {}) req = build_request(:describe_network_insights_access_scope_analyses, params) req.send_request() end |
#describe_network_insights_access_scopes(params = {}) ⇒ Types::DescribeNetworkInsightsAccessScopesResult
Describes the specified Network Access Scopes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28604 28605 28606 28607 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28604 def describe_network_insights_access_scopes(params = {}, = {}) req = build_request(:describe_network_insights_access_scopes, params) req.send_request() end |
#describe_network_insights_analyses(params = {}) ⇒ Types::DescribeNetworkInsightsAnalysesResult
Describes one or more of your network insights analyses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
29525 29526 29527 29528 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29525 def describe_network_insights_analyses(params = {}, = {}) req = build_request(:describe_network_insights_analyses, params) req.send_request() end |
#describe_network_insights_paths(params = {}) ⇒ Types::DescribeNetworkInsightsPathsResult
Describes one or more of your paths.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
29639 29640 29641 29642 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29639 def describe_network_insights_paths(params = {}, = {}) req = build_request(:describe_network_insights_paths, params) req.send_request() end |
#describe_network_interface_attribute(params = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult
Describes a network interface attribute. You can specify only one attribute at a time.
29778 29779 29780 29781 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29778 def describe_network_interface_attribute(params = {}, = {}) req = build_request(:describe_network_interface_attribute, params) req.send_request() end |
#describe_network_interface_permissions(params = {}) ⇒ Types::DescribeNetworkInterfacePermissionsResult
Describes the permissions for your network interfaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
29856 29857 29858 29859 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29856 def (params = {}, = {}) req = build_request(:describe_network_interface_permissions, params) req.send_request() end |
#describe_network_interfaces(params = {}) ⇒ Types::DescribeNetworkInterfacesResult
Describes one or more of your network interfaces.
If you have a large number of network interfaces, the operation fails
unless you use pagination or one of the following filters: group-id
,
mac-address
, private-dns-name
, private-ip-address
,
private-dns-name
, subnet-id
, or vpc-id
.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- network_interface_available
30176 30177 30178 30179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30176 def describe_network_interfaces(params = {}, = {}) req = build_request(:describe_network_interfaces, params) req.send_request() end |
#describe_placement_groups(params = {}) ⇒ Types::DescribePlacementGroupsResult
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
30266 30267 30268 30269 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30266 def describe_placement_groups(params = {}, = {}) req = build_request(:describe_placement_groups, params) req.send_request() end |
#describe_prefix_lists(params = {}) ⇒ Types::DescribePrefixListsResult
Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
30336 30337 30338 30339 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30336 def describe_prefix_lists(params = {}, = {}) req = build_request(:describe_prefix_lists, params) req.send_request() end |
#describe_principal_id_format(params = {}) ⇒ Types::DescribePrincipalIdFormatResult
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle
|
conversion-task
| customer-gateway
| dhcp-options
|
elastic-ip-allocation
| elastic-ip-association
| export-task
| flow-log
| image
| import-task
| instance
|
internet-gateway
| network-acl
| network-acl-association
|
network-interface
| network-interface-attachment
| prefix-list
| reservation
| route-table
| route-table-association
|
security-group
| snapshot
| subnet
|
subnet-cidr-block-association
| volume
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
30418 30419 30420 30421 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30418 def describe_principal_id_format(params = {}, = {}) req = build_request(:describe_principal_id_format, params) req.send_request() end |
#describe_public_ipv_4_pools(params = {}) ⇒ Types::DescribePublicIpv4PoolsResult
Describes the specified IPv4 address pools.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
30492 30493 30494 30495 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30492 def describe_public_ipv_4_pools(params = {}, = {}) req = build_request(:describe_public_ipv_4_pools, params) req.send_request() end |
#describe_regions(params = {}) ⇒ Types::DescribeRegionsResult
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.
For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide.
30631 30632 30633 30634 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30631 def describe_regions(params = {}, = {}) req = build_request(:describe_regions, params) req.send_request() end |
#describe_replace_root_volume_tasks(params = {}) ⇒ Types::DescribeReplaceRootVolumeTasksResult
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
30715 30716 30717 30718 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30715 def describe_replace_root_volume_tasks(params = {}, = {}) req = build_request(:describe_replace_root_volume_tasks, params) req.send_request() end |
#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResult
Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
30854 30855 30856 30857 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30854 def describe_reserved_instances(params = {}, = {}) req = build_request(:describe_reserved_instances, params) req.send_request() end |
#describe_reserved_instances_listings(params = {}) ⇒ Types::DescribeReservedInstancesListingsResult
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
30955 30956 30957 30958 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30955 def describe_reserved_instances_listings(params = {}, = {}) req = build_request(:describe_reserved_instances_listings, params) req.send_request() end |
#describe_reserved_instances_modifications(params = {}) ⇒ Types::DescribeReservedInstancesModificationsResult
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31065 31066 31067 31068 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31065 def describe_reserved_instances_modifications(params = {}, = {}) req = build_request(:describe_reserved_instances_modifications, params) req.send_request() end |
#describe_reserved_instances_offerings(params = {}) ⇒ Types::DescribeReservedInstancesOfferingsResult
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31267 31268 31269 31270 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31267 def describe_reserved_instances_offerings(params = {}, = {}) req = build_request(:describe_reserved_instances_offerings, params) req.send_request() end |
#describe_route_tables(params = {}) ⇒ Types::DescribeRouteTablesResult
Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31488 31489 31490 31491 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31488 def describe_route_tables(params = {}, = {}) req = build_request(:describe_route_tables, params) req.send_request() end |
#describe_scheduled_instance_availability(params = {}) ⇒ Types::DescribeScheduledInstanceAvailabilityResult
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31607 31608 31609 31610 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31607 def describe_scheduled_instance_availability(params = {}, = {}) req = build_request(:describe_scheduled_instance_availability, params) req.send_request() end |
#describe_scheduled_instances(params = {}) ⇒ Types::DescribeScheduledInstancesResult
Describes the specified Scheduled Instances or all your Scheduled Instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31701 31702 31703 31704 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31701 def describe_scheduled_instances(params = {}, = {}) req = build_request(:describe_scheduled_instances, params) req.send_request() end |
#describe_security_group_references(params = {}) ⇒ Types::DescribeSecurityGroupReferencesResult
Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
31763 31764 31765 31766 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31763 def describe_security_group_references(params = {}, = {}) req = build_request(:describe_security_group_references, params) req.send_request() end |
#describe_security_group_rules(params = {}) ⇒ Types::DescribeSecurityGroupRulesResult
Describes one or more of your security group rules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
31857 31858 31859 31860 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31857 def describe_security_group_rules(params = {}, = {}) req = build_request(:describe_security_group_rules, params) req.send_request() end |
#describe_security_groups(params = {}) ⇒ Types::DescribeSecurityGroupsResult
Describes the specified security groups or all of your security groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- security_group_exists
32102 32103 32104 32105 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32102 def describe_security_groups(params = {}, = {}) req = build_request(:describe_security_groups, params) req.send_request() end |
#describe_snapshot_attribute(params = {}) ⇒ Types::DescribeSnapshotAttributeResult
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
32175 32176 32177 32178 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32175 def describe_snapshot_attribute(params = {}, = {}) req = build_request(:describe_snapshot_attribute, params) req.send_request() end |
#describe_snapshot_tier_status(params = {}) ⇒ Types::DescribeSnapshotTierStatusResult
Describes the storage tier status of one or more Amazon EBS snapshots.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
32259 32260 32261 32262 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32259 def describe_snapshot_tier_status(params = {}, = {}) req = build_request(:describe_snapshot_tier_status, params) req.send_request() end |
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the
all
group. All Amazon Web Services accounts have create volume permissions for these snapshots.explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds
option, only snapshots from the specified owners and for which you
have access are returned. The results can include the Amazon Web
Services account IDs of the specified owners, amazon
for snapshots
owned by Amazon, or self
for snapshots that you own.
If you specify a list of restorable users, only snapshots with create
snapshot permissions for those users are returned. You can specify
Amazon Web Services account IDs (if you own the snapshots), self
for
snapshots for which you own or have explicit permissions, or all
for
public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- snapshot_completed
32523 32524 32525 32526 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32523 def describe_snapshots(params = {}, = {}) req = build_request(:describe_snapshots, params) req.send_request() end |
#describe_spot_datafeed_subscription(params = {}) ⇒ Types::DescribeSpotDatafeedSubscriptionResult
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.
32582 32583 32584 32585 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32582 def describe_spot_datafeed_subscription(params = {}, = {}) req = build_request(:describe_spot_datafeed_subscription, params) req.send_request() end |
#describe_spot_fleet_instances(params = {}) ⇒ Types::DescribeSpotFleetInstancesResponse
Describes the running instances for the specified Spot Fleet.
32661 32662 32663 32664 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32661 def describe_spot_fleet_instances(params = {}, = {}) req = build_request(:describe_spot_fleet_instances, params) req.send_request() end |
#describe_spot_fleet_request_history(params = {}) ⇒ Types::DescribeSpotFleetRequestHistoryResponse
Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
32795 32796 32797 32798 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32795 def describe_spot_fleet_request_history(params = {}, = {}) req = build_request(:describe_spot_fleet_request_history, params) req.send_request() end |
#describe_spot_fleet_requests(params = {}) ⇒ Types::DescribeSpotFleetRequestsResponse
Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
33112 33113 33114 33115 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33112 def describe_spot_fleet_requests(params = {}, = {}) req = build_request(:describe_spot_fleet_requests, params) req.send_request() end |
#describe_spot_instance_requests(params = {}) ⇒ Types::DescribeSpotInstanceRequestsResult
Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests
to find a running Spot
Instance by examining the response. If the status of the Spot Instance
is fulfilled
, the instance ID appears in the response and contains
the identifier of the instance. Alternatively, you can use
DescribeInstances with a filter to look for instances where the
instance lifecycle is spot
.
We recommend that you set MaxResults
to a value between 5 and 1000
to limit the number of items returned. This paginates the output,
which makes the list more manageable and returns the items faster. If
the list of items exceeds your MaxResults
value, then that number of
items is returned along with a NextToken
value that can be passed to
a subsequent DescribeSpotInstanceRequests
request to retrieve the
remaining items.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- spot_instance_request_fulfilled
33462 33463 33464 33465 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33462 def describe_spot_instance_requests(params = {}, = {}) req = build_request(:describe_spot_instance_requests, params) req.send_request() end |
#describe_spot_price_history(params = {}) ⇒ Types::DescribeSpotPriceHistoryResult
Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
33616 33617 33618 33619 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33616 def describe_spot_price_history(params = {}, = {}) req = build_request(:describe_spot_price_history, params) req.send_request() end |
#describe_stale_security_groups(params = {}) ⇒ Types::DescribeStaleSecurityGroupsResult
Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or peered VPC. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
33710 33711 33712 33713 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33710 def describe_stale_security_groups(params = {}, = {}) req = build_request(:describe_stale_security_groups, params) req.send_request() end |
#describe_store_image_tasks(params = {}) ⇒ Types::DescribeStoreImageTasksResult
Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days.
For each AMI task, the response indicates if the task is InProgress
,
Completed
, or Failed
. For tasks InProgress
, the response shows
the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.
To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using Amazon S3 in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- store_image_task_complete
33822 33823 33824 33825 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33822 def describe_store_image_tasks(params = {}, = {}) req = build_request(:describe_store_image_tasks, params) req.send_request() end |
#describe_subnets(params = {}) ⇒ Types::DescribeSubnetsResult
Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria.
For more information, see Subnets in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- subnet_available
34048 34049 34050 34051 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34048 def describe_subnets(params = {}, = {}) req = build_request(:describe_subnets, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsResult
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34179 34180 34181 34182 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34179 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_traffic_mirror_filter_rules(params = {}) ⇒ Types::DescribeTrafficMirrorFilterRulesResult
Describe traffic mirror filters that determine the traffic that is mirrored.
34280 34281 34282 34283 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34280 def describe_traffic_mirror_filter_rules(params = {}, = {}) req = build_request(:describe_traffic_mirror_filter_rules, params) req.send_request() end |
#describe_traffic_mirror_filters(params = {}) ⇒ Types::DescribeTrafficMirrorFiltersResult
Describes one or more Traffic Mirror filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34383 34384 34385 34386 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34383 def describe_traffic_mirror_filters(params = {}, = {}) req = build_request(:describe_traffic_mirror_filters, params) req.send_request() end |
#describe_traffic_mirror_sessions(params = {}) ⇒ Types::DescribeTrafficMirrorSessionsResult
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34476 34477 34478 34479 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34476 def describe_traffic_mirror_sessions(params = {}, = {}) req = build_request(:describe_traffic_mirror_sessions, params) req.send_request() end |
#describe_traffic_mirror_targets(params = {}) ⇒ Types::DescribeTrafficMirrorTargetsResult
Information about one or more Traffic Mirror targets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34557 34558 34559 34560 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34557 def describe_traffic_mirror_targets(params = {}, = {}) req = build_request(:describe_traffic_mirror_targets, params) req.send_request() end |
#describe_transit_gateway_attachments(params = {}) ⇒ Types::DescribeTransitGatewayAttachmentsResult
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34657 34658 34659 34660 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34657 def (params = {}, = {}) req = build_request(:describe_transit_gateway_attachments, params) req.send_request() end |
#describe_transit_gateway_connect_peers(params = {}) ⇒ Types::DescribeTransitGatewayConnectPeersResult
Describes one or more Connect peers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34740 34741 34742 34743 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34740 def describe_transit_gateway_connect_peers(params = {}, = {}) req = build_request(:describe_transit_gateway_connect_peers, params) req.send_request() end |
#describe_transit_gateway_connects(params = {}) ⇒ Types::DescribeTransitGatewayConnectsResult
Describes one or more Connect attachments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34821 34822 34823 34824 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34821 def describe_transit_gateway_connects(params = {}, = {}) req = build_request(:describe_transit_gateway_connects, params) req.send_request() end |
#describe_transit_gateway_multicast_domains(params = {}) ⇒ Types::DescribeTransitGatewayMulticastDomainsResult
Describes one or more transit gateway multicast domains.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34899 34900 34901 34902 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34899 def describe_transit_gateway_multicast_domains(params = {}, = {}) req = build_request(:describe_transit_gateway_multicast_domains, params) req.send_request() end |
#describe_transit_gateway_peering_attachments(params = {}) ⇒ Types::DescribeTransitGatewayPeeringAttachmentsResult
Describes your transit gateway peering attachments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35000 35001 35002 35003 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35000 def (params = {}, = {}) req = build_request(:describe_transit_gateway_peering_attachments, params) req.send_request() end |
#describe_transit_gateway_policy_tables(params = {}) ⇒ Types::DescribeTransitGatewayPolicyTablesResult
Describes one or more transit gateway route policy tables.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35065 35066 35067 35068 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35065 def describe_transit_gateway_policy_tables(params = {}, = {}) req = build_request(:describe_transit_gateway_policy_tables, params) req.send_request() end |
#describe_transit_gateway_route_table_announcements(params = {}) ⇒ Types::DescribeTransitGatewayRouteTableAnnouncementsResult
Describes one or more transit gateway route table advertisements.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35136 35137 35138 35139 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35136 def describe_transit_gateway_route_table_announcements(params = {}, = {}) req = build_request(:describe_transit_gateway_route_table_announcements, params) req.send_request() end |
#describe_transit_gateway_route_tables(params = {}) ⇒ Types::DescribeTransitGatewayRouteTablesResult
Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35221 35222 35223 35224 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35221 def describe_transit_gateway_route_tables(params = {}, = {}) req = build_request(:describe_transit_gateway_route_tables, params) req.send_request() end |
#describe_transit_gateway_vpc_attachments(params = {}) ⇒ Types::DescribeTransitGatewayVpcAttachmentsResult
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35306 35307 35308 35309 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35306 def (params = {}, = {}) req = build_request(:describe_transit_gateway_vpc_attachments, params) req.send_request() end |
#describe_transit_gateways(params = {}) ⇒ Types::DescribeTransitGatewaysResult
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35427 35428 35429 35430 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35427 def describe_transit_gateways(params = {}, = {}) req = build_request(:describe_transit_gateways, params) req.send_request() end |
#describe_trunk_interface_associations(params = {}) ⇒ Types::DescribeTrunkInterfaceAssociationsResult
Describes one or more network interface trunk associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35499 35500 35501 35502 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35499 def describe_trunk_interface_associations(params = {}, = {}) req = build_request(:describe_trunk_interface_associations, params) req.send_request() end |
#describe_verified_access_endpoints(params = {}) ⇒ Types::DescribeVerifiedAccessEndpointsResult
Describes the specified Amazon Web Services Verified Access endpoints.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35595 35596 35597 35598 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35595 def describe_verified_access_endpoints(params = {}, = {}) req = build_request(:describe_verified_access_endpoints, params) req.send_request() end |
#describe_verified_access_groups(params = {}) ⇒ Types::DescribeVerifiedAccessGroupsResult
Describes the specified Verified Access groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35670 35671 35672 35673 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35670 def describe_verified_access_groups(params = {}, = {}) req = build_request(:describe_verified_access_groups, params) req.send_request() end |
#describe_verified_access_instance_logging_configurations(params = {}) ⇒ Types::DescribeVerifiedAccessInstanceLoggingConfigurationsResult
Describes the specified Amazon Web Services Verified Access instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35745 35746 35747 35748 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35745 def describe_verified_access_instance_logging_configurations(params = {}, = {}) req = build_request(:describe_verified_access_instance_logging_configurations, params) req.send_request() end |
#describe_verified_access_instances(params = {}) ⇒ Types::DescribeVerifiedAccessInstancesResult
Describes the specified Amazon Web Services Verified Access instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35817 35818 35819 35820 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35817 def describe_verified_access_instances(params = {}, = {}) req = build_request(:describe_verified_access_instances, params) req.send_request() end |
#describe_verified_access_trust_providers(params = {}) ⇒ Types::DescribeVerifiedAccessTrustProvidersResult
Describes the specified Amazon Web Services Verified Access trust providers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35898 35899 35900 35901 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35898 def describe_verified_access_trust_providers(params = {}, = {}) req = build_request(:describe_verified_access_trust_providers, params) req.send_request() end |
#describe_volume_attribute(params = {}) ⇒ Types::DescribeVolumeAttributeResult
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
35969 35970 35971 35972 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35969 def describe_volume_attribute(params = {}, = {}) req = build_request(:describe_volume_attribute, params) req.send_request() end |
#describe_volume_status(params = {}) ⇒ Types::DescribeVolumeStatusResult
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus
operation provides the following
information about the specified volumes:
Status: Reflects the current status of the volume. The possible
values are ok
, impaired
, warning
, or insufficient-data
. If
all checks pass, the overall status of the volume is ok
. If the
check fails, the overall status is impaired
. If the status is
insufficient-data
, then the checks might still be taking place on
your volume at the time. We recommend that you retry the request. For
more information about volume status, see Monitor the status of your
volumes in the Amazon EBS User Guide.
Events: Reflect the cause of a volume status and might require you
to take action. For example, if your volume returns an impaired
status, then the volume event might be potential-data-inconsistency
.
This means that your volume has been affected by an issue with the
underlying host, has all I/O operations disabled, and might have
inconsistent data.
Actions: Reflect the actions you might have to take in response to
an event. For example, if the status of the volume is impaired
and
the volume event shows potential-data-inconsistency
, then the action
shows enable-volume-io
. This means that you may want to enable the
I/O operations for the volume by calling the EnableVolumeIO action and
then check the volume for data consistency.
Volume status is based on the volume status checks, and does not
reflect the volume state. Therefore, volume status does not indicate
volumes in the error
state (for example, when a volume is incapable
of accepting I/O.)
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36197 36198 36199 36200 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36197 def describe_volume_status(params = {}, = {}) req = build_request(:describe_volume_status, params) req.send_request() end |
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- volume_available
- volume_deleted
- volume_in_use
36448 36449 36450 36451 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36448 def describe_volumes(params = {}, = {}) req = build_request(:describe_volumes, params) req.send_request() end |
#describe_volumes_modifications(params = {}) ⇒ Types::DescribeVolumesModificationsResult
Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36565 36566 36567 36568 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36565 def describe_volumes_modifications(params = {}, = {}) req = build_request(:describe_volumes_modifications, params) req.send_request() end |
#describe_vpc_attribute(params = {}) ⇒ Types::DescribeVpcAttributeResult
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
36649 36650 36651 36652 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36649 def describe_vpc_attribute(params = {}, = {}) req = build_request(:describe_vpc_attribute, params) req.send_request() end |
#describe_vpc_classic_link(params = {}) ⇒ Types::DescribeVpcClassicLinkResult
Describes the ClassicLink status of the specified VPCs.
36715 36716 36717 36718 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36715 def describe_vpc_classic_link(params = {}, = {}) req = build_request(:describe_vpc_classic_link, params) req.send_request() end |
#describe_vpc_classic_link_dns_support(params = {}) ⇒ Types::DescribeVpcClassicLinkDnsSupportResult
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36773 36774 36775 36776 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36773 def describe_vpc_classic_link_dns_support(params = {}, = {}) req = build_request(:describe_vpc_classic_link_dns_support, params) req.send_request() end |
#describe_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DescribeVpcEndpointConnectionNotificationsResult
Describes the connection notifications for VPC endpoints and VPC endpoint services.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36854 36855 36856 36857 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36854 def describe_vpc_endpoint_connection_notifications(params = {}, = {}) req = build_request(:describe_vpc_endpoint_connection_notifications, params) req.send_request() end |
#describe_vpc_endpoint_connections(params = {}) ⇒ Types::DescribeVpcEndpointConnectionsResult
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36941 36942 36943 36944 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36941 def describe_vpc_endpoint_connections(params = {}, = {}) req = build_request(:describe_vpc_endpoint_connections, params) req.send_request() end |
#describe_vpc_endpoint_service_configurations(params = {}) ⇒ Types::DescribeVpcEndpointServiceConfigurationsResult
Describes the VPC endpoint service configurations in your account (your services).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
37048 37049 37050 37051 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37048 def describe_vpc_endpoint_service_configurations(params = {}, = {}) req = build_request(:describe_vpc_endpoint_service_configurations, params) req.send_request() end |
#describe_vpc_endpoint_service_permissions(params = {}) ⇒ Types::DescribeVpcEndpointServicePermissionsResult
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
37121 37122 37123 37124 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37121 def (params = {}, = {}) req = build_request(:describe_vpc_endpoint_service_permissions, params) req.send_request() end |
#describe_vpc_endpoint_services(params = {}) ⇒ Types::DescribeVpcEndpointServicesResult
Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts in
multiple Availability Zones, and the consumer views the VPC endpoint
service information, the response only includes the common
Availability Zones. For example, when the service provider account
uses us-east-1a
and us-east-1c
and the consumer uses us-east-1a
and us-east-1b
, the response includes the VPC endpoint services in
the common Availability Zone, us-east-1a
.
37235 37236 37237 37238 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37235 def describe_vpc_endpoint_services(params = {}, = {}) req = build_request(:describe_vpc_endpoint_services, params) req.send_request() end |
#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResult
Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
37355 37356 37357 37358 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37355 def describe_vpc_endpoints(params = {}, = {}) req = build_request(:describe_vpc_endpoints, params) req.send_request() end |
#describe_vpc_peering_connections(params = {}) ⇒ Types::DescribeVpcPeeringConnectionsResult
Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- vpc_peering_connection_deleted
- vpc_peering_connection_exists
37496 37497 37498 37499 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37496 def describe_vpc_peering_connections(params = {}, = {}) req = build_request(:describe_vpc_peering_connections, params) req.send_request() end |
#describe_vpcs(params = {}) ⇒ Types::DescribeVpcsResult
Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- vpc_available
- vpc_exists
37667 37668 37669 37670 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37667 def describe_vpcs(params = {}, = {}) req = build_request(:describe_vpcs, params) req.send_request() end |
#describe_vpn_connections(params = {}) ⇒ Types::DescribeVpnConnectionsResult
Describes one or more of your VPN connections.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- vpn_connection_available
- vpn_connection_deleted
37831 37832 37833 37834 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37831 def describe_vpn_connections(params = {}, = {}) req = build_request(:describe_vpn_connections, params) req.send_request() end |
#describe_vpn_gateways(params = {}) ⇒ Types::DescribeVpnGatewaysResult
Describes one or more of your virtual private gateways.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
37925 37926 37927 37928 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37925 def describe_vpn_gateways(params = {}, = {}) req = build_request(:describe_vpn_gateways, params) req.send_request() end |
#detach_classic_link_vpc(params = {}) ⇒ Types::DetachClassicLinkVpcResult
Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.
37971 37972 37973 37974 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37971 def detach_classic_link_vpc(params = {}, = {}) req = build_request(:detach_classic_link_vpc, params) req.send_request() end |
#detach_internet_gateway(params = {}) ⇒ Struct
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.
38016 38017 38018 38019 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38016 def detach_internet_gateway(params = {}, = {}) req = build_request(:detach_internet_gateway, params) req.send_request() end |
#detach_network_interface(params = {}) ⇒ Struct
Detaches a network interface from an instance.
38078 38079 38080 38081 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38078 def detach_network_interface(params = {}, = {}) req = build_request(:detach_network_interface, params) req.send_request() end |
#detach_verified_access_trust_provider(params = {}) ⇒ Types::DetachVerifiedAccessTrustProviderResult
Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.
38168 38169 38170 38171 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38168 def detach_verified_access_trust_provider(params = {}, = {}) req = build_request(:detach_verified_access_trust_provider, params) req.send_request() end |
#detach_volume(params = {}) ⇒ Types::VolumeAttachment
Detaches an EBS volume from an instance. Make sure to unmount any file
systems on the device within your operating system before detaching
the volume. Failure to do so can result in the volume becoming stuck
in the busy
state while detaching. If this happens, detachment can
be delayed indefinitely until you unmount the volume, force
detachment, reboot the instance, or all three. If an EBS volume is the
root device of an instance, it can't be detached while the instance
is running. To detach the root volume, stop the instance first.
When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
You can't detach or force detach volumes that are attached to Amazon
ECS or Fargate tasks. Attempting to do this results in the
UnsupportedOperationException
exception with the Unable to detach
volume attached to ECS tasks
error message.
For more information, see Detach an Amazon EBS volume in the Amazon EBS User Guide.
38278 38279 38280 38281 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38278 def detach_volume(params = {}, = {}) req = build_request(:detach_volume, params) req.send_request() end |
#detach_vpn_gateway(params = {}) ⇒ Struct
Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).
You must wait for the attachment's state to switch to detached
before you can delete the VPC or attach a different VPC to the virtual
private gateway.
38319 38320 38321 38322 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38319 def detach_vpn_gateway(params = {}, = {}) req = build_request(:detach_vpn_gateway, params) req.send_request() end |
#disable_address_transfer(params = {}) ⇒ Types::DisableAddressTransferResult
Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
38364 38365 38366 38367 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38364 def disable_address_transfer(params = {}, = {}) req = build_request(:disable_address_transfer, params) req.send_request() end |
#disable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::DisableAwsNetworkPerformanceMetricSubscriptionResult
Disables Infrastructure Performance metric subscriptions.
38413 38414 38415 38416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38413 def disable_aws_network_performance_metric_subscription(params = {}, = {}) req = build_request(:disable_aws_network_performance_metric_subscription, params) req.send_request() end |
#disable_ebs_encryption_by_default(params = {}) ⇒ Types::DisableEbsEncryptionByDefaultResult
Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
38458 38459 38460 38461 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38458 def disable_ebs_encryption_by_default(params = {}, = {}) req = build_request(:disable_ebs_encryption_by_default, params) req.send_request() end |
#disable_fast_launch(params = {}) ⇒ Types::DisableFastLaunchResult
Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.
38526 38527 38528 38529 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38526 def disable_fast_launch(params = {}, = {}) req = build_request(:disable_fast_launch, params) req.send_request() end |
#disable_fast_snapshot_restores(params = {}) ⇒ Types::DisableFastSnapshotRestoresResult
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
38585 38586 38587 38588 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38585 def disable_fast_snapshot_restores(params = {}, = {}) req = build_request(:disable_fast_snapshot_restores, params) req.send_request() end |
#disable_image(params = {}) ⇒ Types::DisableImageResult
Sets the AMI state to disabled
and removes all launch permissions
from the AMI. A disabled AMI can't be used for instance launches.
A disabled AMI can't be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI.
A disabled AMI does not appear in DescribeImages API calls by default.
Only the AMI owner can disable an AMI.
You can re-enable a disabled AMI using EnableImage.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
38642 38643 38644 38645 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38642 def disable_image(params = {}, = {}) req = build_request(:disable_image, params) req.send_request() end |
#disable_image_block_public_access(params = {}) ⇒ Types::DisableImageBlockPublicAccessResult
Disables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region.
The API can take up to 10 minutes to configure this setting. During
this time, if you run GetImageBlockPublicAccessState, the
response will be block-new-sharing
. When the API has completed the
configuration, the response will be unblocked
.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
38690 38691 38692 38693 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38690 def disable_image_block_public_access(params = {}, = {}) req = build_request(:disable_image_block_public_access, params) req.send_request() end |
#disable_image_deprecation(params = {}) ⇒ Types::DisableImageDeprecationResult
Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
38732 38733 38734 38735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38732 def disable_image_deprecation(params = {}, = {}) req = build_request(:disable_image_deprecation, params) req.send_request() end |
#disable_image_deregistration_protection(params = {}) ⇒ Types::DisableImageDeregistrationProtectionResult
Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered.
If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
38780 38781 38782 38783 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38780 def disable_image_deregistration_protection(params = {}, = {}) req = build_request(:disable_image_deregistration_protection, params) req.send_request() end |
#disable_ipam_organization_admin_account(params = {}) ⇒ Types::DisableIpamOrganizationAdminAccountResult
Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
38822 38823 38824 38825 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38822 def disable_ipam_organization_admin_account(params = {}, = {}) req = build_request(:disable_ipam_organization_admin_account, params) req.send_request() end |
#disable_serial_console_access(params = {}) ⇒ Types::DisableSerialConsoleAccessResult
Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
38860 38861 38862 38863 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38860 def disable_serial_console_access(params = {}, = {}) req = build_request(:disable_serial_console_access, params) req.send_request() end |
#disable_snapshot_block_public_access(params = {}) ⇒ Types::DisableSnapshotBlockPublicAccessResult
Disables the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region.
If block public access is enabled in block-all-sharing
mode, and you
disable block public access, all snapshots that were previously
publicly shared are no longer treated as private and they become
publicly accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide .
38908 38909 38910 38911 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38908 def disable_snapshot_block_public_access(params = {}, = {}) req = build_request(:disable_snapshot_block_public_access, params) req.send_request() end |
#disable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::DisableTransitGatewayRouteTablePropagationResult
Disables the specified resource attachment from propagating routes to the specified propagation route table.
38957 38958 38959 38960 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38957 def disable_transit_gateway_route_table_propagation(params = {}, = {}) req = build_request(:disable_transit_gateway_route_table_propagation, params) req.send_request() end |
#disable_vgw_route_propagation(params = {}) ⇒ Struct
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
39001 39002 39003 39004 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39001 def disable_vgw_route_propagation(params = {}, = {}) req = build_request(:disable_vgw_route_propagation, params) req.send_request() end |
#disable_vpc_classic_link(params = {}) ⇒ Types::DisableVpcClassicLinkResult
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
39041 39042 39043 39044 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39041 def disable_vpc_classic_link(params = {}, = {}) req = build_request(:disable_vpc_classic_link, params) req.send_request() end |
#disable_vpc_classic_link_dns_support(params = {}) ⇒ Types::DisableVpcClassicLinkDnsSupportResult
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked.
You must specify a VPC ID in the request.
39077 39078 39079 39080 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39077 def disable_vpc_classic_link_dns_support(params = {}, = {}) req = build_request(:disable_vpc_classic_link_dns_support, params) req.send_request() end |
#disassociate_address(params = {}) ⇒ Struct
Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
39123 39124 39125 39126 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39123 def disassociate_address(params = {}, = {}) req = build_request(:disassociate_address, params) req.send_request() end |
#disassociate_client_vpn_target_network(params = {}) ⇒ Types::DisassociateClientVpnTargetNetworkResult
Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to
pending-associate
39176 39177 39178 39179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39176 def disassociate_client_vpn_target_network(params = {}, = {}) req = build_request(:disassociate_client_vpn_target_network, params) req.send_request() end |
#disassociate_enclave_certificate_iam_role(params = {}) ⇒ Types::DisassociateEnclaveCertificateIamRoleResult
Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
39222 39223 39224 39225 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39222 def disassociate_enclave_certificate_iam_role(params = {}, = {}) req = build_request(:disassociate_enclave_certificate_iam_role, params) req.send_request() end |
#disassociate_iam_instance_profile(params = {}) ⇒ Types::DisassociateIamInstanceProfileResult
Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
39280 39281 39282 39283 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39280 def disassociate_iam_instance_profile(params = {}, = {}) req = build_request(:disassociate_iam_instance_profile, params) req.send_request() end |
#disassociate_instance_event_window(params = {}) ⇒ Types::DisassociateInstanceEventWindowResult
Disassociates one or more targets from an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
39353 39354 39355 39356 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39353 def disassociate_instance_event_window(params = {}, = {}) req = build_request(:disassociate_instance_event_window, params) req.send_request() end |
#disassociate_ipam_byoasn(params = {}) ⇒ Types::DisassociateIpamByoasnResult
Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
39402 39403 39404 39405 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39402 def disassociate_ipam_byoasn(params = {}, = {}) req = build_request(:disassociate_ipam_byoasn, params) req.send_request() end |
#disassociate_ipam_resource_discovery(params = {}) ⇒ Types::DisassociateIpamResourceDiscoveryResult
Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
39451 39452 39453 39454 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39451 def disassociate_ipam_resource_discovery(params = {}, = {}) req = build_request(:disassociate_ipam_resource_discovery, params) req.send_request() end |
#disassociate_nat_gateway_address(params = {}) ⇒ Types::DisassociateNatGatewayAddressResult
Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.
An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released.
39525 39526 39527 39528 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39525 def disassociate_nat_gateway_address(params = {}, = {}) req = build_request(:disassociate_nat_gateway_address, params) req.send_request() end |
#disassociate_route_table(params = {}) ⇒ Struct
Disassociates a subnet or gateway from a route table.
After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the Amazon VPC User Guide.
39573 39574 39575 39576 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39573 def disassociate_route_table(params = {}, = {}) req = build_request(:disassociate_route_table, params) req.send_request() end |
#disassociate_subnet_cidr_block(params = {}) ⇒ Types::DisassociateSubnetCidrBlockResult
Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
39609 39610 39611 39612 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39609 def disassociate_subnet_cidr_block(params = {}, = {}) req = build_request(:disassociate_subnet_cidr_block, params) req.send_request() end |
#disassociate_transit_gateway_multicast_domain(params = {}) ⇒ Types::DisassociateTransitGatewayMulticastDomainResult
Disassociates the specified subnets from the transit gateway multicast domain.
39660 39661 39662 39663 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39660 def disassociate_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:disassociate_transit_gateway_multicast_domain, params) req.send_request() end |
#disassociate_transit_gateway_policy_table(params = {}) ⇒ Types::DisassociateTransitGatewayPolicyTableResult
Removes the association between an an attachment and a policy table.
39704 39705 39706 39707 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39704 def disassociate_transit_gateway_policy_table(params = {}, = {}) req = build_request(:disassociate_transit_gateway_policy_table, params) req.send_request() end |
#disassociate_transit_gateway_route_table(params = {}) ⇒ Types::DisassociateTransitGatewayRouteTableResult
Disassociates a resource attachment from a transit gateway route table.
39748 39749 39750 39751 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39748 def disassociate_transit_gateway_route_table(params = {}, = {}) req = build_request(:disassociate_transit_gateway_route_table, params) req.send_request() end |
#disassociate_trunk_interface(params = {}) ⇒ Types::DisassociateTrunkInterfaceResult
Removes an association between a branch network interface with a trunk network interface.
39799 39800 39801 39802 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39799 def disassociate_trunk_interface(params = {}, = {}) req = build_request(:disassociate_trunk_interface, params) req.send_request() end |
#disassociate_vpc_cidr_block(params = {}) ⇒ Types::DisassociateVpcCidrBlockResult
Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).
39846 39847 39848 39849 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39846 def disassociate_vpc_cidr_block(params = {}, = {}) req = build_request(:disassociate_vpc_cidr_block, params) req.send_request() end |
#enable_address_transfer(params = {}) ⇒ Types::EnableAddressTransferResult
Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.
39896 39897 39898 39899 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39896 def enable_address_transfer(params = {}, = {}) req = build_request(:enable_address_transfer, params) req.send_request() end |
#enable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::EnableAwsNetworkPerformanceMetricSubscriptionResult
Enables Infrastructure Performance subscriptions.
39949 39950 39951 39952 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39949 def enable_aws_network_performance_metric_subscription(params = {}, = {}) req = build_request(:enable_aws_network_performance_metric_subscription, params) req.send_request() end |
#enable_ebs_encryption_by_default(params = {}) ⇒ Types::EnableEbsEncryptionByDefaultResult
Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
Enabling encryption by default has no effect on the encryption status of your existing volumes.
After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
40002 40003 40004 40005 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40002 def enable_ebs_encryption_by_default(params = {}, = {}) req = build_request(:enable_ebs_encryption_by_default, params) req.send_request() end |
#enable_fast_launch(params = {}) ⇒ Types::EnableFastLaunchResult
When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.
40096 40097 40098 40099 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40096 def enable_fast_launch(params = {}, = {}) req = build_request(:enable_fast_launch, params) req.send_request() end |
#enable_fast_snapshot_restores(params = {}) ⇒ Types::EnableFastSnapshotRestoresResult
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter
the enabled
state. To get the current state of fast snapshot
restores, use DescribeFastSnapshotRestores. To disable fast snapshot
restores, use DisableFastSnapshotRestores.
For more information, see Amazon EBS fast snapshot restore in the Amazon EBS User Guide.
40168 40169 40170 40171 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40168 def enable_fast_snapshot_restores(params = {}, = {}) req = build_request(:enable_fast_snapshot_restores, params) req.send_request() end |
#enable_image(params = {}) ⇒ Types::EnableImageResult
Re-enables a disabled AMI. The re-enabled AMI is marked as available
and can be used for instance launches, appears in describe operations,
and can be shared. Amazon Web Services accounts, organizations, and
Organizational Units that lost access to the AMI when it was disabled
do not regain access automatically. Once the AMI is available, it can
be shared with them again.
Only the AMI owner can re-enable a disabled AMI.
For more information, see Disable an AMI in the Amazon EC2 User Guide.
40217 40218 40219 40220 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40217 def enable_image(params = {}, = {}) req = build_request(:enable_image, params) req.send_request() end |
#enable_image_block_public_access(params = {}) ⇒ Types::EnableImageBlockPublicAccessResult
Enables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available.
The API can take up to 10 minutes to configure this setting. During
this time, if you run GetImageBlockPublicAccessState, the
response will be unblocked
. When the API has completed the
configuration, the response will be block-new-sharing
.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
40270 40271 40272 40273 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40270 def enable_image_block_public_access(params = {}, = {}) req = build_request(:enable_image_block_public_access, params) req.send_request() end |
#enable_image_deprecation(params = {}) ⇒ Types::EnableImageDeprecationResult
Enables deprecation of the specified AMI at the specified date and time.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
40323 40324 40325 40326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40323 def enable_image_deprecation(params = {}, = {}) req = build_request(:enable_image_deprecation, params) req.send_request() end |
#enable_image_deregistration_protection(params = {}) ⇒ Types::EnableImageDeregistrationProtectionResult
Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered.
To allow the AMI to be deregistered, you must first disable deregistration protection using DisableImageDeregistrationProtection.
For more information, see Protect an AMI from deregistration in the Amazon EC2 User Guide.
40374 40375 40376 40377 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40374 def enable_image_deregistration_protection(params = {}, = {}) req = build_request(:enable_image_deregistration_protection, params) req.send_request() end |
#enable_ipam_organization_admin_account(params = {}) ⇒ Types::EnableIpamOrganizationAdminAccountResult
Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.
40417 40418 40419 40420 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40417 def enable_ipam_organization_admin_account(params = {}, = {}) req = build_request(:enable_ipam_organization_admin_account, params) req.send_request() end |
#enable_reachability_analyzer_organization_sharing(params = {}) ⇒ Types::EnableReachabilityAnalyzerOrganizationSharingResult
Establishes a trust relationship between Reachability Analyzer and Organizations. This operation must be performed by the management account for the organization.
After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts.
40454 40455 40456 40457 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40454 def enable_reachability_analyzer_organization_sharing(params = {}, = {}) req = build_request(:enable_reachability_analyzer_organization_sharing, params) req.send_request() end |
#enable_serial_console_access(params = {}) ⇒ Types::EnableSerialConsoleAccessResult
Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
40492 40493 40494 40495 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40492 def enable_serial_console_access(params = {}, = {}) req = build_request(:enable_serial_console_access, params) req.send_request() end |
#enable_snapshot_block_public_access(params = {}) ⇒ Types::EnableSnapshotBlockPublicAccessResult
Enables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify.
If block public access is enabled in block-all-sharing
mode, and you
change the mode to block-new-sharing
, all snapshots that were
previously publicly shared are no longer treated as private and they
become publicly accessible again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
40569 40570 40571 40572 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40569 def enable_snapshot_block_public_access(params = {}, = {}) req = build_request(:enable_snapshot_block_public_access, params) req.send_request() end |
#enable_transit_gateway_route_table_propagation(params = {}) ⇒ Types::EnableTransitGatewayRouteTablePropagationResult
Enables the specified attachment to propagate routes to the specified propagation route table.
40618 40619 40620 40621 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40618 def enable_transit_gateway_route_table_propagation(params = {}, = {}) req = build_request(:enable_transit_gateway_route_table_propagation, params) req.send_request() end |
#enable_vgw_route_propagation(params = {}) ⇒ Struct
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
40665 40666 40667 40668 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40665 def enable_vgw_route_propagation(params = {}, = {}) req = build_request(:enable_vgw_route_propagation, params) req.send_request() end |
#enable_volume_io(params = {}) ⇒ Struct
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
40704 40705 40706 40707 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40704 def enable_volume_io(params = {}, = {}) req = build_request(:enable_volume_io, params) req.send_request() end |
#enable_vpc_classic_link(params = {}) ⇒ Types::EnableVpcClassicLinkResult
Enables a VPC for ClassicLink. You can then link EC2-Classic instances
to your ClassicLink-enabled VPC to allow communication over private IP
addresses. You cannot enable your VPC for ClassicLink if any of your
VPC route tables have existing routes for address ranges within the
10.0.0.0/8
IP address range, excluding local routes for VPCs in the
10.0.0.0/16
and 10.1.0.0/16
IP address ranges.
40748 40749 40750 40751 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40748 def enable_vpc_classic_link(params = {}, = {}) req = build_request(:enable_vpc_classic_link, params) req.send_request() end |
#enable_vpc_classic_link_dns_support(params = {}) ⇒ Types::EnableVpcClassicLinkDnsSupportResult
Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance.
You must specify a VPC ID in the request.
40787 40788 40789 40790 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40787 def enable_vpc_classic_link_dns_support(params = {}, = {}) req = build_request(:enable_vpc_classic_link_dns_support, params) req.send_request() end |
#export_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ExportClientVpnClientCertificateRevocationListResult
Downloads the client certificate revocation list for the specified Client VPN endpoint.
40826 40827 40828 40829 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40826 def export_client_vpn_client_certificate_revocation_list(params = {}, = {}) req = build_request(:export_client_vpn_client_certificate_revocation_list, params) req.send_request() end |
#export_client_vpn_client_configuration(params = {}) ⇒ Types::ExportClientVpnClientConfigurationResult
Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
40865 40866 40867 40868 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40865 def export_client_vpn_client_configuration(params = {}, = {}) req = build_request(:export_client_vpn_client_configuration, params) req.send_request() end |
#export_image(params = {}) ⇒ Types::ExportImageResult
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
40971 40972 40973 40974 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40971 def export_image(params = {}, = {}) req = build_request(:export_image, params) req.send_request() end |
#export_transit_gateway_routes(params = {}) ⇒ Types::ExportTransitGatewayRoutesResult
Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export route tables to Amazon S3 in the Amazon Web Services Transit Gateways Guide.
41056 41057 41058 41059 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41056 def export_transit_gateway_routes(params = {}, = {}) req = build_request(:export_transit_gateway_routes, params) req.send_request() end |
#get_associated_enclave_certificate_iam_roles(params = {}) ⇒ Types::GetAssociatedEnclaveCertificateIamRolesResult
Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that's used to encrypt the private key.
41100 41101 41102 41103 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41100 def get_associated_enclave_certificate_iam_roles(params = {}, = {}) req = build_request(:get_associated_enclave_certificate_iam_roles, params) req.send_request() end |
#get_associated_ipv_6_pool_cidrs(params = {}) ⇒ Types::GetAssociatedIpv6PoolCidrsResult
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41152 41153 41154 41155 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41152 def get_associated_ipv_6_pool_cidrs(params = {}, = {}) req = build_request(:get_associated_ipv_6_pool_cidrs, params) req.send_request() end |
#get_aws_network_performance_data(params = {}) ⇒ Types::GetAwsNetworkPerformanceDataResult
Gets network performance data.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41233 41234 41235 41236 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41233 def get_aws_network_performance_data(params = {}, = {}) req = build_request(:get_aws_network_performance_data, params) req.send_request() end |
#get_capacity_reservation_usage(params = {}) ⇒ Types::GetCapacityReservationUsageResult
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
41300 41301 41302 41303 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41300 def get_capacity_reservation_usage(params = {}, = {}) req = build_request(:get_capacity_reservation_usage, params) req.send_request() end |
#get_coip_pool_usage(params = {}) ⇒ Types::GetCoipPoolUsageResult
Describes the allocations from the specified customer-owned address pool.
41376 41377 41378 41379 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41376 def get_coip_pool_usage(params = {}, = {}) req = build_request(:get_coip_pool_usage, params) req.send_request() end |
#get_console_output(params = {}) ⇒ Types::GetConsoleOutputResult
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
41458 41459 41460 41461 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41458 def get_console_output(params = {}, = {}) req = build_request(:get_console_output, params) req.send_request() end |
#get_console_screenshot(params = {}) ⇒ Types::GetConsoleScreenshotResult
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
41510 41511 41512 41513 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41510 def get_console_screenshot(params = {}, = {}) req = build_request(:get_console_screenshot, params) req.send_request() end |
#get_default_credit_specification(params = {}) ⇒ Types::GetDefaultCreditSpecificationResult
Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
41554 41555 41556 41557 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41554 def get_default_credit_specification(params = {}, = {}) req = build_request(:get_default_credit_specification, params) req.send_request() end |
#get_ebs_default_kms_key_id(params = {}) ⇒ Types::GetEbsDefaultKmsKeyIdResult
Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
41595 41596 41597 41598 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41595 def get_ebs_default_kms_key_id(params = {}, = {}) req = build_request(:get_ebs_default_kms_key_id, params) req.send_request() end |
#get_ebs_encryption_by_default(params = {}) ⇒ Types::GetEbsEncryptionByDefaultResult
Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
41636 41637 41638 41639 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41636 def get_ebs_encryption_by_default(params = {}, = {}) req = build_request(:get_ebs_encryption_by_default, params) req.send_request() end |
#get_flow_logs_integration_template(params = {}) ⇒ Types::GetFlowLogsIntegrationTemplateResult
Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:
Create a table in Athena that maps fields to a custom log format
Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis
Create a table partitioned between two timestamps in the past
Create a set of named queries in Athena that you can use to get started quickly
GetFlowLogsIntegrationTemplate
does not support integration between
Amazon Web Services Transit Gateway Flow Logs and Amazon Athena.
41708 41709 41710 41711 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41708 def get_flow_logs_integration_template(params = {}, = {}) req = build_request(:get_flow_logs_integration_template, params) req.send_request() end |
#get_groups_for_capacity_reservation(params = {}) ⇒ Types::GetGroupsForCapacityReservationResult
Lists the resource groups to which a Capacity Reservation has been added.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41766 41767 41768 41769 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41766 def get_groups_for_capacity_reservation(params = {}, = {}) req = build_request(:get_groups_for_capacity_reservation, params) req.send_request() end |
#get_host_reservation_purchase_preview(params = {}) ⇒ Types::GetHostReservationPurchasePreviewResult
Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.
This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.
41819 41820 41821 41822 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41819 def get_host_reservation_purchase_preview(params = {}, = {}) req = build_request(:get_host_reservation_purchase_preview, params) req.send_request() end |
#get_image_block_public_access_state(params = {}) ⇒ Types::GetImageBlockPublicAccessStateResult
Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
41858 41859 41860 41861 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41858 def get_image_block_public_access_state(params = {}, = {}) req = build_request(:get_image_block_public_access_state, params) req.send_request() end |
#get_instance_metadata_defaults(params = {}) ⇒ Types::GetInstanceMetadataDefaultsResult
Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified Amazon Web Services Region.
For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
41900 41901 41902 41903 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41900 def (params = {}, = {}) req = build_request(:get_instance_metadata_defaults, params) req.send_request() end |
#get_instance_tpm_ek_pub(params = {}) ⇒ Types::GetInstanceTpmEkPubResult
Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
41953 41954 41955 41956 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41953 def get_instance_tpm_ek_pub(params = {}, = {}) req = build_request(:get_instance_tpm_ek_pub, params) req.send_request() end |
#get_instance_types_from_instance_requirements(params = {}) ⇒ Types::GetInstanceTypesFromInstanceRequirementsResult
Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.
When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.
For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42092 42093 42094 42095 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42092 def get_instance_types_from_instance_requirements(params = {}, = {}) req = build_request(:get_instance_types_from_instance_requirements, params) req.send_request() end |
#get_instance_uefi_data(params = {}) ⇒ Types::GetInstanceUefiDataResult
A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.
When you use register-image to create an AMI, you can create an
exact copy of your variable store by passing the UEFI data in the
UefiData
parameter. You can modify the UEFI data by using the
python-uefivars tool on GitHub. You can use the tool to convert
the UEFI data into a human-readable format (JSON), which you can
inspect and modify, and then convert back into the binary format to
use with register-image.
For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
42148 42149 42150 42151 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42148 def get_instance_uefi_data(params = {}, = {}) req = build_request(:get_instance_uefi_data, params) req.send_request() end |
#get_ipam_address_history(params = {}) ⇒ Types::GetIpamAddressHistoryResult
Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42234 42235 42236 42237 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42234 def get_ipam_address_history(params = {}, = {}) req = build_request(:get_ipam_address_history, params) req.send_request() end |
#get_ipam_discovered_accounts(params = {}) ⇒ Types::GetIpamDiscoveredAccountsResult
Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42307 42308 42309 42310 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42307 def get_ipam_discovered_accounts(params = {}, = {}) req = build_request(:get_ipam_discovered_accounts, params) req.send_request() end |
#get_ipam_discovered_public_addresses(params = {}) ⇒ Types::GetIpamDiscoveredPublicAddressesResult
Gets the public IP addresses that have been discovered by IPAM.
42391 42392 42393 42394 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42391 def get_ipam_discovered_public_addresses(params = {}, = {}) req = build_request(:get_ipam_discovered_public_addresses, params) req.send_request() end |
#get_ipam_discovered_resource_cidrs(params = {}) ⇒ Types::GetIpamDiscoveredResourceCidrsResult
Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42468 42469 42470 42471 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42468 def get_ipam_discovered_resource_cidrs(params = {}, = {}) req = build_request(:get_ipam_discovered_resource_cidrs, params) req.send_request() end |
#get_ipam_pool_allocations(params = {}) ⇒ Types::GetIpamPoolAllocationsResult
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42554 42555 42556 42557 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42554 def get_ipam_pool_allocations(params = {}, = {}) req = build_request(:get_ipam_pool_allocations, params) req.send_request() end |
#get_ipam_pool_cidrs(params = {}) ⇒ Types::GetIpamPoolCidrsResult
Get the CIDRs provisioned to an IPAM pool.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42621 42622 42623 42624 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42621 def get_ipam_pool_cidrs(params = {}, = {}) req = build_request(:get_ipam_pool_cidrs, params) req.send_request() end |
#get_ipam_resource_cidrs(params = {}) ⇒ Types::GetIpamResourceCidrsResult
Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42726 42727 42728 42729 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42726 def get_ipam_resource_cidrs(params = {}, = {}) req = build_request(:get_ipam_resource_cidrs, params) req.send_request() end |
#get_launch_template_data(params = {}) ⇒ Types::GetLaunchTemplateDataResult
Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
This action calls on other describe actions to get instance
information. Depending on your instance configuration, you may need to
allow the following actions in your IAM policy:
DescribeSpotInstanceRequests
,
DescribeInstanceCreditSpecifications
, DescribeVolumes
, and
DescribeInstanceAttribute
. Or, you can allow describe*
depending
on your instance requirements.
42980 42981 42982 42983 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42980 def get_launch_template_data(params = {}, = {}) req = build_request(:get_launch_template_data, params) req.send_request() end |
#get_managed_prefix_list_associations(params = {}) ⇒ Types::GetManagedPrefixListAssociationsResult
Gets information about the resources that are associated with the specified managed prefix list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
43032 43033 43034 43035 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43032 def get_managed_prefix_list_associations(params = {}, = {}) req = build_request(:get_managed_prefix_list_associations, params) req.send_request() end |
#get_managed_prefix_list_entries(params = {}) ⇒ Types::GetManagedPrefixListEntriesResult
Gets information about the entries for a specified managed prefix list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
43089 43090 43091 43092 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43089 def get_managed_prefix_list_entries(params = {}, = {}) req = build_request(:get_managed_prefix_list_entries, params) req.send_request() end |
#get_network_insights_access_scope_analysis_findings(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeAnalysisFindingsResult
Gets the findings for the specified Network Access Scope analysis.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
43466 43467 43468 43469 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43466 def get_network_insights_access_scope_analysis_findings(params = {}, = {}) req = build_request(:get_network_insights_access_scope_analysis_findings, params) req.send_request() end |
#get_network_insights_access_scope_content(params = {}) ⇒ Types::GetNetworkInsightsAccessScopeContentResult
Gets the content for the specified Network Access Scope.
43585 43586 43587 43588 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43585 def get_network_insights_access_scope_content(params = {}, = {}) req = build_request(:get_network_insights_access_scope_content, params) req.send_request() end |
#get_password_data(params = {}) ⇒ Types::GetPasswordDataResult
Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config
service
or EC2Launch
scripts (Windows Server 2016 and later). This usually
only happens the first time an instance is launched. For more
information, see EC2Config and EC2Launch in the Amazon EC2
User Guide.
For the EC2Config
service, the password is not generated for
rebundled AMIs unless Ec2SetPassword
is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- password_data_available
43654 43655 43656 43657 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43654 def get_password_data(params = {}, = {}) req = build_request(:get_password_data, params) req.send_request() end |
#get_reserved_instances_exchange_quote(params = {}) ⇒ Types::GetReservedInstancesExchangeQuoteResult
Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.
43732 43733 43734 43735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43732 def get_reserved_instances_exchange_quote(params = {}, = {}) req = build_request(:get_reserved_instances_exchange_quote, params) req.send_request() end |
#get_security_groups_for_vpc(params = {}) ⇒ Types::GetSecurityGroupsForVpcResult
Gets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
43817 43818 43819 43820 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43817 def get_security_groups_for_vpc(params = {}, = {}) req = build_request(:get_security_groups_for_vpc, params) req.send_request() end |
#get_serial_console_access_status(params = {}) ⇒ Types::GetSerialConsoleAccessStatusResult
Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.
43855 43856 43857 43858 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43855 def get_serial_console_access_status(params = {}, = {}) req = build_request(:get_serial_console_access_status, params) req.send_request() end |
#get_snapshot_block_public_access_state(params = {}) ⇒ Types::GetSnapshotBlockPublicAccessStateResult
Gets the current state of block public access for snapshots setting for the account and Region.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
43894 43895 43896 43897 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43894 def get_snapshot_block_public_access_state(params = {}, = {}) req = build_request(:get_snapshot_block_public_access_state, params) req.send_request() end |
#get_spot_placement_scores(params = {}) ⇒ Types::GetSpotPlacementScoresResult
Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.
You can specify your compute requirements either by using
InstanceRequirementsWithMetadata
and letting Amazon EC2 choose the
optimal instance types to fulfill your Spot request, or you can
specify the instance types by using InstanceTypes
.
For more information, see Spot placement score in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44058 44059 44060 44061 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44058 def get_spot_placement_scores(params = {}, = {}) req = build_request(:get_spot_placement_scores, params) req.send_request() end |
#get_subnet_cidr_reservations(params = {}) ⇒ Types::GetSubnetCidrReservationsResult
Gets information about the subnet CIDR reservations.
44149 44150 44151 44152 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44149 def get_subnet_cidr_reservations(params = {}, = {}) req = build_request(:get_subnet_cidr_reservations, params) req.send_request() end |
#get_transit_gateway_attachment_propagations(params = {}) ⇒ Types::GetTransitGatewayAttachmentPropagationsResult
Lists the route tables to which the specified resource attachment propagates routes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44215 44216 44217 44218 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44215 def (params = {}, = {}) req = build_request(:get_transit_gateway_attachment_propagations, params) req.send_request() end |
#get_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::GetTransitGatewayMulticastDomainAssociationsResult
Gets information about the associations for the transit gateway multicast domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44293 44294 44295 44296 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44293 def get_transit_gateway_multicast_domain_associations(params = {}, = {}) req = build_request(:get_transit_gateway_multicast_domain_associations, params) req.send_request() end |
#get_transit_gateway_policy_table_associations(params = {}) ⇒ Types::GetTransitGatewayPolicyTableAssociationsResult
Gets a list of the transit gateway policy table associations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44356 44357 44358 44359 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44356 def get_transit_gateway_policy_table_associations(params = {}, = {}) req = build_request(:get_transit_gateway_policy_table_associations, params) req.send_request() end |
#get_transit_gateway_policy_table_entries(params = {}) ⇒ Types::GetTransitGatewayPolicyTableEntriesResult
Returns a list of transit gateway policy table entries.
44419 44420 44421 44422 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44419 def get_transit_gateway_policy_table_entries(params = {}, = {}) req = build_request(:get_transit_gateway_policy_table_entries, params) req.send_request() end |
#get_transit_gateway_prefix_list_references(params = {}) ⇒ Types::GetTransitGatewayPrefixListReferencesResult
Gets information about the prefix list references in a specified transit gateway route table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44506 44507 44508 44509 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44506 def get_transit_gateway_prefix_list_references(params = {}, = {}) req = build_request(:get_transit_gateway_prefix_list_references, params) req.send_request() end |
#get_transit_gateway_route_table_associations(params = {}) ⇒ Types::GetTransitGatewayRouteTableAssociationsResult
Gets information about the associations for the specified transit gateway route table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44576 44577 44578 44579 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44576 def get_transit_gateway_route_table_associations(params = {}, = {}) req = build_request(:get_transit_gateway_route_table_associations, params) req.send_request() end |
#get_transit_gateway_route_table_propagations(params = {}) ⇒ Types::GetTransitGatewayRouteTablePropagationsResult
Gets information about the route table propagations for the specified transit gateway route table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44647 44648 44649 44650 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44647 def get_transit_gateway_route_table_propagations(params = {}, = {}) req = build_request(:get_transit_gateway_route_table_propagations, params) req.send_request() end |
#get_verified_access_endpoint_policy(params = {}) ⇒ Types::GetVerifiedAccessEndpointPolicyResult
Get the Verified Access policy associated with the endpoint.
44684 44685 44686 44687 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44684 def get_verified_access_endpoint_policy(params = {}, = {}) req = build_request(:get_verified_access_endpoint_policy, params) req.send_request() end |
#get_verified_access_group_policy(params = {}) ⇒ Types::GetVerifiedAccessGroupPolicyResult
Shows the contents of the Verified Access policy associated with the group.
44722 44723 44724 44725 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44722 def get_verified_access_group_policy(params = {}, = {}) req = build_request(:get_verified_access_group_policy, params) req.send_request() end |
#get_vpn_connection_device_sample_configuration(params = {}) ⇒ Types::GetVpnConnectionDeviceSampleConfigurationResult
Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
44770 44771 44772 44773 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44770 def get_vpn_connection_device_sample_configuration(params = {}, = {}) req = build_request(:get_vpn_connection_device_sample_configuration, params) req.send_request() end |
#get_vpn_connection_device_types(params = {}) ⇒ Types::GetVpnConnectionDeviceTypesResult
Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
44837 44838 44839 44840 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44837 def get_vpn_connection_device_types(params = {}, = {}) req = build_request(:get_vpn_connection_device_types, params) req.send_request() end |
#get_vpn_tunnel_replacement_status(params = {}) ⇒ Types::GetVpnTunnelReplacementStatusResult
Get details of available tunnel endpoint maintenance.
44888 44889 44890 44891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44888 def get_vpn_tunnel_replacement_status(params = {}, = {}) req = build_request(:get_vpn_tunnel_replacement_status, params) req.send_request() end |
#import_client_vpn_client_certificate_revocation_list(params = {}) ⇒ Types::ImportClientVpnClientCertificateRevocationListResult
Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.
Uploading a client certificate revocation list resets existing client connections.
44939 44940 44941 44942 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44939 def import_client_vpn_client_certificate_revocation_list(params = {}, = {}) req = build_request(:import_client_vpn_client_certificate_revocation_list, params) req.send_request() end |
#import_image(params = {}) ⇒ Types::ImportImageResult
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
Amazon Web Services VM Import/Export strongly recommends specifying a
value for either the --license-type
or --usage-operation
parameter
when you create a new VM Import task. This ensures your operating
system is licensed appropriately and your billing is optimized.
For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
45208 45209 45210 45211 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45208 def import_image(params = {}, = {}) req = build_request(:import_image, params) req.send_request() end |
#import_instance(params = {}) ⇒ Types::ImportInstanceResult
ImportImage
API. For more
information, see Importing a VM as an image using VM
Import/Export in the VM Import/Export User Guide.
Creates an import instance task using metadata from the specified disk image.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.
For information about the import manifest referenced by this API action, see VM Import Manifest.
45346 45347 45348 45349 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45346 def import_instance(params = {}, = {}) req = build_request(:import_instance, params) req.send_request() end |
#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult
Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.
For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.
45421 45422 45423 45424 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45421 def import_key_pair(params = {}, = {}) req = build_request(:import_key_pair, params) req.send_request() end |
#import_snapshot(params = {}) ⇒ Types::ImportSnapshotResult
Imports a disk into an EBS snapshot.
For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.
45574 45575 45576 45577 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45574 def import_snapshot(params = {}, = {}) req = build_request(:import_snapshot, params) req.send_request() end |
#import_volume(params = {}) ⇒ Types::ImportVolumeResult
Creates an import volume task using metadata from the specified disk image.
This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.
This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
For information about the import manifest referenced by this API action, see VM Import Manifest.
45675 45676 45677 45678 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45675 def import_volume(params = {}, = {}) req = build_request(:import_volume, params) req.send_request() end |
#list_images_in_recycle_bin(params = {}) ⇒ Types::ListImagesInRecycleBinResult
Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
45741 45742 45743 45744 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45741 def list_images_in_recycle_bin(params = {}, = {}) req = build_request(:list_images_in_recycle_bin, params) req.send_request() end |
#list_snapshots_in_recycle_bin(params = {}) ⇒ Types::ListSnapshotsInRecycleBinResult
Lists one or more snapshots that are currently in the Recycle Bin.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
45801 45802 45803 45804 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45801 def list_snapshots_in_recycle_bin(params = {}, = {}) req = build_request(:list_snapshots_in_recycle_bin, params) req.send_request() end |
#lock_snapshot(params = {}) ⇒ Types::LockSnapshotResult
Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted.
You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state:
If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date.
If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date.
45938 45939 45940 45941 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45938 def lock_snapshot(params = {}, = {}) req = build_request(:lock_snapshot, params) req.send_request() end |
#modify_address_attribute(params = {}) ⇒ Types::ModifyAddressAttributeResult
Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.
45987 45988 45989 45990 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45987 def modify_address_attribute(params = {}, = {}) req = build_request(:modify_address_attribute, params) req.send_request() end |
#modify_availability_zone_group(params = {}) ⇒ Types::ModifyAvailabilityZoneGroupResult
Changes the opt-in status of the specified zone group for your account.
46030 46031 46032 46033 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46030 def modify_availability_zone_group(params = {}, = {}) req = build_request(:modify_availability_zone_group, params) req.send_request() end |
#modify_capacity_reservation(params = {}) ⇒ Types::ModifyCapacityReservationResult
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
46115 46116 46117 46118 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46115 def modify_capacity_reservation(params = {}, = {}) req = build_request(:modify_capacity_reservation, params) req.send_request() end |
#modify_capacity_reservation_fleet(params = {}) ⇒ Types::ModifyCapacityReservationFleetResult
Modifies a Capacity Reservation Fleet.
When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.
46195 46196 46197 46198 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46195 def modify_capacity_reservation_fleet(params = {}, = {}) req = build_request(:modify_capacity_reservation_fleet, params) req.send_request() end |
#modify_client_vpn_endpoint(params = {}) ⇒ Types::ModifyClientVpnEndpointResult
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
46326 46327 46328 46329 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46326 def modify_client_vpn_endpoint(params = {}, = {}) req = build_request(:modify_client_vpn_endpoint, params) req.send_request() end |
#modify_default_credit_specification(params = {}) ⇒ Types::ModifyDefaultCreditSpecificationResult
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification
is an asynchronous operation, which
works at an Amazon Web Services Region level and modifies the credit
option for each Availability Zone. All zones in a Region are updated
within five minutes. But if instances are launched during this
operation, they might not get the new credit option until the zone is
updated. To verify whether the update has occurred, you can call
GetDefaultCreditSpecification
and check DefaultCreditSpecification
for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
46388 46389 46390 46391 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46388 def modify_default_credit_specification(params = {}, = {}) req = build_request(:modify_default_credit_specification, params) req.send_request() end |
#modify_ebs_default_kms_key_id(params = {}) ⇒ Types::ModifyEbsDefaultKmsKeyIdResult
Changes the default KMS key for EBS encryption by default for your account in this Region.
Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.
If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
46463 46464 46465 46466 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46463 def modify_ebs_default_kms_key_id(params = {}, = {}) req = build_request(:modify_ebs_default_kms_key_id, params) req.send_request() end |
#modify_fleet(params = {}) ⇒ Types::ModifyFleetResult
Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type maintain
.
While the EC2 Fleet is being modified, it is in the modifying
state.
To scale up your EC2 Fleet, increase its target capacity. The EC2
Fleet launches the additional Spot Instances according to the
allocation strategy for the EC2 Fleet request. If the allocation
strategy is lowest-price
, the EC2 Fleet launches instances using the
Spot Instance pool with the lowest price. If the allocation strategy
is diversified
, the EC2 Fleet distributes the instances across the
Spot Instance pools. If the allocation strategy is
capacity-optimized
, EC2 Fleet launches instances from Spot Instance
pools with optimal capacity for the number of instances that are
launching.
To scale down your EC2 Fleet, decrease its target capacity. First, the
EC2 Fleet cancels any open requests that exceed the new target
capacity. You can request that the EC2 Fleet terminate Spot Instances
until the size of the fleet no longer exceeds the new target capacity.
If the allocation strategy is lowest-price
, the EC2 Fleet terminates
the instances with the highest price per unit. If the allocation
strategy is capacity-optimized
, the EC2 Fleet terminates the
instances in the Spot Instance pools that have the least available
Spot Instance capacity. If the allocation strategy is diversified
,
the EC2 Fleet terminates instances across the Spot Instance pools.
Alternatively, you can request that the EC2 Fleet keep the fleet at
its current size, but not replace any Spot Instances that are
interrupted or that you terminate manually.
If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.
46639 46640 46641 46642 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46639 def modify_fleet(params = {}, = {}) req = build_request(:modify_fleet, params) req.send_request() end |
#modify_fpga_image_attribute(params = {}) ⇒ Types::ModifyFpgaImageAttributeResult
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
46732 46733 46734 46735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46732 def modify_fpga_image_attribute(params = {}, = {}) req = build_request(:modify_fpga_image_attribute, params) req.send_request() end |
#modify_hosts(params = {}) ⇒ Types::ModifyHostsResult
Modify the auto-placement setting of a Dedicated Host. When
auto-placement is enabled, any instances that you launch with a
tenancy of host
but without a specific host ID are placed onto any
available Dedicated Host in your account that has auto-placement
enabled. When auto-placement is disabled, you need to provide a host
ID to have the instance launch onto a specific host. If no host ID is
provided, the instance is launched onto a suitable host with
auto-placement enabled.
You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.
46823 46824 46825 46826 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46823 def modify_hosts(params = {}, = {}) req = build_request(:modify_hosts, params) req.send_request() end |
#modify_id_format(params = {}) ⇒ Struct
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for
resource types that are within the opt-in period. Resources currently
in their opt-in period include: bundle
| conversion-task
|
customer-gateway
| dhcp-options
| elastic-ip-allocation
|
elastic-ip-association
| export-task
| flow-log
| image
|
import-task
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
|
network-interface-attachment
| prefix-list
| route-table
|
route-table-association
| security-group
| subnet
|
subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and
users, regardless of these settings and provided that they have
permission to use the relevant Describe
command for the resource
type.
46894 46895 46896 46897 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46894 def modify_id_format(params = {}, = {}) req = build_request(:modify_id_format, params) req.send_request() end |
#modify_identity_id_format(params = {}) ⇒ Struct
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for
resource types that are within the opt-in period. Resources currently
in their opt-in period include: bundle
| conversion-task
|
customer-gateway
| dhcp-options
| elastic-ip-allocation
|
elastic-ip-association
| export-task
| flow-log
| image
|
import-task
| internet-gateway
| network-acl
|
network-acl-association
| network-interface
|
network-interface-attachment
| prefix-list
| route-table
|
route-table-association
| security-group
| subnet
|
subnet-cidr-block-association
| vpc
|
vpc-cidr-block-association
| vpc-endpoint
|
vpc-peering-connection
| vpn-connection
| vpn-gateway
.
For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.
Resources created with longer IDs are visible to all IAM roles and
users, regardless of these settings and provided that they have
permission to use the relevant Describe
command for the resource
type.
46970 46971 46972 46973 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46970 def modify_identity_id_format(params = {}, = {}) req = build_request(:modify_identity_id_format, params) req.send_request() end |
#modify_image_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use the Attribute
parameter, or
one of the following parameters: Description
, ImdsSupport
, or
LaunchPermission
.
Images with an Amazon Web Services Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
47133 47134 47135 47136 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47133 def modify_image_attribute(params = {}, = {}) req = build_request(:modify_image_attribute, params) req.send_request() end |
#modify_instance_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.
47368 47369 47370 47371 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47368 def modify_instance_attribute(params = {}, = {}) req = build_request(:modify_instance_attribute, params) req.send_request() end |
#modify_instance_capacity_reservation_attributes(params = {}) ⇒ Types::ModifyInstanceCapacityReservationAttributesResult
Modifies the Capacity Reservation settings for a stopped instance. Use
this action to configure an instance to target a specific Capacity
Reservation, run in any open
Capacity Reservation with matching
attributes, or run On-Demand Instance capacity.
47416 47417 47418 47419 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47416 def modify_instance_capacity_reservation_attributes(params = {}, = {}) req = build_request(:modify_instance_capacity_reservation_attributes, params) req.send_request() end |
#modify_instance_credit_specification(params = {}) ⇒ Types::ModifyInstanceCreditSpecificationResult
Modifies the credit option for CPU usage on a running or stopped
burstable performance instance. The credit options are standard
and
unlimited
.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
47481 47482 47483 47484 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47481 def modify_instance_credit_specification(params = {}, = {}) req = build_request(:modify_instance_credit_specification, params) req.send_request() end |
#modify_instance_event_start_time(params = {}) ⇒ Types::ModifyInstanceEventStartTimeResult
Modifies the start time for a scheduled Amazon EC2 instance event.
47529 47530 47531 47532 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47529 def modify_instance_event_start_time(params = {}, = {}) req = build_request(:modify_instance_event_start_time, params) req.send_request() end |
#modify_instance_event_window(params = {}) ⇒ Types::ModifyInstanceEventWindowResult
Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
47643 47644 47645 47646 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47643 def modify_instance_event_window(params = {}, = {}) req = build_request(:modify_instance_event_window, params) req.send_request() end |
#modify_instance_maintenance_options(params = {}) ⇒ Types::ModifyInstanceMaintenanceOptionsResult
Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
47693 47694 47695 47696 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47693 def (params = {}, = {}) req = build_request(:modify_instance_maintenance_options, params) req.send_request() end |
#modify_instance_metadata_defaults(params = {}) ⇒ Types::ModifyInstanceMetadataDefaultsResult
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
no-preference
. If an account-level setting is cleared with
no-preference
, then the instance launch considers the other instance
metadata settings. For more information, see Order of precedence for
instance metadata options in the Amazon EC2 User Guide.
47770 47771 47772 47773 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47770 def (params = {}, = {}) req = build_request(:modify_instance_metadata_defaults, params) req.send_request() end |
#modify_instance_metadata_options(params = {}) ⇒ Types::ModifyInstanceMetadataOptionsResult
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
47891 47892 47893 47894 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47891 def (params = {}, = {}) req = build_request(:modify_instance_metadata_options, params) req.send_request() end |
#modify_instance_placement(params = {}) ⇒ Types::ModifyInstancePlacementResult
Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to
host
and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an
instance, the instance must be in the stopped
state.
47994 47995 47996 47997 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47994 def modify_instance_placement(params = {}, = {}) req = build_request(:modify_instance_placement, params) req.send_request() end |
#modify_ipam(params = {}) ⇒ Types::ModifyIpamResult
Modify the configurations of an IPAM.
48087 48088 48089 48090 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48087 def modify_ipam(params = {}, = {}) req = build_request(:modify_ipam, params) req.send_request() end |
#modify_ipam_pool(params = {}) ⇒ Types::ModifyIpamPoolResult
Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
48227 48228 48229 48230 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48227 def modify_ipam_pool(params = {}, = {}) req = build_request(:modify_ipam_pool, params) req.send_request() end |
#modify_ipam_resource_cidr(params = {}) ⇒ Types::ModifyIpamResourceCidrResult
Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.
For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.
48313 48314 48315 48316 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48313 def modify_ipam_resource_cidr(params = {}, = {}) req = build_request(:modify_ipam_resource_cidr, params) req.send_request() end |
#modify_ipam_resource_discovery(params = {}) ⇒ Types::ModifyIpamResourceDiscoveryResult
Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
48384 48385 48386 48387 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48384 def modify_ipam_resource_discovery(params = {}, = {}) req = build_request(:modify_ipam_resource_discovery, params) req.send_request() end |
#modify_ipam_scope(params = {}) ⇒ Types::ModifyIpamScopeResult
Modify an IPAM scope.
48435 48436 48437 48438 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48435 def modify_ipam_scope(params = {}, = {}) req = build_request(:modify_ipam_scope, params) req.send_request() end |
#modify_launch_template(params = {}) ⇒ Types::ModifyLaunchTemplateResult
Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.
48530 48531 48532 48533 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48530 def modify_launch_template(params = {}, = {}) req = build_request(:modify_launch_template, params) req.send_request() end |
#modify_local_gateway_route(params = {}) ⇒ Types::ModifyLocalGatewayRouteResult
Modifies the specified local gateway route.
48594 48595 48596 48597 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48594 def modify_local_gateway_route(params = {}, = {}) req = build_request(:modify_local_gateway_route, params) req.send_request() end |
#modify_managed_prefix_list(params = {}) ⇒ Types::ModifyManagedPrefixListResult
Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
48683 48684 48685 48686 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48683 def modify_managed_prefix_list(params = {}, = {}) req = build_request(:modify_managed_prefix_list, params) req.send_request() end |
#modify_network_interface_attribute(params = {}) ⇒ Struct
Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
48834 48835 48836 48837 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48834 def modify_network_interface_attribute(params = {}, = {}) req = build_request(:modify_network_interface_attribute, params) req.send_request() end |
#modify_private_dns_name_options(params = {}) ⇒ Types::ModifyPrivateDnsNameOptionsResult
Modifies the options for instance hostnames for the specified instance.
48888 48889 48890 48891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48888 def (params = {}, = {}) req = build_request(:modify_private_dns_name_options, params) req.send_request() end |
#modify_reserved_instances(params = {}) ⇒ Types::ModifyReservedInstancesResult
Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.
48948 48949 48950 48951 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48948 def modify_reserved_instances(params = {}, = {}) req = build_request(:modify_reserved_instances, params) req.send_request() end |
#modify_security_group_rules(params = {}) ⇒ Types::ModifySecurityGroupRulesResult
Modifies the rules of a security group.
49001 49002 49003 49004 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49001 def modify_security_group_rules(params = {}, = {}) req = build_request(:modify_security_group_rules, params) req.send_request() end |
#modify_snapshot_attribute(params = {}) ⇒ Struct
Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.
Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
49116 49117 49118 49119 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49116 def modify_snapshot_attribute(params = {}, = {}) req = build_request(:modify_snapshot_attribute, params) req.send_request() end |
#modify_snapshot_tier(params = {}) ⇒ Types::ModifySnapshotTierResult
Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon EBS User Guide.
49166 49167 49168 49169 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49166 def modify_snapshot_tier(params = {}, = {}) req = build_request(:modify_snapshot_tier, params) req.send_request() end |
#modify_spot_fleet_request(params = {}) ⇒ Types::ModifySpotFleetRequestResponse
Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type maintain
.
While the Spot Fleet request is being modified, it is in the
modifying
state.
To scale up your Spot Fleet, increase its target capacity. The Spot
Fleet launches the additional Spot Instances according to the
allocation strategy for the Spot Fleet request. If the allocation
strategy is lowestPrice
, the Spot Fleet launches instances using the
Spot Instance pool with the lowest price. If the allocation strategy
is diversified
, the Spot Fleet distributes the instances across the
Spot Instance pools. If the allocation strategy is
capacityOptimized
, Spot Fleet launches instances from Spot Instance
pools with optimal capacity for the number of instances that are
launching.
To scale down your Spot Fleet, decrease its target capacity. First,
the Spot Fleet cancels any open requests that exceed the new target
capacity. You can request that the Spot Fleet terminate Spot Instances
until the size of the fleet no longer exceeds the new target capacity.
If the allocation strategy is lowestPrice
, the Spot Fleet terminates
the instances with the highest price per unit. If the allocation
strategy is capacityOptimized
, the Spot Fleet terminates the
instances in the Spot Instance pools that have the least available
Spot Instance capacity. If the allocation strategy is diversified
,
the Spot Fleet terminates instances across the Spot Instance pools.
Alternatively, you can request that the Spot Fleet keep the fleet at
its current size, but not replace any Spot Instances that are
interrupted or that you terminate manually.
If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.
49356 49357 49358 49359 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49356 def modify_spot_fleet_request(params = {}, = {}) req = build_request(:modify_spot_fleet_request, params) req.send_request() end |
#modify_subnet_attribute(params = {}) ⇒ Struct
Modifies a subnet attribute. You can only modify one attribute at a time.
Use this action to modify subnets on Amazon Web Services Outposts.
To modify a subnet on an Outpost rack, set both
MapCustomerOwnedIpOnLaunch
andCustomerOwnedIpv4Pool
. These two parameters act as a single attribute.To modify a subnet on an Outpost server, set either
EnableLniAtDeviceIndex
orDisableLniAtDeviceIndex
.
For more information about Amazon Web Services Outposts, see the following:
49505 49506 49507 49508 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49505 def modify_subnet_attribute(params = {}, = {}) req = build_request(:modify_subnet_attribute, params) req.send_request() end |
#modify_traffic_mirror_filter_network_services(params = {}) ⇒ Types::ModifyTrafficMirrorFilterNetworkServicesResult
Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic
Mirror. Use AddNetworkServices
to add network services to a Traffic
Mirror filter. When a network service is added to the Traffic Mirror
filter, all traffic related to that network service will be mirrored.
When you no longer want to mirror network services, use
RemoveNetworkServices
to remove the network services from the
Traffic Mirror filter.
49597 49598 49599 49600 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49597 def modify_traffic_mirror_filter_network_services(params = {}, = {}) req = build_request(:modify_traffic_mirror_filter_network_services, params) req.send_request() end |
#modify_traffic_mirror_filter_rule(params = {}) ⇒ Types::ModifyTrafficMirrorFilterRuleResult
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock
and SourceCidrBlock
must both be an IPv4
range or an IPv6 range.
49703 49704 49705 49706 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49703 def modify_traffic_mirror_filter_rule(params = {}, = {}) req = build_request(:modify_traffic_mirror_filter_rule, params) req.send_request() end |
#modify_traffic_mirror_session(params = {}) ⇒ Types::ModifyTrafficMirrorSessionResult
Modifies a Traffic Mirror session.
49796 49797 49798 49799 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49796 def modify_traffic_mirror_session(params = {}, = {}) req = build_request(:modify_traffic_mirror_session, params) req.send_request() end |
#modify_transit_gateway(params = {}) ⇒ Types::ModifyTransitGatewayResult
Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.
49874 49875 49876 49877 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49874 def modify_transit_gateway(params = {}, = {}) req = build_request(:modify_transit_gateway, params) req.send_request() end |
#modify_transit_gateway_prefix_list_reference(params = {}) ⇒ Types::ModifyTransitGatewayPrefixListReferenceResult
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
49929 49930 49931 49932 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49929 def modify_transit_gateway_prefix_list_reference(params = {}, = {}) req = build_request(:modify_transit_gateway_prefix_list_reference, params) req.send_request() end |
#modify_transit_gateway_vpc_attachment(params = {}) ⇒ Types::ModifyTransitGatewayVpcAttachmentResult
Modifies the specified VPC attachment.
49996 49997 49998 49999 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49996 def (params = {}, = {}) req = build_request(:modify_transit_gateway_vpc_attachment, params) req.send_request() end |
#modify_verified_access_endpoint(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointResult
Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
50098 50099 50100 50101 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50098 def modify_verified_access_endpoint(params = {}, = {}) req = build_request(:modify_verified_access_endpoint, params) req.send_request() end |
#modify_verified_access_endpoint_policy(params = {}) ⇒ Types::ModifyVerifiedAccessEndpointPolicyResult
Modifies the specified Amazon Web Services Verified Access endpoint policy.
50167 50168 50169 50170 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50167 def modify_verified_access_endpoint_policy(params = {}, = {}) req = build_request(:modify_verified_access_endpoint_policy, params) req.send_request() end |
#modify_verified_access_group(params = {}) ⇒ Types::ModifyVerifiedAccessGroupResult
Modifies the specified Amazon Web Services Verified Access group configuration.
50236 50237 50238 50239 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50236 def modify_verified_access_group(params = {}, = {}) req = build_request(:modify_verified_access_group, params) req.send_request() end |
#modify_verified_access_group_policy(params = {}) ⇒ Types::ModifyVerifiedAccessGroupPolicyResult
Modifies the specified Amazon Web Services Verified Access group policy.
50305 50306 50307 50308 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50305 def modify_verified_access_group_policy(params = {}, = {}) req = build_request(:modify_verified_access_group_policy, params) req.send_request() end |
#modify_verified_access_instance(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceResult
Modifies the configuration of the specified Amazon Web Services Verified Access instance.
50371 50372 50373 50374 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50371 def modify_verified_access_instance(params = {}, = {}) req = build_request(:modify_verified_access_instance, params) req.send_request() end |
#modify_verified_access_instance_logging_configuration(params = {}) ⇒ Types::ModifyVerifiedAccessInstanceLoggingConfigurationResult
Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
50457 50458 50459 50460 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50457 def modify_verified_access_instance_logging_configuration(params = {}, = {}) req = build_request(:modify_verified_access_instance_logging_configuration, params) req.send_request() end |
#modify_verified_access_trust_provider(params = {}) ⇒ Types::ModifyVerifiedAccessTrustProviderResult
Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
50558 50559 50560 50561 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50558 def modify_verified_access_trust_provider(params = {}, = {}) req = build_request(:modify_verified_access_trust_provider, params) req.send_request() end |
#modify_volume(params = {}) ⇒ Types::ModifyVolumeResult
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes in the Amazon EBS User Guide.
When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see Extend the file system.
For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure
that the volume is in the in-use
or available
state before you can
modify the same volume. This is sometimes referred to as a cooldown
period.
50714 50715 50716 50717 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50714 def modify_volume(params = {}, = {}) req = build_request(:modify_volume, params) req.send_request() end |
#modify_volume_attribute(params = {}) ⇒ Struct
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
50778 50779 50780 50781 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50778 def modify_volume_attribute(params = {}, = {}) req = build_request(:modify_volume_attribute, params) req.send_request() end |
#modify_vpc_attribute(params = {}) ⇒ Struct
Modifies the specified attribute of the specified VPC.
50859 50860 50861 50862 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50859 def modify_vpc_attribute(params = {}, = {}) req = build_request(:modify_vpc_attribute, params) req.send_request() end |
#modify_vpc_endpoint(params = {}) ⇒ Types::ModifyVpcEndpointResult
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.
50969 50970 50971 50972 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50969 def modify_vpc_endpoint(params = {}, = {}) req = build_request(:modify_vpc_endpoint, params) req.send_request() end |
#modify_vpc_endpoint_connection_notification(params = {}) ⇒ Types::ModifyVpcEndpointConnectionNotificationResult
Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.
51015 51016 51017 51018 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51015 def modify_vpc_endpoint_connection_notification(params = {}, = {}) req = build_request(:modify_vpc_endpoint_connection_notification, params) req.send_request() end |
#modify_vpc_endpoint_service_configuration(params = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult
Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
51100 51101 51102 51103 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51100 def modify_vpc_endpoint_service_configuration(params = {}, = {}) req = build_request(:modify_vpc_endpoint_service_configuration, params) req.send_request() end |
#modify_vpc_endpoint_service_payer_responsibility(params = {}) ⇒ Types::ModifyVpcEndpointServicePayerResponsibilityResult
Modifies the payer responsibility for your VPC endpoint service.
51141 51142 51143 51144 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51141 def modify_vpc_endpoint_service_payer_responsibility(params = {}, = {}) req = build_request(:modify_vpc_endpoint_service_payer_responsibility, params) req.send_request() end |
#modify_vpc_endpoint_service_permissions(params = {}) ⇒ Types::ModifyVpcEndpointServicePermissionsResult
Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.
If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
51200 51201 51202 51203 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51200 def (params = {}, = {}) req = build_request(:modify_vpc_endpoint_service_permissions, params) req.send_request() end |
#modify_vpc_peering_connection_options(params = {}) ⇒ Types::ModifyVpcPeeringConnectionOptionsResult
Modifies the VPC peering connection options on one side of a VPC peering connection.
If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
51272 51273 51274 51275 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51272 def (params = {}, = {}) req = build_request(:modify_vpc_peering_connection_options, params) req.send_request() end |
#modify_vpc_tenancy(params = {}) ⇒ Types::ModifyVpcTenancyResult
Modifies the instance tenancy attribute of the specified VPC. You can
change the instance tenancy attribute of a VPC to default
only. You
cannot change the instance tenancy attribute to dedicated
.
After you modify the tenancy of the VPC, any new instances that you
launch into the VPC have a tenancy of default
, unless you specify
otherwise during launch. The tenancy of any existing instances in the
VPC is not affected.
For more information, see Dedicated Instances in the Amazon EC2 User Guide.
51325 51326 51327 51328 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51325 def modify_vpc_tenancy(params = {}, = {}) req = build_request(:modify_vpc_tenancy, params) req.send_request() end |
#modify_vpn_connection(params = {}) ⇒ Types::ModifyVpnConnectionResult
Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the VPN endpoint's IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
51484 51485 51486 51487 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51484 def modify_vpn_connection(params = {}, = {}) req = build_request(:modify_vpn_connection, params) req.send_request() end |
#modify_vpn_connection_options(params = {}) ⇒ Types::ModifyVpnConnectionOptionsResult
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
51614 51615 51616 51617 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51614 def (params = {}, = {}) req = build_request(:modify_vpn_connection_options, params) req.send_request() end |
#modify_vpn_tunnel_certificate(params = {}) ⇒ Types::ModifyVpnTunnelCertificateResult
Modifies the VPN tunnel endpoint certificate.
51717 51718 51719 51720 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51717 def modify_vpn_tunnel_certificate(params = {}, = {}) req = build_request(:modify_vpn_tunnel_certificate, params) req.send_request() end |
#modify_vpn_tunnel_options(params = {}) ⇒ Types::ModifyVpnTunnelOptionsResult
Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
51895 51896 51897 51898 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51895 def (params = {}, = {}) req = build_request(:modify_vpn_tunnel_options, params) req.send_request() end |
#monitor_instances(params = {}) ⇒ Types::MonitorInstancesResult
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
51941 51942 51943 51944 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51941 def monitor_instances(params = {}, = {}) req = build_request(:monitor_instances, params) req.send_request() end |
#move_address_to_vpc(params = {}) ⇒ Types::MoveAddressToVpcResult
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
52003 52004 52005 52006 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52003 def move_address_to_vpc(params = {}, = {}) req = build_request(:move_address_to_vpc, params) req.send_request() end |
#move_byoip_cidr_to_ipam(params = {}) ⇒ Types::MoveByoipCidrToIpamResult
Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.
If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.
52065 52066 52067 52068 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52065 def move_byoip_cidr_to_ipam(params = {}, = {}) req = build_request(:move_byoip_cidr_to_ipam, params) req.send_request() end |
#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResult
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the
call returns immediately, but the address range is not ready to use
until its status changes from pending-provision
to provisioned
. To
monitor the status of an address range, use DescribeByoipCidrs. To
allocate an Elastic IP address from your IPv4 address pool, use
AllocateAddress with either the specific address from the address pool
or the ID of the address pool.
52199 52200 52201 52202 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52199 def provision_byoip_cidr(params = {}, = {}) req = build_request(:provision_byoip_cidr, params) req.send_request() end |
#provision_ipam_byoasn(params = {}) ⇒ Types::ProvisionIpamByoasnResult
Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
52256 52257 52258 52259 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52256 def provision_ipam_byoasn(params = {}, = {}) req = build_request(:provision_ipam_byoasn, params) req.send_request() end |
#provision_ipam_pool_cidr(params = {}) ⇒ Types::ProvisionIpamPoolCidrResult
Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.
For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.
52342 52343 52344 52345 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52342 def provision_ipam_pool_cidr(params = {}, = {}) req = build_request(:provision_ipam_pool_cidr, params) req.send_request() end |
#provision_public_ipv_4_pool_cidr(params = {}) ⇒ Types::ProvisionPublicIpv4PoolCidrResult
Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
52398 52399 52400 52401 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52398 def provision_public_ipv_4_pool_cidr(params = {}, = {}) req = build_request(:provision_public_ipv_4_pool_cidr, params) req.send_request() end |
#purchase_capacity_block(params = {}) ⇒ Types::PurchaseCapacityBlockResult
Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.
52481 52482 52483 52484 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52481 def purchase_capacity_block(params = {}, = {}) req = build_request(:purchase_capacity_block, params) req.send_request() end |
#purchase_host_reservation(params = {}) ⇒ Types::PurchaseHostReservationResult
Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.
52574 52575 52576 52577 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52574 def purchase_host_reservation(params = {}, = {}) req = build_request(:purchase_host_reservation, params) req.send_request() end |
#purchase_reserved_instances_offering(params = {}) ⇒ Types::PurchaseReservedInstancesOfferingResult
Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
52646 52647 52648 52649 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52646 def purchase_reserved_instances_offering(params = {}, = {}) req = build_request(:purchase_reserved_instances_offering, params) req.send_request() end |
#purchase_scheduled_instances(params = {}) ⇒ Types::PurchaseScheduledInstancesResult
Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
52732 52733 52734 52735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52732 def purchase_scheduled_instances(params = {}, = {}) req = build_request(:purchase_scheduled_instances, params) req.send_request() end |
#reboot_instances(params = {}) ⇒ Struct
Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
52789 52790 52791 52792 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52789 def reboot_instances(params = {}, = {}) req = build_request(:reboot_instances, params) req.send_request() end |
#register_image(params = {}) ⇒ Types::RegisterImageResult
Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage
to create an Amazon EBS-backed Linux AMI
from a snapshot of a root device volume. You specify the snapshot
using a block device mapping. You can't set the encryption state of
the volume using the block device mapping. If the snapshot is
encrypted, or encryption by default is enabled, the root volume of an
instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon EC2 User Guide.
53082 53083 53084 53085 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53082 def register_image(params = {}, = {}) req = build_request(:register_image, params) req.send_request() end |
#register_instance_event_notification_attributes(params = {}) ⇒ Types::RegisterInstanceEventNotificationAttributesResult
Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
53130 53131 53132 53133 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53130 def register_instance_event_notification_attributes(params = {}, = {}) req = build_request(:register_instance_event_notification_attributes, params) req.send_request() end |
#register_transit_gateway_multicast_group_members(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupMembersResult
Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
53190 53191 53192 53193 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53190 def register_transit_gateway_multicast_group_members(params = {}, = {}) req = build_request(:register_transit_gateway_multicast_group_members, params) req.send_request() end |
#register_transit_gateway_multicast_group_sources(params = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupSourcesResult
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
53251 53252 53253 53254 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53251 def register_transit_gateway_multicast_group_sources(params = {}, = {}) req = build_request(:register_transit_gateway_multicast_group_sources, params) req.send_request() end |
#reject_transit_gateway_multicast_domain_associations(params = {}) ⇒ Types::RejectTransitGatewayMulticastDomainAssociationsResult
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
53303 53304 53305 53306 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53303 def reject_transit_gateway_multicast_domain_associations(params = {}, = {}) req = build_request(:reject_transit_gateway_multicast_domain_associations, params) req.send_request() end |
#reject_transit_gateway_peering_attachment(params = {}) ⇒ Types::RejectTransitGatewayPeeringAttachmentResult
Rejects a transit gateway peering attachment request.
53355 53356 53357 53358 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53355 def (params = {}, = {}) req = build_request(:reject_transit_gateway_peering_attachment, params) req.send_request() end |
#reject_transit_gateway_vpc_attachment(params = {}) ⇒ Types::RejectTransitGatewayVpcAttachmentResult
Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance
state. Use
DescribeTransitGatewayVpcAttachments to view your pending VPC
attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a
VPC attachment request.
53409 53410 53411 53412 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53409 def (params = {}, = {}) req = build_request(:reject_transit_gateway_vpc_attachment, params) req.send_request() end |
#reject_vpc_endpoint_connections(params = {}) ⇒ Types::RejectVpcEndpointConnectionsResult
Rejects VPC endpoint connection requests to your VPC endpoint service.
53451 53452 53453 53454 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53451 def reject_vpc_endpoint_connections(params = {}, = {}) req = build_request(:reject_vpc_endpoint_connections, params) req.send_request() end |
#reject_vpc_peering_connection(params = {}) ⇒ Types::RejectVpcPeeringConnectionResult
Rejects a VPC peering connection request. The VPC peering connection
must be in the pending-acceptance
state. Use the
DescribeVpcPeeringConnections request to view your outstanding VPC
peering connection requests. To delete an active VPC peering
connection, or to delete a VPC peering connection request that you
initiated, use DeleteVpcPeeringConnection.
53491 53492 53493 53494 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53491 def reject_vpc_peering_connection(params = {}, = {}) req = build_request(:reject_vpc_peering_connection, params) req.send_request() end |
#release_address(params = {}) ⇒ Struct
Releases the specified Elastic IP address.
[Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.
[Nondefault VPC] You must use DisassociateAddress to disassociate
the Elastic IP address before you can release it. Otherwise, Amazon
EC2 returns an error (InvalidIPAddress.InUse
).
After releasing an Elastic IP address, it is released to the IP
address pool. Be sure to update your DNS records and any servers or
devices that communicate with the address. If you attempt to release
an Elastic IP address that you already released, you'll get an
AuthFailure
error if the address is already allocated to another
Amazon Web Services account.
After you release an Elastic IP address, you might be able to recover it. For more information, see AllocateAddress.
53560 53561 53562 53563 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53560 def release_address(params = {}, = {}) req = build_request(:release_address, params) req.send_request() end |
#release_hosts(params = {}) ⇒ Types::ReleaseHostsResult
When you no longer want to use an On-Demand Dedicated Host it can be
released. On-Demand billing is stopped and the host goes into
released
state. The host ID of Dedicated Hosts that have been
released can no longer be specified in another request, for example,
to modify the host. You must stop or terminate all instances on a host
before it can be released.
When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.
Released hosts still appear in a DescribeHosts response.
53606 53607 53608 53609 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53606 def release_hosts(params = {}, = {}) req = build_request(:release_hosts, params) req.send_request() end |
#release_ipam_pool_allocation(params = {}) ⇒ Types::ReleaseIpamPoolAllocationResult
Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.
53666 53667 53668 53669 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53666 def release_ipam_pool_allocation(params = {}, = {}) req = build_request(:release_ipam_pool_allocation, params) req.send_request() end |
#replace_iam_instance_profile_association(params = {}) ⇒ Types::ReplaceIamInstanceProfileAssociationResult
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.
Use DescribeIamInstanceProfileAssociations to get the association ID.
53711 53712 53713 53714 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53711 def replace_iam_instance_profile_association(params = {}, = {}) req = build_request(:replace_iam_instance_profile_association, params) req.send_request() end |
#replace_network_acl_association(params = {}) ⇒ Types::ReplaceNetworkAclAssociationResult
Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
This is an idempotent operation.
53775 53776 53777 53778 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53775 def replace_network_acl_association(params = {}, = {}) req = build_request(:replace_network_acl_association, params) req.send_request() end |
#replace_network_acl_entry(params = {}) ⇒ Struct
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.
53880 53881 53882 53883 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53880 def replace_network_acl_entry(params = {}, = {}) req = build_request(:replace_network_acl_entry, params) req.send_request() end |
#replace_route(params = {}) ⇒ Struct
Replaces an existing route within a route table in a VPC.
You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.
For more information, see Route tables in the Amazon VPC User Guide.
53998 53999 54000 54001 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53998 def replace_route(params = {}, = {}) req = build_request(:replace_route, params) req.send_request() end |
#replace_route_table_association(params = {}) ⇒ Types::ReplaceRouteTableAssociationResult
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon VPC User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
54067 54068 54069 54070 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54067 def replace_route_table_association(params = {}, = {}) req = build_request(:replace_route_table_association, params) req.send_request() end |
#replace_transit_gateway_route(params = {}) ⇒ Types::ReplaceTransitGatewayRouteResult
Replaces the specified route in the specified transit gateway route table.
54124 54125 54126 54127 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54124 def replace_transit_gateway_route(params = {}, = {}) req = build_request(:replace_transit_gateway_route, params) req.send_request() end |
#replace_vpn_tunnel(params = {}) ⇒ Types::ReplaceVpnTunnelResult
Trigger replacement of specified VPN tunnel.
54167 54168 54169 54170 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54167 def replace_vpn_tunnel(params = {}, = {}) req = build_request(:replace_vpn_tunnel, params) req.send_request() end |
#report_instance_status(params = {}) ⇒ Struct
Submits feedback about the status of an instance. The instance must be
in the running
state. If your experience with the instance differs
from the instance status returned by DescribeInstanceStatus, use
ReportInstanceStatus to report your experience with the instance.
Amazon EC2 collects this information to improve the accuracy of status
checks.
Use of this action does not change the value returned by DescribeInstanceStatus.
54249 54250 54251 54252 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54249 def report_instance_status(params = {}, = {}) req = build_request(:report_instance_status, params) req.send_request() end |
#request_spot_fleet(params = {}) ⇒ Types::RequestSpotFleetResponse
Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched
by the fleet. You cannot tag other resource types in a Spot Fleet
request because only the spot-fleet-request
and instance
resource
types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
54767 54768 54769 54770 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54767 def request_spot_fleet(params = {}, = {}) req = build_request(:request_spot_fleet, params) req.send_request() end |
#request_spot_instances(params = {}) ⇒ Types::RequestSpotInstancesResult
Creates a Spot Instance request.
For more information, see Work with Spot Instance in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
55167 55168 55169 55170 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55167 def request_spot_instances(params = {}, = {}) req = build_request(:request_spot_instances, params) req.send_request() end |
#reset_address_attribute(params = {}) ⇒ Types::ResetAddressAttributeResult
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.
55216 55217 55218 55219 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55216 def reset_address_attribute(params = {}, = {}) req = build_request(:reset_address_attribute, params) req.send_request() end |
#reset_ebs_default_kms_key_id(params = {}) ⇒ Types::ResetEbsDefaultKmsKeyIdResult
Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.
After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
55257 55258 55259 55260 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55257 def reset_ebs_default_kms_key_id(params = {}, = {}) req = build_request(:reset_ebs_default_kms_key_id, params) req.send_request() end |
#reset_fpga_image_attribute(params = {}) ⇒ Types::ResetFpgaImageAttributeResult
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
55298 55299 55300 55301 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55298 def reset_fpga_image_attribute(params = {}, = {}) req = build_request(:reset_fpga_image_attribute, params) req.send_request() end |
#reset_image_attribute(params = {}) ⇒ Struct
Resets an attribute of an AMI to its default value.
55346 55347 55348 55349 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55346 def reset_image_attribute(params = {}, = {}) req = build_request(:reset_image_attribute, params) req.send_request() end |
#reset_instance_attribute(params = {}) ⇒ Struct
Resets an attribute of an instance to its default value. To reset the
kernel
or ramdisk
, the instance must be in a stopped state. To
reset the sourceDestCheck
, the instance can be either running or
stopped.
The sourceDestCheck
attribute controls whether source/destination
checking is enabled. The default value is true
, which means checking
is enabled. This value must be false
for a NAT instance to perform
NAT. For more information, see NAT instances in the Amazon VPC
User Guide.
55409 55410 55411 55412 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55409 def reset_instance_attribute(params = {}, = {}) req = build_request(:reset_instance_attribute, params) req.send_request() end |
#reset_network_interface_attribute(params = {}) ⇒ Struct
Resets a network interface attribute. You can specify only one attribute at a time.
55443 55444 55445 55446 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55443 def reset_network_interface_attribute(params = {}, = {}) req = build_request(:reset_network_interface_attribute, params) req.send_request() end |
#reset_snapshot_attribute(params = {}) ⇒ Struct
Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.
55499 55500 55501 55502 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55499 def reset_snapshot_attribute(params = {}, = {}) req = build_request(:reset_snapshot_attribute, params) req.send_request() end |
#restore_address_to_classic(params = {}) ⇒ Types::RestoreAddressToClassicResult
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.
55544 55545 55546 55547 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55544 def restore_address_to_classic(params = {}, = {}) req = build_request(:restore_address_to_classic, params) req.send_request() end |
#restore_image_from_recycle_bin(params = {}) ⇒ Types::RestoreImageFromRecycleBinResult
Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
55584 55585 55586 55587 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55584 def restore_image_from_recycle_bin(params = {}, = {}) req = build_request(:restore_image_from_recycle_bin, params) req.send_request() end |
#restore_managed_prefix_list_version(params = {}) ⇒ Types::RestoreManagedPrefixListVersionResult
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
55639 55640 55641 55642 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55639 def restore_managed_prefix_list_version(params = {}, = {}) req = build_request(:restore_managed_prefix_list_version, params) req.send_request() end |
#restore_snapshot_from_recycle_bin(params = {}) ⇒ Types::RestoreSnapshotFromRecycleBinResult
Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon EBS User Guide.
55700 55701 55702 55703 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55700 def restore_snapshot_from_recycle_bin(params = {}, = {}) req = build_request(:restore_snapshot_from_recycle_bin, params) req.send_request() end |
#restore_snapshot_tier(params = {}) ⇒ Types::RestoreSnapshotTierResult
Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.
For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.
55767 55768 55769 55770 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55767 def restore_snapshot_tier(params = {}, = {}) req = build_request(:restore_snapshot_tier, params) req.send_request() end |
#revoke_client_vpn_ingress(params = {}) ⇒ Types::RevokeClientVpnIngressResult
Removes an ingress authorization rule from a Client VPN endpoint.
55817 55818 55819 55820 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55817 def revoke_client_vpn_ingress(params = {}, = {}) req = build_request(:revoke_client_vpn_ingress, params) req.send_request() end |
#revoke_security_group_egress(params = {}) ⇒ Types::RevokeSecurityGroupEgressResult
Removes the specified outbound (egress) rules from the specified security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
55966 55967 55968 55969 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55966 def revoke_security_group_egress(params = {}, = {}) req = build_request(:revoke_security_group_egress, params) req.send_request() end |
#revoke_security_group_ingress(params = {}) ⇒ Types::RevokeSecurityGroupIngressResult
Removes the specified inbound (ingress) rules from a security group.
You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.
For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.
For a non-default VPC, if the values you specify do not match the
existing rule's values, an InvalidPermission.NotFound
client error
is returned, and no rules are revoked.
Amazon Web Services recommends that you describe the security group to verify that the rules were removed.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
56135 56136 56137 56138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56135 def revoke_security_group_ingress(params = {}, = {}) req = build_request(:revoke_security_group_ingress, params) req.send_request() end |
#run_instances(params = {}) ⇒ Types::Reservation
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don't specify a security group ID, we use the default security group for the VPC. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
RunInstances
is subject to both request rate limiting and resource
rate limiting. For more information, see Request throttling.
An instance is ready for you to use when it's in the running
state.
You can check the state of your instance using DescribeInstances. You
can tag instances and EBS volumes during launch, after launch, or
both. For more information, see CreateTags and Tagging your Amazon
EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
56991 56992 56993 56994 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56991 def run_instances(params = {}, = {}) req = build_request(:run_instances, params) req.send_request() end |
#run_scheduled_instances(params = {}) ⇒ Types::RunScheduledInstancesResult
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes.
57121 57122 57123 57124 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57121 def run_scheduled_instances(params = {}, = {}) req = build_request(:run_scheduled_instances, params) req.send_request() end |
#search_local_gateway_routes(params = {}) ⇒ Types::SearchLocalGatewayRoutesResult
Searches for routes in the specified local gateway route table.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
57211 57212 57213 57214 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57211 def search_local_gateway_routes(params = {}, = {}) req = build_request(:search_local_gateway_routes, params) req.send_request() end |
#search_transit_gateway_multicast_groups(params = {}) ⇒ Types::SearchTransitGatewayMulticastGroupsResult
Searches one or more transit gateway multicast groups and returns the group membership information.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
57306 57307 57308 57309 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57306 def search_transit_gateway_multicast_groups(params = {}, = {}) req = build_request(:search_transit_gateway_multicast_groups, params) req.send_request() end |
#search_transit_gateway_routes(params = {}) ⇒ Types::SearchTransitGatewayRoutesResult
Searches for routes in the specified transit gateway route table.
57397 57398 57399 57400 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57397 def search_transit_gateway_routes(params = {}, = {}) req = build_request(:search_transit_gateway_routes, params) req.send_request() end |
#send_diagnostic_interrupt(params = {}) ⇒ Struct
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) in the Amazon EC2 User Guide.
57448 57449 57450 57451 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57448 def send_diagnostic_interrupt(params = {}, = {}) req = build_request(:send_diagnostic_interrupt, params) req.send_request() end |
#start_instances(params = {}) ⇒ Types::StartInstancesResult
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
If you attempt to start a T3 instance with host
tenancy and the
unlimited
CPU credit option, the request fails. The unlimited
CPU
credit option is not supported on Dedicated Hosts. Before you start
the instance, either change its CPU credit option to standard
, or
change its tenancy to default
or dedicated
.
For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
57549 57550 57551 57552 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57549 def start_instances(params = {}, = {}) req = build_request(:start_instances, params) req.send_request() end |
#start_network_insights_access_scope_analysis(params = {}) ⇒ Types::StartNetworkInsightsAccessScopeAnalysisResult
Starts analyzing the specified Network Access Scope.
57623 57624 57625 57626 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57623 def start_network_insights_access_scope_analysis(params = {}, = {}) req = build_request(:start_network_insights_access_scope_analysis, params) req.send_request() end |
#start_network_insights_analysis(params = {}) ⇒ Types::StartNetworkInsightsAnalysisResult
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
58538 58539 58540 58541 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58538 def start_network_insights_analysis(params = {}, = {}) req = build_request(:start_network_insights_analysis, params) req.send_request() end |
#start_vpc_endpoint_service_private_dns_verification(params = {}) ⇒ Types::StartVpcEndpointServicePrivateDnsVerificationResult
Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
58580 58581 58582 58583 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58580 def start_vpc_endpoint_service_private_dns_verification(params = {}, = {}) req = build_request(:start_vpc_endpoint_service_private_dns_verification, params) req.send_request() end |
#stop_instances(params = {}) ⇒ Types::StopInstancesResult
Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
58721 58722 58723 58724 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58721 def stop_instances(params = {}, = {}) req = build_request(:stop_instances, params) req.send_request() end |
#terminate_client_vpn_connections(params = {}) ⇒ Types::TerminateClientVpnConnectionsResult
Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
58777 58778 58779 58780 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58777 def terminate_client_vpn_connections(params = {}, = {}) req = build_request(:terminate_client_vpn_connections, params) req.send_request() end |
#terminate_instances(params = {}) ⇒ Types::TerminateInstancesResult
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A:
us-east-1a
; Not protectedInstance B:
us-east-1a
; Not protectedInstance C:
us-east-1b
; ProtectedInstance D:
us-east-1b
; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in
us-east-1a
are enabled for termination protection.Instance C and Instance D fail to terminate because at least one of the specified instances in
us-east-1b
(Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only
terminate instance store-backed instances. What happens to an instance
differs if you stop it or terminate it. For example, when you stop an
instance, the root device and any other devices attached to the
instance persist. When you terminate an instance, any attached EBS
volumes with the DeleteOnTermination
block device mapping parameter
set to true
are automatically deleted. For more information about
the differences between stopping and terminating instances, see
Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
58910 58911 58912 58913 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58910 def terminate_instances(params = {}, = {}) req = build_request(:terminate_instances, params) req.send_request() end |
#unassign_ipv_6_addresses(params = {}) ⇒ Types::UnassignIpv6AddressesResult
Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
58953 58954 58955 58956 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58953 def unassign_ipv_6_addresses(params = {}, = {}) req = build_request(:unassign_ipv_6_addresses, params) req.send_request() end |
#unassign_private_ip_addresses(params = {}) ⇒ Struct
Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.
58998 58999 59000 59001 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58998 def unassign_private_ip_addresses(params = {}, = {}) req = build_request(:unassign_private_ip_addresses, params) req.send_request() end |
#unassign_private_nat_gateway_address(params = {}) ⇒ Types::UnassignPrivateNatGatewayAddressResult
Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
59075 59076 59077 59078 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59075 def unassign_private_nat_gateway_address(params = {}, = {}) req = build_request(:unassign_private_nat_gateway_address, params) req.send_request() end |
#unlock_snapshot(params = {}) ⇒ Types::UnlockSnapshotResult
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.
59113 59114 59115 59116 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59113 def unlock_snapshot(params = {}, = {}) req = build_request(:unlock_snapshot, params) req.send_request() end |
#unmonitor_instances(params = {}) ⇒ Types::UnmonitorInstancesResult
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
59156 59157 59158 59159 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59156 def unmonitor_instances(params = {}, = {}) req = build_request(:unmonitor_instances, params) req.send_request() end |
#update_security_group_rule_descriptions_egress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsEgressResult
Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
59278 59279 59280 59281 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59278 def update_security_group_rule_descriptions_egress(params = {}, = {}) req = build_request(:update_security_group_rule_descriptions_egress, params) req.send_request() end |
#update_security_group_rule_descriptions_ingress(params = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsIngressResult
Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
59401 59402 59403 59404 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59401 def update_security_group_rule_descriptions_ingress(params = {}, = {}) req = build_request(:update_security_group_rule_descriptions_ingress, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
bundle_task_complete | #describe_bundle_tasks | 15 | 40 |
conversion_task_cancelled | #describe_conversion_tasks | 15 | 40 |
conversion_task_completed | #describe_conversion_tasks | 15 | 40 |
conversion_task_deleted | #describe_conversion_tasks | 15 | 40 |
customer_gateway_available | #describe_customer_gateways | 15 | 40 |
export_task_cancelled | #describe_export_tasks | 15 | 40 |
export_task_completed | #describe_export_tasks | 15 | 40 |
image_available | #describe_images | 15 | 40 |
image_exists | #describe_images | 15 | 40 |
instance_exists | #describe_instances | 5 | 40 |
instance_running | #describe_instances | 15 | 40 |
instance_status_ok | #describe_instance_status | 15 | 40 |
instance_stopped | #describe_instances | 15 | 40 |
instance_terminated | #describe_instances | 15 | 40 |
internet_gateway_exists | #describe_internet_gateways | 5 | 6 |
key_pair_exists | #describe_key_pairs | 5 | 6 |
nat_gateway_available | #describe_nat_gateways | 15 | 40 |
nat_gateway_deleted | #describe_nat_gateways | 15 | 40 |
network_interface_available | #describe_network_interfaces | 20 | 10 |
password_data_available | #get_password_data | 15 | 40 |
security_group_exists | #describe_security_groups | 5 | 6 |
snapshot_completed | #describe_snapshots | 15 | 40 |
snapshot_imported | #describe_import_snapshot_tasks | 15 | 40 |
spot_instance_request_fulfilled | #describe_spot_instance_requests | 15 | 40 |
store_image_task_complete | #describe_store_image_tasks | 5 | 40 |
subnet_available | #describe_subnets | 15 | 40 |
system_status_ok | #describe_instance_status | 15 | 40 |
volume_available | #describe_volumes | 15 | 40 |
volume_deleted | #describe_volumes | 15 | 40 |
volume_in_use | #describe_volumes | 15 | 40 |
vpc_available | #describe_vpcs | 15 | 40 |
vpc_exists | #describe_vpcs | 1 | 5 |
vpc_peering_connection_deleted | #describe_vpc_peering_connections | 15 | 40 |
vpc_peering_connection_exists | #describe_vpc_peering_connections | 15 | 40 |
vpn_connection_available | #describe_vpn_connections | 15 | 40 |
vpn_connection_deleted | #describe_vpn_connections | 15 | 40 |
59598 59599 59600 59601 59602 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59598 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#withdraw_byoip_cidr(params = {}) ⇒ Types::WithdrawByoipCidrResult
Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.
59453 59454 59455 59456 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59453 def withdraw_byoip_cidr(params = {}, = {}) req = build_request(:withdraw_byoip_cidr, params) req.send_request() end |