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_capacity_reservation_billing_ownership(params = {}) ⇒ Types::AcceptCapacityReservationBillingOwnershipResult
Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account.
-
#accept_reserved_instances_exchange_quote(params = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
-
#accept_transit_gateway_client_vpn_attachment(params = {}) ⇒ Types::AcceptTransitGatewayClientVpnAttachmentResult
Accepts a Transit Gateway attachment request for a Client VPN endpoint.
-
#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 the specified IPv6 addresses to the specified network interface.
-
#assign_private_ip_addresses(params = {}) ⇒ Types::AssignPrivateIpAddressesResult
Assigns the specified 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_application_status_check(params = {}) ⇒ Types::AssociateApplicationStatusCheckResult
Associates an application status check with instances or [tags][1].
-
#associate_capacity_reservation_billing_owner(params = {}) ⇒ Types::AssociateCapacityReservationBillingOwnerResult
Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account.
-
#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_kms_key_id(params = {}) ⇒ Types::AssociateKmsKeyIdResult
Associates an additional KMS key with an encrypted Amazon EBS snapshot.
-
#associate_nat_gateway_address(params = {}) ⇒ Types::AssociateNatGatewayAddressResult
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway.
-
#associate_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::AssociateNetworkingFlexCostAllocationPolicyResult
Associates a flex cost allocation policy with one or more network resources.
-
#associate_route_server(params = {}) ⇒ Types::AssociateRouteServerResult
Associates a route server with a VPC to enable dynamic route updates.
-
#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_security_group_vpc(params = {}) ⇒ Types::AssociateSecurityGroupVpcResult
Associates a security group with another VPC in the same Region.
-
#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_image_watermark(params = {}) ⇒ Types::AttachImageWatermarkResult
Attaches a watermark to a non-public AMI.
-
#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 Amazon EBS volume to a
runningorstoppedinstance, and exposes it to the instance with the specified device name. -
#attach_vpn_gateway(params = {}) ⇒ Types::AttachVpnGatewayResult
Attaches an available 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.
-
#batch_modify_ipam_routing_policy_registrations(params = {}) ⇒ Types::BatchModifyIpamRoutingPolicyRegistrationsResult
Modifies multiple routing policy registrations in a single operation.
-
#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_declarative_policies_report(params = {}) ⇒ Types::CancelDeclarativePoliciesReportResult
Cancels the generation of an account status report.
-
#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 an AMI copy operation.
-
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Creates an exact copy of an Amazon EBS snapshot.
-
#copy_volumes(params = {}) ⇒ Types::CopyVolumesResult
Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone.
-
#create_application_status_check(params = {}) ⇒ Types::CreateApplicationStatusCheckResult
Creates an application status check for monitoring the health of applications running on your instances.
-
#create_capacity_manager_data_export(params = {}) ⇒ Types::CreateCapacityManagerDataExportResult
Creates a new data export configuration for EC2 Capacity Manager.
-
#create_capacity_reservation(params = {}) ⇒ Types::CreateCapacityReservationResult
Creates a new Capacity Reservation with the specified attributes.
-
#create_capacity_reservation_by_splitting(params = {}) ⇒ Types::CreateCapacityReservationBySplittingResult
Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation.
-
#create_capacity_reservation_cancellation_quote(params = {}) ⇒ Types::CreateCapacityReservationCancellationQuoteResult
Generates a cancellation quote for a future-dated Capacity Reservation that is within its commitment duration.
-
#create_capacity_reservation_date_change_quote(params = {}) ⇒ Types::CreateCapacityReservationDateChangeQuoteResult
Generates a quote for changing the start date of a future-dated Capacity Reservation that has not yet been delivered.
-
#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
/20IPv4 CIDR block in the specified Availability Zone in your default VPC. -
#create_default_vpc(params = {}) ⇒ Types::CreateDefaultVpcResult
Creates a default VPC with a size
/16IPv4 CIDR block and a default subnet in each Availability Zone. -
#create_delegate_mac_volume_ownership_task(params = {}) ⇒ Types::CreateDelegateMacVolumeOwnershipTaskResult
Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.
-
#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_image_usage_report(params = {}) ⇒ Types::CreateImageUsageReportResult
Creates a report that shows how your image is used across other Amazon Web Services accounts.
-
#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_interruptible_capacity_reservation_allocation(params = {}) ⇒ Types::CreateInterruptibleCapacityReservationAllocationResult
Creates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation.
-
#create_ipam(params = {}) ⇒ Types::CreateIpamResult
Create an IPAM.
-
#create_ipam_external_resource_verification_token(params = {}) ⇒ Types::CreateIpamExternalResourceVerificationTokenResult
Create a verification token.
-
#create_ipam_internet_registry_association(params = {}) ⇒ Types::CreateIpamInternetRegistryAssociationResult
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management.
-
#create_ipam_policy(params = {}) ⇒ Types::CreateIpamPolicyResult
Creates an IPAM policy.
-
#create_ipam_pool(params = {}) ⇒ Types::CreateIpamPoolResult
Create an IP address pool for Amazon VPC IP Address Manager (IPAM).
-
#create_ipam_prefix_list_resolver(params = {}) ⇒ Types::CreateIpamPrefixListResolverResult
Creates an IPAM prefix list resolver.
-
#create_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::CreateIpamPrefixListResolverTargetResult
Creates an IPAM prefix list resolver target.
-
#create_ipam_resource_discovery(params = {}) ⇒ Types::CreateIpamResourceDiscoveryResult
Creates an IPAM resource discovery.
-
#create_ipam_routing_policy_registration(params = {}) ⇒ Types::CreateIpamRoutingPolicyRegistrationResult
Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
-
#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 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_local_gateway_virtual_interface(params = {}) ⇒ Types::CreateLocalGatewayVirtualInterfaceResult
Create a virtual interface for a local gateway.
-
#create_local_gateway_virtual_interface_group(params = {}) ⇒ Types::CreateLocalGatewayVirtualInterfaceGroupResult
Create a local gateway virtual interface group.
-
#create_mac_system_integrity_protection_modification_task(params = {}) ⇒ Types::CreateMacSystemIntegrityProtectionModificationTaskResult
Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance.
-
#create_managed_prefix_list(params = {}) ⇒ Types::CreateManagedPrefixListResult
Creates a managed prefix list.
-
#create_metric_category(params = {}) ⇒ Types::CreateMetricCategoryResult
Creates a metric category.
-
#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_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::CreateNetworkingFlexCostAllocationPolicyResult
Creates a flex cost allocation policy for Networking Flexible Cost Allocation (FCA), a feature of Amazon Virtual Private Cloud (Amazon VPC).
-
#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
runninginstance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, that is restored from an AMI that has the same key characteristics as that of the instance, or that is replaced by a specified volume. -
#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_server(params = {}) ⇒ Types::CreateRouteServerResult
Creates a new route server to manage dynamic routing in a VPC.
-
#create_route_server_endpoint(params = {}) ⇒ Types::CreateRouteServerEndpointResult
Creates a new endpoint for a route server in a specified subnet.
-
#create_route_server_peer(params = {}) ⇒ Types::CreateRouteServerPeerResult
Creates a new BGP peer for a specified route server endpoint.
-
#create_route_table(params = {}) ⇒ Types::CreateRouteTableResult
Creates a route table for the specified VPC.
-
#create_secondary_network(params = {}) ⇒ Types::CreateSecondaryNetworkResult
Creates a secondary network.
-
#create_secondary_subnet(params = {}) ⇒ Types::CreateSecondarySubnetResult
Creates a secondary subnet in a secondary network.
-
#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 attached to an Amazon EC2 instance.
-
#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_metering_policy(params = {}) ⇒ Types::CreateTransitGatewayMeteringPolicyResult
Creates a metering policy for a transit gateway to track and measure network traffic.
-
#create_transit_gateway_metering_policy_entry(params = {}) ⇒ Types::CreateTransitGatewayMeteringPolicyEntryResult
Creates an entry in a transit gateway metering policy to define traffic measurement rules.
-
#create_transit_gateway_multicast_domain(params = {}) ⇒ Types::CreateTransitGatewayMulticastDomainResult
Creates a multicast domain using the specified transit gateway.
-
#create_transit_gateway_network_function_attachment(params = {}) ⇒ Types::CreateTransitGatewayNetworkFunctionAttachmentResult
Creates a network function attachment that connects the specified transit gateway to a Gateway Load Balancer endpoint service.
-
#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_policy_table_entry(params = {}) ⇒ Types::CreateTransitGatewayPolicyTableEntryResult
Creates an entry in a transit gateway policy table to route matching traffic to a specified route 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_block_public_access_exclusion(params = {}) ⇒ Types::CreateVpcBlockPublicAccessExclusionResult
Create a VPC Block Public Access (BPA) exclusion.
-
#create_vpc_encryption_control(params = {}) ⇒ Types::CreateVpcEncryptionControlResult
Creates a VPC Encryption Control configuration for a specified VPC.
-
#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_concentrator(params = {}) ⇒ Types::CreateVpnConcentratorResult
Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.
-
#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_application_status_check(params = {}) ⇒ Types::DeleteApplicationStatusCheckResult
Deletes an application status check.
-
#delete_capacity_manager_data_export(params = {}) ⇒ Types::DeleteCapacityManagerDataExportResult
Deletes an existing Capacity Manager data export configuration.
-
#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_endpoint_authorization_policy(params = {}) ⇒ Types::DeleteClientVpnEndpointAuthorizationPolicyResult
Deletes the authorization policy for a 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 Fleet request.
-
#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_image_usage_report(params = {}) ⇒ Types::DeleteImageUsageReportResult
Deletes the specified image usage report.
-
#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_external_resource_verification_token(params = {}) ⇒ Types::DeleteIpamExternalResourceVerificationTokenResult
Delete a verification token.
-
#delete_ipam_internet_registry_association(params = {}) ⇒ Types::DeleteIpamInternetRegistryAssociationResult
Deletes an IPAM internet registry association.
-
#delete_ipam_policy(params = {}) ⇒ Types::DeleteIpamPolicyResult
Deletes an IPAM policy.
-
#delete_ipam_pool(params = {}) ⇒ Types::DeleteIpamPoolResult
Delete an IPAM pool.
-
#delete_ipam_prefix_list_resolver(params = {}) ⇒ Types::DeleteIpamPrefixListResolverResult
Deletes an IPAM prefix list resolver.
-
#delete_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::DeleteIpamPrefixListResolverTargetResult
Deletes an IPAM prefix list resolver target.
-
#delete_ipam_resource_discovery(params = {}) ⇒ Types::DeleteIpamResourceDiscoveryResult
Deletes an IPAM resource discovery.
-
#delete_ipam_routing_policy_registration(params = {}) ⇒ Types::DeleteIpamRoutingPolicyRegistrationResult
Deletes a routing policy registration for a specified CIDR prefix.
-
#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_local_gateway_virtual_interface(params = {}) ⇒ Types::DeleteLocalGatewayVirtualInterfaceResult
Deletes the specified local gateway virtual interface.
-
#delete_local_gateway_virtual_interface_group(params = {}) ⇒ Types::DeleteLocalGatewayVirtualInterfaceGroupResult
Delete the specified local gateway interface group.
-
#delete_managed_prefix_list(params = {}) ⇒ Types::DeleteManagedPrefixListResult
Deletes the specified managed prefix list.
-
#delete_metric_category(params = {}) ⇒ Types::DeleteMetricCategoryResult
Deletes the specified metric category.
-
#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_networking_flex_cost_allocation_policies(params = {}) ⇒ Types::DeleteNetworkingFlexCostAllocationPoliciesResult
Deletes one or more flex cost allocation policies.
-
#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_server(params = {}) ⇒ Types::DeleteRouteServerResult
Deletes the specified route server.
-
#delete_route_server_endpoint(params = {}) ⇒ Types::DeleteRouteServerEndpointResult
Deletes the specified route server endpoint.
-
#delete_route_server_peer(params = {}) ⇒ Types::DeleteRouteServerPeerResult
Deletes the specified BGP peer from a route server.
-
#delete_route_table(params = {}) ⇒ Struct
Deletes the specified route table.
-
#delete_secondary_network(params = {}) ⇒ Types::DeleteSecondaryNetworkResult
Deletes a secondary network.
-
#delete_secondary_subnet(params = {}) ⇒ Types::DeleteSecondarySubnetResult
Deletes a secondary subnet.
-
#delete_security_group(params = {}) ⇒ Types::DeleteSecurityGroupResult
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_client_vpn_attachment(params = {}) ⇒ Types::DeleteTransitGatewayClientVpnAttachmentResult
Deletes a Transit Gateway attachment for a Client VPN endpoint.
-
#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_metering_policy(params = {}) ⇒ Types::DeleteTransitGatewayMeteringPolicyResult
Deletes a transit gateway metering policy.
-
#delete_transit_gateway_metering_policy_entry(params = {}) ⇒ Types::DeleteTransitGatewayMeteringPolicyEntryResult
Deletes an entry from a transit gateway metering policy.
-
#delete_transit_gateway_multicast_domain(params = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult
Deletes the specified transit gateway multicast domain.
-
#delete_transit_gateway_network_function_attachment(params = {}) ⇒ Types::DeleteTransitGatewayNetworkFunctionAttachmentResult
Deletes the specified network function attachment.
-
#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_policy_table_entry(params = {}) ⇒ Types::DeleteTransitGatewayPolicyTableEntryResult
Deletes the specified transit gateway policy table entry.
-
#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_block_public_access_exclusion(params = {}) ⇒ Types::DeleteVpcBlockPublicAccessExclusionResult
Delete a VPC Block Public Access (BPA) exclusion.
-
#delete_vpc_encryption_control(params = {}) ⇒ Types::DeleteVpcEncryptionControlResult
Deletes a VPC Encryption Control configuration.
-
#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_concentrator(params = {}) ⇒ Types::DeleteVpnConcentratorResult
Deletes the specified VPN concentrator.
-
#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 = {}) ⇒ Types::DeregisterImageResult
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_account_vpc_encryption_control(params = {}) ⇒ Types::DescribeAccountVpcEncryptionControlResult
Describes the account-level VPC Encryption Control configuration for your 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_application_status(params = {}) ⇒ Types::DescribeApplicationStatusResult
Describes the aggregated application health status for the specified instances.
-
#describe_application_status_check_associations(params = {}) ⇒ Types::DescribeApplicationStatusCheckAssociationsResult
Describes the associations for one or more application status checks.
-
#describe_application_status_checks(params = {}) ⇒ Types::DescribeApplicationStatusChecksResult
Describes application status checks, including configuration details such as protocol, port, path, thresholds, and associations.
-
#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 provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).
-
#describe_capacity_block_extension_history(params = {}) ⇒ Types::DescribeCapacityBlockExtensionHistoryResult
Describes the events for the specified Capacity Block extension during the specified time.
-
#describe_capacity_block_extension_offerings(params = {}) ⇒ Types::DescribeCapacityBlockExtensionOfferingsResult
Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.
-
#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_block_status(params = {}) ⇒ Types::DescribeCapacityBlockStatusResult
Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.
-
#describe_capacity_blocks(params = {}) ⇒ Types::DescribeCapacityBlocksResult
Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.
-
#describe_capacity_manager_data_exports(params = {}) ⇒ Types::DescribeCapacityManagerDataExportsResult
Describes one or more Capacity Manager data export configurations.
-
#describe_capacity_reservation_billing_requests(params = {}) ⇒ Types::DescribeCapacityReservationBillingRequestsResult
Describes a request to assign the billing of the unused capacity of a Capacity Reservation.
-
#describe_capacity_reservation_cancellation_quotes(params = {}) ⇒ Types::DescribeCapacityReservationCancellationQuotesResult
Describes one or more Capacity Reservation cancellation quotes.
-
#describe_capacity_reservation_date_change_quotes(params = {}) ⇒ Types::DescribeCapacityReservationDateChangeQuotesResult
Describes one or more Capacity Reservation date change quotes that you generated by using the
CreateCapacityReservationDateChangeQuoteoperation. -
#describe_capacity_reservation_fleets(params = {}) ⇒ Types::DescribeCapacityReservationFleetsResult
Describes one or more Capacity Reservation Fleets.
-
#describe_capacity_reservation_topology(params = {}) ⇒ Types::DescribeCapacityReservationTopologyResult
Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone.
-
#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_declarative_policies_reports(params = {}) ⇒ Types::DescribeDeclarativePoliciesReportsResult
Describes the metadata of an account status report, including the status of the report.
-
#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_image_references(params = {}) ⇒ Types::DescribeImageReferencesResult
Describes your Amazon Web Services resources that are referencing the specified images.
-
#describe_image_usage_report_entries(params = {}) ⇒ Types::DescribeImageUsageReportEntriesResult
Describes the entries in image usage reports, showing how your images are used across other Amazon Web Services accounts.
-
#describe_image_usage_reports(params = {}) ⇒ Types::DescribeImageUsageReportsResult
Describes the configuration and status of image usage reports, filtered by report IDs or image IDs.
-
#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_image_metadata(params = {}) ⇒ Types::DescribeInstanceImageMetadataResult
Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.
-
#describe_instance_sql_ha_history_states(params = {}) ⇒ Types::DescribeInstanceSqlHaHistoryStatesResult
Describes the historical SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.
-
#describe_instance_sql_ha_states(params = {}) ⇒ Types::DescribeInstanceSqlHaStatesResult
Describes the SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.
-
#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_external_resource_verification_tokens(params = {}) ⇒ Types::DescribeIpamExternalResourceVerificationTokensResult
Describe verification tokens.
-
#describe_ipam_internet_registry_associations(params = {}) ⇒ Types::DescribeIpamInternetRegistryAssociationsResult
Describes one or more IPAM internet registry associations.
-
#describe_ipam_policies(params = {}) ⇒ Types::DescribeIpamPoliciesResult
Describes one or more IPAM policies.
-
#describe_ipam_pool_allocations(params = {}) ⇒ Types::DescribeIpamPoolAllocationsResult
Describes IPAM pool allocations.
-
#describe_ipam_pools(params = {}) ⇒ Types::DescribeIpamPoolsResult
Get information about your IPAM pools.
-
#describe_ipam_prefix_list_resolver_targets(params = {}) ⇒ Types::DescribeIpamPrefixListResolverTargetsResult
Describes one or more IPAM prefix list resolver Targets.
-
#describe_ipam_prefix_list_resolvers(params = {}) ⇒ Types::DescribeIpamPrefixListResolversResult
Describes one or more IPAM prefix list resolvers.
-
#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_mac_modification_tasks(params = {}) ⇒ Types::DescribeMacModificationTasksResult
Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance.
-
#describe_managed_prefix_lists(params = {}) ⇒ Types::DescribeManagedPrefixListsResult
Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
-
#describe_metric_categories(params = {}) ⇒ Types::DescribeMetricCategoriesResult
Describes the specified metric categories, or all of your metric categories.
-
#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 the specified network interfaces or all your network interfaces.
-
#describe_networking_flex_cost_allocation_policies(params = {}) ⇒ Types::DescribeNetworkingFlexCostAllocationPoliciesResult
Describes one or more of your flex cost allocation policies.
-
#describe_networking_flex_cost_allocation_policy_associations(params = {}) ⇒ Types::DescribeNetworkingFlexCostAllocationPolicyAssociationsResult
Describes the associations between your flex cost allocation policies and network resources.
-
#describe_outpost_lags(params = {}) ⇒ Types::DescribeOutpostLagsResult
Describes the Outposts link aggregation groups (LAGs).
-
#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_server_endpoints(params = {}) ⇒ Types::DescribeRouteServerEndpointsResult
Describes one or more route server endpoints.
-
#describe_route_server_peers(params = {}) ⇒ Types::DescribeRouteServerPeersResult
Describes one or more route server peers.
-
#describe_route_servers(params = {}) ⇒ Types::DescribeRouteServersResult
Describes one or more route servers.
-
#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_secondary_interfaces(params = {}) ⇒ Types::DescribeSecondaryInterfacesResult
Describes one or more of your secondary interfaces.
-
#describe_secondary_networks(params = {}) ⇒ Types::DescribeSecondaryNetworksResult
Describes one or more secondary networks.
-
#describe_secondary_subnets(params = {}) ⇒ Types::DescribeSecondarySubnetsResult
Describes one or more of your secondary subnets.
-
#describe_security_group_references(params = {}) ⇒ Types::DescribeSecurityGroupReferencesResult
Describes the VPCs on the other side of a VPC peering or Transit Gateway 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_group_vpc_associations(params = {}) ⇒ Types::DescribeSecurityGroupVpcAssociationsResult
Describes security group VPC associations made with [AssociateSecurityGroupVpc][1].
-
#describe_security_groups(params = {}) ⇒ Types::DescribeSecurityGroupsResult
Describes the specified security groups or all of your security groups.
-
#describe_service_link_virtual_interfaces(params = {}) ⇒ Types::DescribeServiceLinkVirtualInterfacesResult
Describes the Outpost service link virtual interfaces.
-
#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 referenced across a VPC peering connection, transit gateway connection, or with a security group VPC association.
-
#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_metering_policies(params = {}) ⇒ Types::DescribeTransitGatewayMeteringPoliciesResult
Describes one or more transit gateway metering policies.
-
#describe_transit_gateway_multicast_domains(params = {}) ⇒ Types::DescribeTransitGatewayMulticastDomainsResult
Describes one or more transit gateway multicast domains.
-
#describe_transit_gateway_network_function_attachments(params = {}) ⇒ Types::DescribeTransitGatewayNetworkFunctionAttachmentsResult
Describes one or more network function attachments.
-
#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_block_public_access_exclusions(params = {}) ⇒ Types::DescribeVpcBlockPublicAccessExclusionsResult
Describe VPC Block Public Access (BPA) exclusions.
-
#describe_vpc_block_public_access_options(params = {}) ⇒ Types::DescribeVpcBlockPublicAccessOptionsResult
Describe VPC Block Public Access (BPA) options.
-
#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_encryption_controls(params = {}) ⇒ Types::DescribeVpcEncryptionControlsResult
Describes one or more VPC Encryption Control configurations.
-
#describe_vpc_endpoint_associations(params = {}) ⇒ Types::DescribeVpcEndpointAssociationsResult
Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.
-
#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_concentrators(params = {}) ⇒ Types::DescribeVpnConcentratorsResult
Describes one or more of your VPN concentrators.
-
#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_image_watermark(params = {}) ⇒ Types::DetachImageWatermarkResult
Removes a watermark from the specified AMI.
-
#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_allowed_images_settings(params = {}) ⇒ Types::DisableAllowedImagesSettingsResult
Disables Allowed AMIs for your account in the specified Amazon Web Services Region.
-
#disable_application_status_check_suppression(params = {}) ⇒ Types::DisableApplicationStatusCheckSuppressionResult
Disables suppression of application status checks for the specified instances.
-
#disable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::DisableAwsNetworkPerformanceMetricSubscriptionResult
Disables Infrastructure Performance metric subscriptions.
-
#disable_capacity_manager(params = {}) ⇒ Types::DisableCapacityManagerResult
Disables EC2 Capacity Manager for your account.
-
#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
disabledand 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_instance_sql_ha_standby_detections(params = {}) ⇒ Types::DisableInstanceSqlHaStandbyDetectionsResult
Disable Amazon EC2 instances running in an SQL Server High Availability cluster from SQL Server High Availability instance standby detection monitoring.
-
#disable_ipam_organization_admin_account(params = {}) ⇒ Types::DisableIpamOrganizationAdminAccountResult
Disable the IPAM account.
-
#disable_ipam_policy(params = {}) ⇒ Types::DisableIpamPolicyResult
Disables an IPAM policy.
-
#disable_route_server_propagation(params = {}) ⇒ Types::DisableRouteServerPropagationResult
Disables route propagation from a route server to a specified route table.
-
#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_application_status_check(params = {}) ⇒ Types::DisassociateApplicationStatusCheckResult
Disassociates an application status check from instances or [tags][1].
-
#disassociate_capacity_reservation_billing_owner(params = {}) ⇒ Types::DisassociateCapacityReservationBillingOwnerResult
Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted.
-
#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_kms_key_id(params = {}) ⇒ Types::DisassociateKmsKeyIdResult
Removes an associated KMS key from an Amazon EBS snapshot.
-
#disassociate_nat_gateway_address(params = {}) ⇒ Types::DisassociateNatGatewayAddressResult
Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway.
-
#disassociate_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::DisassociateNetworkingFlexCostAllocationPolicyResult
Disassociates a flex cost allocation policy from one or more network resources.
-
#disassociate_route_server(params = {}) ⇒ Types::DisassociateRouteServerResult
Disassociates a route server from a VPC.
-
#disassociate_route_table(params = {}) ⇒ Struct
Disassociates a subnet or gateway from a route table.
-
#disassociate_security_group_vpc(params = {}) ⇒ Types::DisassociateSecurityGroupVpcResult
Disassociates a security group from a VPC.
-
#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_allowed_images_settings(params = {}) ⇒ Types::EnableAllowedImagesSettingsResult
Enables Allowed AMIs for your account in the specified Amazon Web Services Region.
-
#enable_application_status_check_suppression(params = {}) ⇒ Types::EnableApplicationStatusCheckSuppressionResult
Suppresses application status checks for the specified instances.
-
#enable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::EnableAwsNetworkPerformanceMetricSubscriptionResult
Enables Infrastructure Performance subscriptions.
-
#enable_capacity_manager(params = {}) ⇒ Types::EnableCapacityManagerResult
Enables EC2 Capacity Manager for your account.
-
#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_instance_sql_ha_standby_detections(params = {}) ⇒ Types::EnableInstanceSqlHaStandbyDetectionsResult
Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring.
-
#enable_ipam_internet_registry_association(params = {}) ⇒ Types::EnableIpamInternetRegistryAssociationResult
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details.
-
#enable_ipam_organization_admin_account(params = {}) ⇒ Types::EnableIpamOrganizationAdminAccountResult
Enable an Organizations member account as the IPAM admin account.
-
#enable_ipam_policy(params = {}) ⇒ Types::EnableIpamPolicyResult
Enables an IPAM policy.
-
#enable_reachability_analyzer_organization_sharing(params = {}) ⇒ Types::EnableReachabilityAnalyzerOrganizationSharingResult
Establishes a trust relationship between Reachability Analyzer and Organizations.
-
#enable_route_server_propagation(params = {}) ⇒ Types::EnableRouteServerPropagationResult
Defines which route tables the route server can update with routes.
-
#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.
-
#export_verified_access_instance_client_configuration(params = {}) ⇒ Types::ExportVerifiedAccessInstanceClientConfigurationResult
Exports the client configuration for a Verified Access instance.
-
#get_active_vpn_tunnel_status(params = {}) ⇒ Types::GetActiveVpnTunnelStatusResult
Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.
-
#get_allowed_images_settings(params = {}) ⇒ Types::GetAllowedImagesSettingsResult
Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region.
-
#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_manager_attributes(params = {}) ⇒ Types::GetCapacityManagerAttributesResult
Retrieves the current configuration and status of EC2 Capacity Manager for your account, including enablement status, Organizations access settings, and data ingestion status.
-
#get_capacity_manager_metric_data(params = {}) ⇒ Types::GetCapacityManagerMetricDataResult
Retrieves capacity usage metrics for your EC2 resources.
-
#get_capacity_manager_metric_dimensions(params = {}) ⇒ Types::GetCapacityManagerMetricDimensionsResult
Retrieves the available dimension values for capacity metrics within a specified time range.
-
#get_capacity_manager_monitored_tag_keys(params = {}) ⇒ Types::GetCapacityManagerMonitoredTagKeysResult
Retrieves the tag keys that are currently being monitored by EC2 Capacity Manager.
-
#get_capacity_manager_supportability_scores(params = {}) ⇒ Types::GetCapacityManagerSupportabilityScoresResult
Scores how well each instance type and Availability Zone combination can support a capacity request, based on current Amazon EC2 capacity.
-
#get_capacity_reservation_usage(params = {}) ⇒ Types::GetCapacityReservationUsageResult
Gets usage information about a Capacity Reservation.
-
#get_client_vpn_endpoint_authorization_policy(params = {}) ⇒ Types::GetClientVpnEndpointAuthorizationPolicyResult
Describes the authorization policy for a Client VPN endpoint.
-
#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_declarative_policies_report_summary(params = {}) ⇒ Types::GetDeclarativePoliciesReportSummaryResult
Retrieves a summary of the account status report.
-
#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_enabled_ipam_policy(params = {}) ⇒ Types::GetEnabledIpamPolicyResult
Gets the enabled IPAM policy.
-
#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_ancestry(params = {}) ⇒ Types::GetImageAncestryResult
Retrieves the ancestry chain of the specified AMI, tracing its lineage back to the root AMI.
-
#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_image_findings(params = {}) ⇒ Types::GetImageFindingsResult
Describes the Amazon Inspector vulnerability findings for the specified AMI.
-
#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_discovered_routes(params = {}) ⇒ Types::GetIpamDiscoveredRoutesResult
Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region.
-
#get_ipam_internet_registry_association_asns(params = {}) ⇒ Types::GetIpamInternetRegistryAssociationAsnsResult
Retrieves Autonomous System Numbers (ASNs) registered with an internet registry for an IPAM internet registry association.
-
#get_ipam_internet_registry_association_cidrs(params = {}) ⇒ Types::GetIpamInternetRegistryAssociationCidrsResult
Retrieves IP address CIDRs registered with an internet registry for an IPAM internet registry association.
-
#get_ipam_policy_allocation_rules(params = {}) ⇒ Types::GetIpamPolicyAllocationRulesResult
Gets the allocation rules for an IPAM policy.
-
#get_ipam_policy_organization_targets(params = {}) ⇒ Types::GetIpamPolicyOrganizationTargetsResult
Gets the Amazon Web Services Organizations targets for an IPAM policy.
-
#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_prefix_list_resolver_rules(params = {}) ⇒ Types::GetIpamPrefixListResolverRulesResult
Retrieves the CIDR selection rules for an IPAM prefix list resolver.
-
#get_ipam_prefix_list_resolver_version_entries(params = {}) ⇒ Types::GetIpamPrefixListResolverVersionEntriesResult
Retrieves the CIDR entries for a specific version of an IPAM prefix list resolver.
-
#get_ipam_prefix_list_resolver_versions(params = {}) ⇒ Types::GetIpamPrefixListResolverVersionsResult
Retrieves version information for an IPAM prefix list resolver.
-
#get_ipam_resource_cidrs(params = {}) ⇒ Types::GetIpamResourceCidrsResult
Returns resource CIDRs managed by IPAM in a given scope.
-
#get_ipam_route_origin_authorizations(params = {}) ⇒ Types::GetIpamRouteOriginAuthorizationsResult
Retrieves the current Route Origin Authorizations (ROAs) published to the RPKI for an IPAM internet registry association.
-
#get_ipam_route_protection_findings(params = {}) ⇒ Types::GetIpamRouteProtectionFindingsResult
Retrieves route protection findings for an IPAM.
-
#get_ipam_routing_policy_registration_deltas(params = {}) ⇒ Types::GetIpamRoutingPolicyRegistrationDeltasResult
Retrieves the history of routing policy registration changes for an IPAM internet registry association.
-
#get_ipam_routing_policy_registrations(params = {}) ⇒ Types::GetIpamRoutingPolicyRegistrationsResult
Retrieves routing policy registrations for an IPAM internet registry association.
-
#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_managed_resource_visibility(params = {}) ⇒ Types::GetManagedResourceVisibilityResult
Retrieves the managed resource visibility configuration for the account.
-
#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_networking_flex_cost_allocation_policy_versions(params = {}) ⇒ Types::GetNetworkingFlexCostAllocationPolicyVersionsResult
Retrieves the versions of a flex cost allocation policy.
-
#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_route_server_associations(params = {}) ⇒ Types::GetRouteServerAssociationsResult
Gets information about the associations for the specified route server.
-
#get_route_server_propagations(params = {}) ⇒ Types::GetRouteServerPropagationsResult
Gets information about the route propagations for the specified route server.
-
#get_route_server_routing_database(params = {}) ⇒ Types::GetRouteServerRoutingDatabaseResult
Gets the routing database for the specified route server.
-
#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_nat_configuration(params = {}) ⇒ Types::GetTransitGatewayAttachmentNatConfigurationResult
Describes the NAT configuration for the specified transit gateway attachment.
-
#get_transit_gateway_attachment_propagations(params = {}) ⇒ Types::GetTransitGatewayAttachmentPropagationsResult
Lists the route tables to which the specified resource attachment propagates routes.
-
#get_transit_gateway_metering_policy_entries(params = {}) ⇒ Types::GetTransitGatewayMeteringPolicyEntriesResult
Retrieves the entries for a transit gateway metering policy.
-
#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_endpoint_targets(params = {}) ⇒ Types::GetVerifiedAccessEndpointTargetsResult
Gets the targets for the specified network CIDR endpoint for Verified Access.
-
#get_verified_access_group_policy(params = {}) ⇒ Types::GetVerifiedAccessGroupPolicyResult
Shows the contents of the Verified Access policy associated with the group.
-
#get_vpc_resources_blocking_encryption_enforcement(params = {}) ⇒ Types::GetVpcResourcesBlockingEncryptionEnforcementResult
Gets information about resources in a VPC that are blocking encryption enforcement.
-
#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 instead. -
#import_key_pair(params = {}) ⇒ Types::ImportKeyPairResult
Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool.
-
#import_snapshot(params = {}) ⇒ Types::ImportSnapshotResult
Imports a disk into an EBS snapshot.
-
#import_volume(params = {}) ⇒ Types::ImportVolumeResult
This API action supports only single-volume VMs. -
#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.
-
#list_volumes_in_recycle_bin(params = {}) ⇒ Types::ListVolumesInRecycleBinResult
Lists one or more volumes 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_account_vpc_encryption_control(params = {}) ⇒ Types::ModifyAccountVpcEncryptionControlResult
Modifies the account-level VPC Encryption Control configuration.
-
#modify_address_attribute(params = {}) ⇒ Types::ModifyAddressAttributeResult
Modifies an attribute of the specified Elastic IP address.
-
#modify_application_status_check(params = {}) ⇒ Types::ModifyApplicationStatusCheckResult
Modifies an existing application status check.
-
#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, instance eligibility, 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_client_vpn_endpoint_authorization_policy(params = {}) ⇒ Types::ModifyClientVpnEndpointAuthorizationPolicyResult
Creates or updates the authorization policy for a 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_connect_endpoint(params = {}) ⇒ Types::ModifyInstanceConnectEndpointResult
Modifies the specified EC2 Instance Connect Endpoint.
-
#modify_instance_cpu_options(params = {}) ⇒ Types::ModifyInstanceCpuOptionsResult
By default, all vCPUs for the instance type are active when you launch an 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_network_performance_options(params = {}) ⇒ Types::ModifyInstanceNetworkPerformanceResult
Change the configuration of the network performance options for an existing 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_policy_allocation_rules(params = {}) ⇒ Types::ModifyIpamPolicyAllocationRulesResult
Modifies the allocation rules in an IPAM policy.
-
#modify_ipam_pool(params = {}) ⇒ Types::ModifyIpamPoolResult
Modify the configurations of an IPAM pool.
-
#modify_ipam_pool_allocation(params = {}) ⇒ Types::ModifyIpamPoolAllocationResult
Modifies the description of an IPAM pool allocation.
-
#modify_ipam_prefix_list_resolver(params = {}) ⇒ Types::ModifyIpamPrefixListResolverResult
Modifies an IPAM prefix list resolver.
-
#modify_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::ModifyIpamPrefixListResolverTargetResult
Modifies an IPAM prefix list resolver target.
-
#modify_ipam_resource_cidr(params = {}) ⇒ Types::ModifyIpamResourceCidrResult
Modify a resource CIDR.
-
#modify_ipam_resource_discovery(params = {}) ⇒ Types::ModifyIpamResourceDiscoveryResult
Modifies a resource discovery.
-
#modify_ipam_routing_policy_registration(params = {}) ⇒ Types::ModifyIpamRoutingPolicyRegistrationResult
Modifies an existing routing policy registration.
-
#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_managed_resource_visibility(params = {}) ⇒ Types::ModifyManagedResourceVisibilityResult
Modifies the managed resource visibility configuration for the account.
-
#modify_metric_category(params = {}) ⇒ Types::ModifyMetricCategoryResult
Modifies the metrics in the specified metric category.
-
#modify_network_interface_attribute(params = {}) ⇒ Struct
Modifies the specified network interface attribute.
-
#modify_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::ModifyNetworkingFlexCostAllocationPolicyResult
Modifies a flex cost allocation policy.
-
#modify_private_dns_name_options(params = {}) ⇒ Types::ModifyPrivateDnsNameOptionsResult
Modifies the options for instance hostnames for the specified instance.
-
#modify_public_ip_dns_name_options(params = {}) ⇒ Types::ModifyPublicIpDnsNameOptionsResult
Modify public hostname options for a network interface.
-
#modify_reserved_instances(params = {}) ⇒ Types::ModifyReservedInstancesResult
Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type.
-
#modify_route_server(params = {}) ⇒ Types::ModifyRouteServerResult
Modifies the configuration of an existing route server.
-
#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_attachment_nat_configuration(params = {}) ⇒ Types::ModifyTransitGatewayAttachmentNatConfigurationResult
Modifies the NAT configuration for the specified transit gateway attachment.
-
#modify_transit_gateway_metering_policy(params = {}) ⇒ Types::ModifyTransitGatewayMeteringPolicyResult
Modifies a transit gateway metering policy.
-
#modify_transit_gateway_network_function_attachment(params = {}) ⇒ Types::ModifyTransitGatewayNetworkFunctionAttachmentResult
Adds Availability Zones to or removes Availability Zones from the specified network function attachment.
-
#modify_transit_gateway_policy_table_entry(params = {}) ⇒ Types::ModifyTransitGatewayPolicyTableEntryResult
Modifies the specified transit gateway policy table entry.
-
#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_block_public_access_exclusion(params = {}) ⇒ Types::ModifyVpcBlockPublicAccessExclusionResult
Modify VPC Block Public Access (BPA) exclusions.
-
#modify_vpc_block_public_access_options(params = {}) ⇒ Types::ModifyVpcBlockPublicAccessOptionsResult
Modify VPC Block Public Access (BPA) options.
-
#modify_vpc_encryption_control(params = {}) ⇒ Types::ModifyVpcEncryptionControlResult
Modifies the encryption control configuration for a 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_payer_responsibility(params = {}) ⇒ Types::ModifyVpcEndpointPayerResponsibilityResult
Modifies the billing account for VPC endpoint usage/charges.
-
#modify_vpc_endpoint_service_configuration(params = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult
Modifies the attributes of the specified 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.
-
#move_capacity_reservation_instances(params = {}) ⇒ Types::MoveCapacityReservationInstancesResult
Move available capacity from a source Capacity Reservation to a destination Capacity Reservation.
-
#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_capacity_block_extension(params = {}) ⇒ Types::PurchaseCapacityBlockExtensionResult
Purchase the Capacity Block extension 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_capacity_reservation_billing_ownership(params = {}) ⇒ Types::RejectCapacityReservationBillingOwnershipResult
Rejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account.
-
#reject_transit_gateway_client_vpn_attachment(params = {}) ⇒ Types::RejectTransitGatewayClientVpnAttachmentResult
Rejects a Transit Gateway attachment request for a Client VPN endpoint.
-
#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_image_criteria_in_allowed_images_settings(params = {}) ⇒ Types::ReplaceImageCriteriaInAllowedImagesSettingsResult
Sets or replaces the criteria for Allowed AMIs.
-
#replace_image_instance_type_specification(params = {}) ⇒ Types::ReplaceImageInstanceTypeSpecificationResult
Replaces or removes the instance type specification for an AMI.
-
#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.
-
#restore_volume_from_recycle_bin(params = {}) ⇒ Types::RestoreVolumeFromRecycleBinResult
Restores a volume from the Recycle Bin.
-
#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_declarative_policies_report(params = {}) ⇒ Types::StartDeclarativePoliciesReportResult
Generates an account status report.
-
#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
Terminates (deletes) the specified instances.
-
#unassign_ipv_6_addresses(params = {}) ⇒ Types::UnassignIpv6AddressesResult
Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.
-
#unassign_private_ip_addresses(params = {}) ⇒ Struct
Unassigns the specified 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_capacity_manager_monitored_tag_keys(params = {}) ⇒ Types::UpdateCapacityManagerMonitoredTagKeysResult
Activates or deactivates tag keys for monitoring by EC2 Capacity Manager.
-
#update_capacity_manager_organizations_access(params = {}) ⇒ Types::UpdateCapacityManagerOrganizationsAccessResult
Updates the Organizations access setting for EC2 Capacity Manager.
-
#update_interruptible_capacity_reservation_allocation(params = {}) ⇒ Types::UpdateInterruptibleCapacityReservationAllocationResult
Modifies the number of instances allocated to an interruptible reservation, allowing you to add more capacity or reclaim capacity to your source Capacity Reservation.
-
#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.
-
#validate_security_group_quotas_for_interface(params = {}) ⇒ Types::ValidateSecurityGroupQuotasForInterfaceResult
Validates whether the specified security groups can be associated with a single network interface.
-
#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.
483 484 485 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 483 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.
548 549 550 551 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 548 def accept_address_transfer(params = {}, = {}) req = build_request(:accept_address_transfer, params) req.send_request() end |
#accept_capacity_reservation_billing_ownership(params = {}) ⇒ Types::AcceptCapacityReservationBillingOwnershipResult
Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
589 590 591 592 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 589 def accept_capacity_reservation_billing_ownership(params = {}, = {}) req = build_request(:accept_capacity_reservation_billing_ownership, 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.
636 637 638 639 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 636 def accept_reserved_instances_exchange_quote(params = {}, = {}) req = build_request(:accept_reserved_instances_exchange_quote, params) req.send_request() end |
#accept_transit_gateway_client_vpn_attachment(params = {}) ⇒ Types::AcceptTransitGatewayClientVpnAttachmentResult
Accepts a Transit Gateway attachment request for a Client VPN endpoint. The Transit Gateway owner must accept the attachment request before the Client VPN endpoint can route traffic through the Transit Gateway.
679 680 681 682 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 679 def (params = {}, = {}) req = build_request(:accept_transit_gateway_client_vpn_attachment, 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.
731 732 733 734 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 731 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.
784 785 786 787 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 784 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.
838 839 840 841 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 838 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.
891 892 893 894 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 891 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.
961 962 963 964 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 961 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.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1056 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 one of the following address pools:
Amazon's pool of IPv4 addresses
Public IPv4 address range that you own and bring to your Amazon Web Services account using Bring Your Own IP Addresses (BYOIP)
An IPv4 IPAM pool with an Amazon-provided or BYOIP public IPv4 address range
IPv4 addresses from your on-premises network made available for use with an Outpost using a customer-owned IP address pool (CoIP pool)
For more information, see Elastic IP Addresses 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.
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).
1210 1211 1212 1213 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1210 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.
1367 1368 1369 1370 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1367 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1509 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1557 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 the specified IPv6 addresses to the specified network interface. You can specify specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from 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 by 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.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1633 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 the specified secondary private IP addresses to the specified network interface.
You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from 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.
1752 1753 1754 1755 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1752 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.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1816 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.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 1936 def associate_address(params = {}, = {}) req = build_request(:associate_address, params) req.send_request() end |
#associate_application_status_check(params = {}) ⇒ Types::AssociateApplicationStatusCheckResult
Associates an application status check with instances or tags. Once you create an association, health monitoring automatically begins for the specified instances or for instances that match the specified tags. The following rules apply:
You must specify either
TargetTagAssociationsorInstanceIds, but not both. Specifying both results in anInvalidParameterCombinationerror.You must own the application status check. The check must already exist in your account.
You must not leave tag keys blank.
You can create a maximum of 50 tag associations for each application status check.
You can use
DisassociateApplicationStatusCheckto remove associations.You can associate tags so that the application status check automatically monitors all current and future instances that have the specified tags.
2069 2070 2071 2072 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2069 def associate_application_status_check(params = {}, = {}) req = build_request(:associate_application_status_check, params) req.send_request() end |
#associate_capacity_reservation_billing_owner(params = {}) ⇒ Types::AssociateCapacityReservationBillingOwnerResult
Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
2116 2117 2118 2119 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2116 def associate_capacity_reservation_billing_owner(params = {}, = {}) req = build_request(:associate_capacity_reservation_billing_owner, 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.
2197 2198 2199 2200 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2197 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.
2265 2266 2267 2268 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2265 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.
2333 2334 2335 2336 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2333 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.
2400 2401 2402 2403 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2400 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.
2475 2476 2477 2478 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2475 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.
2530 2531 2532 2533 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2530 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.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2604 def associate_ipam_resource_discovery(params = {}, = {}) req = build_request(:associate_ipam_resource_discovery, params) req.send_request() end |
#associate_kms_key_id(params = {}) ⇒ Types::AssociateKmsKeyIdResult
Associates an additional KMS key with an encrypted Amazon EBS snapshot. With the associated key, you have a second, independent way to access the snapshot's data, in addition to the key the snapshot is already encrypted under. Associating a key doesn't re-encrypt the snapshot or grant access to its original key.
For more information, see Associated KMS keys in the Amazon EBS User Guide.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2655 def associate_kms_key_id(params = {}, = {}) req = build_request(:associate_kms_key_id, 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.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2757 def associate_nat_gateway_address(params = {}, = {}) req = build_request(:associate_nat_gateway_address, params) req.send_request() end |
#associate_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::AssociateNetworkingFlexCostAllocationPolicyResult
Associates a flex cost allocation policy with one or more network resources. You can associate the policy directly with specific resources by resource ID, or you can associate it with a scope of resources in an account, Amazon VPC, or subnet.
The following limits apply:
A request can associate up to 20 resources.
A policy can have up to 100 active associations.
A network resource can have only one active association, across all policies. If a resource is already associated, the response includes it in the failures with the code
ResourceAlreadyAssociated.
2852 2853 2854 2855 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2852 def associate_networking_flex_cost_allocation_policy(params = {}, = {}) req = build_request(:associate_networking_flex_cost_allocation_policy, params) req.send_request() end |
#associate_route_server(params = {}) ⇒ Types::AssociateRouteServerResult
Associates a route server with a VPC to enable dynamic route updates.
A route server association is the connection established between a route server and a VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2903 def associate_route_server(params = {}, = {}) req = build_request(:associate_route_server, 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.
2981 2982 2983 2984 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 2981 def associate_route_table(params = {}, = {}) req = build_request(:associate_route_table, params) req.send_request() end |
#associate_security_group_vpc(params = {}) ⇒ Types::AssociateSecurityGroupVpcResult
Associates a security group with another VPC in the same Region. This enables you to use the same security group with network interfaces and instances in the specified VPC.
You can associate the security group with another VPC if your account owns the VPC or if the VPC was shared with you.
You must own the security group.
You cannot use this feature with default security groups.
You cannot use this feature with the default VPC.
3036 3037 3038 3039 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3036 def associate_security_group_vpc(params = {}, = {}) req = build_request(:associate_security_group_vpc, 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.
3084 3085 3086 3087 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3084 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.
3145 3146 3147 3148 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3145 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.
3191 3192 3193 3194 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3191 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.
3236 3237 3238 3239 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3236 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.
3315 3316 3317 3318 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3315 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.
3446 3447 3448 3449 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3446 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.
3506 3507 3508 3509 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3506 def attach_classic_link_vpc(params = {}, = {}) req = build_request(:attach_classic_link_vpc, params) req.send_request() end |
#attach_image_watermark(params = {}) ⇒ Types::AttachImageWatermarkResult
Attaches a watermark to a non-public AMI. The watermark is a structured identifier that automatically propagates to all derivative images created through CreateImage, and CopyImage.
Only the AMI owner can attach watermarks. Watermarks cannot be added to public AMIs.
3560 3561 3562 3563 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3560 def attach_image_watermark(params = {}, = {}) req = build_request(:attach_image_watermark, 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.
3610 3611 3612 3613 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3610 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.
3691 3692 3693 3694 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3691 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.
3791 3792 3793 3794 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3791 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 Amazon EBS volume to a running or stopped instance,
and exposes it to the instance with the specified device name.
AttachmentLimitExceeded error. For more information, see
Instance volume limits.
After you attach an EBS volume, you must make it available for use. 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.
3910 3911 3912 3913 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3910 def attach_volume(params = {}, = {}) req = build_request(:attach_volume, params) req.send_request() end |
#attach_vpn_gateway(params = {}) ⇒ Types::AttachVpnGatewayResult
Attaches an available 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.
3958 3959 3960 3961 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 3958 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.
4033 4034 4035 4036 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4033 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.
4244 4245 4246 4247 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4244 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.
4546 4547 4548 4549 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4546 def (params = {}, = {}) req = build_request(:authorize_security_group_ingress, params) req.send_request() end |
#batch_modify_ipam_routing_policy_registrations(params = {}) ⇒ Types::BatchModifyIpamRoutingPolicyRegistrationsResult
Modifies multiple routing policy registrations in a single operation. You can create, update, or delete Route Origin Authorizations (ROAs) in batch.
4605 4606 4607 4608 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4605 def batch_modify_ipam_routing_policy_registrations(params = {}, = {}) req = build_request(:batch_modify_ipam_routing_policy_registrations, 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.
4684 4685 4686 4687 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4684 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.
4741 4742 4743 4744 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4741 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.
You can cancel a Capacity Reservation that is in the following states:
assessingscheduled— requires a cancellation quote. UseCreateCapacityReservationCancellationQuoteto generate a quote, then pass the quote ID withApplyCancellationChargesset tocommitment-wind-down. The cancellation charge depends on how close the reservation is to its start date.activeand there is no commitment duration or the commitment duration has elapsed.activeduring the commitment duration — requires a cancellation quote. UseCreateCapacityReservationCancellationQuoteto generate a quote, then pass the quote ID withApplyCancellationChargesset tocommitment-wind-down. The Capacity Reservation transitions tocancellingwhile charges are applied.delayed— the commitment duration is waived, so no cancellation charge applies.
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.
4831 4832 4833 4834 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4831 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.
4883 4884 4885 4886 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4883 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.
4920 4921 4922 4923 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4920 def cancel_conversion_task(params = {}, = {}) req = build_request(:cancel_conversion_task, params) req.send_request() end |
#cancel_declarative_policies_report(params = {}) ⇒ Types::CancelDeclarativePoliciesReportResult
Cancels the generation of an account status report.
You can only cancel a report while it has the running status.
Reports with other statuses (complete, cancelled, or error)
can't be canceled.
For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.
4967 4968 4969 4970 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4967 def cancel_declarative_policies_report(params = {}, = {}) req = build_request(:cancel_declarative_policies_report, 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.
4993 4994 4995 4996 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 4993 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.
5036 5037 5038 5039 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5036 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.
5079 5080 5081 5082 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5079 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.
5133 5134 5135 5136 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5133 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.
Terminating an instance is permanent and irreversible.
After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see How instance termination works.
Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage.
Restrictions
- You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
^
5265 5266 5267 5268 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5265 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.
5326 5327 5328 5329 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5326 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.
5385 5386 5387 5388 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5385 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.
5442 5443 5444 5445 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5442 def copy_fpga_image(params = {}, = {}) req = build_request(:copy_fpga_image, params) req.send_request() end |
#copy_image(params = {}) ⇒ Types::CopyImageResult
Initiates an AMI copy operation. You must specify the source AMI ID and both the source and destination locations. The copy operation must be initiated in the destination Region.
CopyImage supports the following source to destination copies:
Region to Region
Region to Outpost
Parent Region to Local Zone
Local Zone to parent Region
Between Local Zones with the same parent Region (only supported for certain Local Zones)
CopyImage does not support the following source to destination copies:
Local Zone to non-parent Regions
Between Local Zones with different parent Regions
Local Zone to Outpost
Outpost to Local Zone
Outpost to Region
Between Outposts
Within same Outpost
Cross-partition copies (use CreateStoreImageTask instead)
Destination specification
Region to Region: The destination Region is the Region in which you initiate the copy operation.
Region to Outpost: Specify the destination using the
DestinationOutpostArnparameter (the ARN of the Outpost)Region to Local Zone, and Local Zone to Local Zone copies: Specify the destination using the
DestinationAvailabilityZoneparameter (the name of the destination Local Zone) orDestinationAvailabilityZoneIdparameter (the ID of the destination Local Zone).
Snapshot encryption
Region to Outpost: Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots.
Region to Local Zone, and Local Zone to Local Zone: Not all Local Zones require encrypted snapshots. In Local Zones that require encrypted snapshots, backing snapshots are automatically encrypted during copy. In Local Zones where encryption is not required, snapshots retain their original encryption state (encrypted or unencrypted) by default.
For more information, including the required permissions for copying an AMI, see Copy an Amazon EC2 AMI in the Amazon EC2 User Guide.
5742 5743 5744 5745 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5742 def copy_image(params = {}, = {}) req = build_request(:copy_image, params) req.send_request() end |
#copy_snapshot(params = {}) ⇒ Types::CopySnapshotResult
Creates an exact copy of an Amazon EBS snapshot.
The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy.
If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region.
If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent Region of the Local Zone.
If the source snapshot is on an Outpost, you can't copy it.
When copying snapshots to a Region, the encryption outcome for the snapshot copy depends on the Amazon EBS encryption by default setting for the destination Region, the encryption status of the source snapshot, and the encryption parameters you specify in the request. For more information, see Encryption and snapshot copying.
Snapshots copied to an Outpost must be encrypted. Unencrypted snapshots are not supported on Outposts. For more information, Amazon EBS local snapshots on Outposts.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
5970 5971 5972 5973 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 5970 def copy_snapshot(params = {}, = {}) req = build_request(:copy_snapshot, params) req.send_request() end |
#copy_volumes(params = {}) ⇒ Types::CopyVolumesResult
Creates a crash-consistent, point-in-time copy of an existing Amazon
EBS volume within the same Availability Zone. The volume copy can be
attached to an Amazon EC2 instance once it reaches the available
state. For more information, see Copy an Amazon EBS volume.
6165 6166 6167 6168 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6165 def copy_volumes(params = {}, = {}) req = build_request(:copy_volumes, params) req.send_request() end |
#create_application_status_check(params = {}) ⇒ Types::CreateApplicationStatusCheckResult
Creates an application status check for monitoring the health of applications running on your instances. You can configure the protocol, port, path, and thresholds for the health check. The following rules apply:
You can create a maximum of 50 application status checks for each account.
You must associate the check with instances or tags using
AssociateApplicationStatusCheckbefore health checks start.You must set the
Timeoutvalue to less than theIntervalvalue.You must start the
Pathwith a forward slash (/). Default:/.You can specify
Aggregationasincludedorexcluded. If you do not specify a value, it defaults toincluded, which means the check contributes to the instance-level application status.You can use the following default values:
Intervalis 60 seconds,Timeoutis 6 seconds,FailureThresholdis 2,SuccessThresholdis 2,StatusCodeMatcheris200,InitializationGracePeriodSecondsis 300 seconds.You can tag the application status check during creation. For more information, see Tag your Amazon EC2 resources.
6400 6401 6402 6403 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6400 def create_application_status_check(params = {}, = {}) req = build_request(:create_application_status_check, params) req.send_request() end |
#create_capacity_manager_data_export(params = {}) ⇒ Types::CreateCapacityManagerDataExportResult
Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.
6480 6481 6482 6483 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6480 def create_capacity_manager_data_export(params = {}, = {}) req = build_request(:create_capacity_manager_data_export, 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.
You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date.
For more information, see Reserve compute capacity with On-Demand 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. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes.
The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
6808 6809 6810 6811 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6808 def create_capacity_reservation(params = {}, = {}) req = build_request(:create_capacity_reservation, params) req.send_request() end |
#create_capacity_reservation_by_splitting(params = {}) ⇒ Types::CreateCapacityReservationBySplittingResult
Create a new Capacity Reservation by splitting the capacity of the
source Capacity Reservation. The new Capacity Reservation will have
the same attributes as the source Capacity Reservation except for
tags. The source Capacity Reservation must be active and owned by
your Amazon Web Services account.
6991 6992 6993 6994 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 6991 def create_capacity_reservation_by_splitting(params = {}, = {}) req = build_request(:create_capacity_reservation_by_splitting, params) req.send_request() end |
#create_capacity_reservation_cancellation_quote(params = {}) ⇒ Types::CreateCapacityReservationCancellationQuoteResult
Generates a cancellation quote for a future-dated Capacity Reservation
that is within its commitment duration. The quote includes the
cancellation terms and a quote ID that you can pass to the
CancelCapacityReservation action. Cancellation quotes are valid for
24 hours.
7072 7073 7074 7075 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7072 def create_capacity_reservation_cancellation_quote(params = {}, = {}) req = build_request(:create_capacity_reservation_cancellation_quote, params) req.send_request() end |
#create_capacity_reservation_date_change_quote(params = {}) ⇒ Types::CreateCapacityReservationDateChangeQuoteResult
Generates a quote for changing the start date of a future-dated
Capacity Reservation that has not yet been delivered. The quote
includes the new start date, the resulting commitment end date, and a
quote ID. Pass the quote ID to ModifyCapacityReservation to apply
the change.
The cumulative pushout across all changes is limited to 30 days from the Capacity Reservation's original start date. Quotes are valid for 24 hours, and always expire at least one hour before the start date.
7163 7164 7165 7166 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7163 def create_capacity_reservation_date_change_quote(params = {}, = {}) req = build_request(:create_capacity_reservation_date_change_quote, 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.
7413 7414 7415 7416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7413 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.
7487 7488 7489 7490 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7487 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.
7759 7760 7761 7762 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7759 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.
7842 7843 7844 7845 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7842 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.
7883 7884 7885 7886 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7883 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.
7939 7940 7941 7942 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 7939 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.
8086 8087 8088 8089 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8086 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.
8176 8177 8178 8179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8176 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.
8270 8271 8272 8273 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8270 def create_default_vpc(params = {}, = {}) req = build_request(:create_default_vpc, params) req.send_request() end |
#create_delegate_mac_volume_ownership_task(params = {}) ⇒ Types::CreateDelegateMacVolumeOwnershipTaskResult
Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.
8375 8376 8377 8378 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8375 def create_delegate_mac_volume_ownership_task(params = {}, = {}) req = build_request(:create_delegate_mac_volume_ownership_task, 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.
8526 8527 8528 8529 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8526 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.
8598 8599 8600 8601 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 8598 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.
9087 9088 9089 9090 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9087 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.
9297 9298 9299 9300 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9297 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 was successfully created and 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.
9390 9391 9392 9393 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9390 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.
The location of the source instance determines where you can create the snapshots of the AMI:
If the source instance is in a Region, you must create the snapshots in the same Region as the instance.
If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region.
If the source instance is on an Outpost that supports local snapshots, you can create the snapshots on the same Outpost or in the parent Region of that Outpost. In this case, you must use the
SnapshotLocationparameter to specify where to create the snapshots.
For more information, see Create an Amazon EBS-backed AMI in the Amazon Elastic Compute Cloud User Guide.
9634 9635 9636 9637 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9634 def create_image(params = {}, = {}) req = build_request(:create_image, params) req.send_request() end |
#create_image_usage_report(params = {}) ⇒ Types::CreateImageUsageReportResult
Creates a report that shows how your image is used across other Amazon Web Services accounts. The report provides visibility into which accounts are using the specified image, and how many resources (EC2 instances, EC2 launch templates, Image Builder image recipes, or Image Builder container recipes) are referencing it.
For more information, see View your AMI usage in the Amazon EC2 User Guide.
9729 9730 9731 9732 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9729 def create_image_usage_report(params = {}, = {}) req = build_request(:create_image_usage_report, 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 or public IPv6 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
9865 9866 9867 9868 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 9865 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.
10003 10004 10005 10006 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10003 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.
10084 10085 10086 10087 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10084 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.
10163 10164 10165 10166 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10163 def create_internet_gateway(params = {}, = {}) req = build_request(:create_internet_gateway, params) req.send_request() end |
#create_interruptible_capacity_reservation_allocation(params = {}) ⇒ Types::CreateInterruptibleCapacityReservationAllocationResult
Creates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation. This helps you make unused capacity available for other workloads within your account while maintaining control to reclaim it.
10245 10246 10247 10248 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10245 def create_interruptible_capacity_reservation_allocation(params = {}, = {}) req = build_request(:create_interruptible_capacity_reservation_allocation, 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.
10393 10394 10395 10396 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10393 def create_ipam(params = {}, = {}) req = build_request(:create_ipam, params) req.send_request() end |
#create_ipam_external_resource_verification_token(params = {}) ⇒ Types::CreateIpamExternalResourceVerificationTokenResult
Create a verification token.
A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
10473 10474 10475 10476 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10473 def create_ipam_external_resource_verification_token(params = {}, = {}) req = build_request(:create_ipam_external_resource_verification_token, params) req.send_request() end |
#create_ipam_internet_registry_association(params = {}) ⇒ Types::CreateIpamInternetRegistryAssociationResult
Creates an association between an IPAM and a Regional Internet Registry (RIR) for Resource Public Key Infrastructure (RPKI) management. You can use this association to create Route Origin Authorizations (ROAs) for IP address prefixes registered with the internet registry. Your IPAM must be in the Advanced tier to use this feature.
10573 10574 10575 10576 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10573 def create_ipam_internet_registry_association(params = {}, = {}) req = build_request(:create_ipam_internet_registry_association, params) req.send_request() end |
#create_ipam_policy(params = {}) ⇒ Types::CreateIpamPolicyResult
Creates an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
For more information, see Define public IPv4 allocation strategy with IPAM policies in the Amazon VPC IPAM User Guide.
10656 10657 10658 10659 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10656 def create_ipam_policy(params = {}, = {}) req = build_request(:create_ipam_policy, 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.
10886 10887 10888 10889 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 10886 def create_ipam_pool(params = {}, = {}) req = build_request(:create_ipam_pool, params) req.send_request() end |
#create_ipam_prefix_list_resolver(params = {}) ⇒ Types::CreateIpamPrefixListResolverResult
Creates an IPAM prefix list resolver.
An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups.
For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.
11020 11021 11022 11023 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11020 def create_ipam_prefix_list_resolver(params = {}, = {}) req = build_request(:create_ipam_prefix_list_resolver, params) req.send_request() end |
#create_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::CreateIpamPrefixListResolverTargetResult
Creates an IPAM prefix list resolver target.
An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources.
For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.
11142 11143 11144 11145 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11142 def create_ipam_prefix_list_resolver_target(params = {}, = {}) req = build_request(:create_ipam_prefix_list_resolver_target, 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.
11224 11225 11226 11227 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11224 def create_ipam_resource_discovery(params = {}, = {}) req = build_request(:create_ipam_resource_discovery, params) req.send_request() end |
#create_ipam_routing_policy_registration(params = {}) ⇒ Types::CreateIpamRoutingPolicyRegistrationResult
Creates a routing policy registration and publishes Route Origin Authorizations (ROAs) to the RPKI for the specified CIDR prefix and ASNs.
11305 11306 11307 11308 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11305 def create_ipam_routing_policy_registration(params = {}, = {}) req = build_request(:create_ipam_routing_policy_registration, 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.
11419 11420 11421 11422 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11419 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 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 EC2 User Guide.
11521 11522 11523 11524 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11521 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 Store instance launch parameters in Amazon EC2 launch templates 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.
11951 11952 11953 11954 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 11951 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.
12558 12559 12560 12561 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12558 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:
LocalGatewayVirtualInterfaceGroupIdNetworkInterfaceId
12627 12628 12629 12630 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12627 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.
12691 12692 12693 12694 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12691 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.
12756 12757 12758 12759 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12756 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.
12819 12820 12821 12822 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12819 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_local_gateway_virtual_interface(params = {}) ⇒ Types::CreateLocalGatewayVirtualInterfaceResult
Create a virtual interface for a local gateway.
12914 12915 12916 12917 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12914 def create_local_gateway_virtual_interface(params = {}, = {}) req = build_request(:create_local_gateway_virtual_interface, params) req.send_request() end |
#create_local_gateway_virtual_interface_group(params = {}) ⇒ Types::CreateLocalGatewayVirtualInterfaceGroupResult
Create a local gateway virtual interface group.
12984 12985 12986 12987 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 12984 def create_local_gateway_virtual_interface_group(params = {}, = {}) req = build_request(:create_local_gateway_virtual_interface_group, params) req.send_request() end |
#create_mac_system_integrity_protection_modification_task(params = {}) ⇒ Types::CreateMacSystemIntegrityProtectionModificationTaskResult
Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings.
SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations.
To enable or disable all SIP settings, use the MacSystemIntegrityProtectionStatus parameter only. For example, to enable all SIP settings, specify the following:
MacSystemIntegrityProtectionStatus=enabled
^
To specify a custom configuration that selectively enables or disables
specific SIP settings, use the MacSystemIntegrityProtectionStatus
parameter to enable or disable all SIP settings, and then use the
MacSystemIntegrityProtectionConfiguration parameter to specify
exceptions. In this case, the exceptions you specify for
MacSystemIntegrityProtectionConfiguration override the value you
specify for MacSystemIntegrityProtectionStatus. For example, to
enable all SIP settings, except NvramProtections, specify the
following:
MacSystemIntegrityProtectionStatus=enabledMacSystemIntegrityProtectionConfigurationRequest "NvramProtections=disabled"
13157 13158 13159 13160 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13157 def create_mac_system_integrity_protection_modification_task(params = {}, = {}) req = build_request(:create_mac_system_integrity_protection_modification_task, params) req.send_request() end |
#create_managed_prefix_list(params = {}) ⇒ Types::CreateManagedPrefixListResult
Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description.
13257 13258 13259 13260 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13257 def create_managed_prefix_list(params = {}, = {}) req = build_request(:create_managed_prefix_list, params) req.send_request() end |
#create_metric_category(params = {}) ⇒ Types::CreateMetricCategoryResult
Creates a metric category. A metric category is a set of additional metrics that you can associate with an instance that has detailed monitoring enabled.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
13340 13341 13342 13343 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13340 def create_metric_category(params = {}, = {}) req = build_request(:create_metric_category, 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.
13602 13603 13604 13605 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13602 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.
13734 13735 13736 13737 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13734 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.
13860 13861 13862 13863 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 13860 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.
14110 14111 14112 14113 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14110 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.
14261 14262 14263 14264 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14261 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.
14606 14607 14608 14609 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14606 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.
14663 14664 14665 14666 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14663 def (params = {}, = {}) req = build_request(:create_network_interface_permission, params) req.send_request() end |
#create_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::CreateNetworkingFlexCostAllocationPolicyResult
Creates a flex cost allocation policy for Networking Flexible Cost Allocation (FCA), a feature of Amazon Virtual Private Cloud (Amazon VPC). The policy allocates the charges of a shared networking resource at the reporting granularity that you specify. You can create a policy for one of the following resource types: NAT gateways, Amazon VPC peering connections, or EC2 instances. Policies can allocate data transfer charges for all three types, and data processing charges for NAT gateways.
You can have up to 100 policies per account in each Amazon Web Services Region, plus one additional policy per network resource type created by a declarative policy, for a maximum of 103 policies in an Amazon Web Services Region.
14813 14814 14815 14816 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14813 def create_networking_flex_cost_allocation_policy(params = {}, = {}) req = build_request(:create_networking_flex_cost_allocation_policy, 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. A
precision-time placement group places instances on supported
hardware with direct access to high-precision time sources in Amazon
Web Services infrastructure.
For more information, see Placement groups in the Amazon EC2 User Guide.
14944 14945 14946 14947 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 14944 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.
15013 15014 15015 15016 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15013 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, that is restored from an AMI that has the same key
characteristics as that of the instance, or that is replaced by a
specified volume.
For more information, see Replace a root volume in the Amazon EC2 User Guide.
15171 15172 15173 15174 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15171 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.
15276 15277 15278 15279 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15276 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 S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.
15356 15357 15358 15359 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15356 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.
15499 15500 15501 15502 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15499 def create_route(params = {}, = {}) req = build_request(:create_route, params) req.send_request() end |
#create_route_server(params = {}) ⇒ Types::CreateRouteServerResult
Creates a new route server to manage dynamic routing in a VPC.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
15622 15623 15624 15625 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15622 def create_route_server(params = {}, = {}) req = build_request(:create_route_server, params) req.send_request() end |
#create_route_server_endpoint(params = {}) ⇒ Types::CreateRouteServerEndpointResult
Creates a new endpoint for a route server in a specified subnet.
A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
15705 15706 15707 15708 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15705 def create_route_server_endpoint(params = {}, = {}) req = build_request(:create_route_server_endpoint, params) req.send_request() end |
#create_route_server_peer(params = {}) ⇒ Types::CreateRouteServerPeerResult
Creates a new BGP peer for a specified route server endpoint.
A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
15800 15801 15802 15803 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15800 def create_route_server_peer(params = {}, = {}) req = build_request(:create_route_server_peer, 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.
15937 15938 15939 15940 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 15937 def create_route_table(params = {}, = {}) req = build_request(:create_route_table, params) req.send_request() end |
#create_secondary_network(params = {}) ⇒ Types::CreateSecondaryNetworkResult
Creates a secondary network.
The allowed size for a secondary network CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses).
16069 16070 16071 16072 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16069 def create_secondary_network(params = {}, = {}) req = build_request(:create_secondary_network, params) req.send_request() end |
#create_secondary_subnet(params = {}) ⇒ Types::CreateSecondarySubnetResult
Creates a secondary subnet in a secondary network.
A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can't change its CIDR block.
The allowed size for a secondary subnet CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use.
16235 16236 16237 16238 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16235 def create_secondary_subnet(params = {}, = {}) req = build_request(:create_secondary_subnet, 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 EC2 User Guide and Security groups for your VPC in the Amazon VPC 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.
16353 16354 16355 16356 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16353 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.
The location of the source EBS volume determines where you can create the snapshot.
If the source volume is in a Region, you must create the snapshot in the same Region as the volume.
If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services Region.
If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent Amazon Web Services Region.
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. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
16559 16560 16561 16562 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16559 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 attached to an Amazon EC2 instance. Volumes are chosen by specifying an instance. Each volume attached to the specified instance will produce one snapshot 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.
The location of the source instance determines where you can create the snapshots.
If the source instance is in a Region, you must create the snapshots in the same Region as the instance.
If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Amazon Web Services Region.
If the source instance is on an Outpost, you can create the snapshots on the same Outpost or in its parent Amazon Web Services Region.
16692 16693 16694 16695 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16692 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.
16769 16770 16771 16772 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16769 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 S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.
16833 16834 16835 16836 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 16833 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.
17030 17031 17032 17033 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17030 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 Manage prefixes for your network interfaces in the Amazon EC2 User Guide.
17114 17115 17116 17117 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17114 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.
17191 17192 17193 17194 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17191 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.
17309 17310 17311 17312 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17309 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.
17444 17445 17446 17447 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17444 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.
17582 17583 17584 17585 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17582 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.
17683 17684 17685 17686 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17683 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.
17790 17791 17792 17793 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17790 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.
17860 17861 17862 17863 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17860 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.
17963 17964 17965 17966 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 17963 def create_transit_gateway_connect_peer(params = {}, = {}) req = build_request(:create_transit_gateway_connect_peer, params) req.send_request() end |
#create_transit_gateway_metering_policy(params = {}) ⇒ Types::CreateTransitGatewayMeteringPolicyResult
Creates a metering policy for a transit gateway to track and measure network traffic.
18026 18027 18028 18029 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18026 def create_transit_gateway_metering_policy(params = {}, = {}) req = build_request(:create_transit_gateway_metering_policy, params) req.send_request() end |
#create_transit_gateway_metering_policy_entry(params = {}) ⇒ Types::CreateTransitGatewayMeteringPolicyEntryResult
Creates an entry in a transit gateway metering policy to define traffic measurement rules.
18128 18129 18130 18131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18128 def create_transit_gateway_metering_policy_entry(params = {}, = {}) req = build_request(:create_transit_gateway_metering_policy_entry, 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.
18204 18205 18206 18207 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18204 def create_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:create_transit_gateway_multicast_domain, params) req.send_request() end |
#create_transit_gateway_network_function_attachment(params = {}) ⇒ Types::CreateTransitGatewayNetworkFunctionAttachmentResult
Creates a network function attachment that connects the specified transit gateway to a Gateway Load Balancer endpoint service. Traffic that you route to the attachment is sent to the network function appliances behind the endpoint service. To use this operation, you must be the owner of the transit gateway.
You can create one network function attachment for each combination of
transit gateway and endpoint service. The attachment remains in the
pendingAcceptance state until the endpoint service owner accepts the
endpoint connection.
18294 18295 18296 18297 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18294 def (params = {}, = {}) req = build_request(:create_transit_gateway_network_function_attachment, 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.
18386 18387 18388 18389 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18386 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.
18442 18443 18444 18445 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18442 def create_transit_gateway_policy_table(params = {}, = {}) req = build_request(:create_transit_gateway_policy_table, params) req.send_request() end |
#create_transit_gateway_policy_table_entry(params = {}) ⇒ Types::CreateTransitGatewayPolicyTableEntryResult
Creates an entry in a transit gateway policy table to route matching traffic to a specified route table.
18511 18512 18513 18514 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18511 def create_transit_gateway_policy_table_entry(params = {}, = {}) req = build_request(:create_transit_gateway_policy_table_entry, 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.
18566 18567 18568 18569 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18566 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.
18622 18623 18624 18625 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18622 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.
18679 18680 18681 18682 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18679 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.
18745 18746 18747 18748 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18745 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.
18835 18836 18837 18838 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 18835 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.
19051 19052 19053 19054 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19051 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.
19145 19146 19147 19148 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19145 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.
19234 19235 19236 19237 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19234 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.
19387 19388 19389 19390 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19387 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.
19777 19778 19779 19780 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 19777 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.
A VPC must have an associated IPv4 CIDR block. You can choose an IPv4 CIDR block or an IPAM-allocated IPv4 CIDR block. You can optionally associate an IPv6 CIDR block with a VPC. You can choose an IPv6 CIDR block, an Amazon-provided IPv6 CIDR block, an IPAM-allocated IPv6 CIDR block, or an IPv6 CIDR block that you brought to Amazon Web Services. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
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 DNS options and tenancy for a VPC when you create it. You can't change the tenancy of a VPC after you create it. For more information, see VPC configuration options in the Amazon VPC User Guide.
20037 20038 20039 20040 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20037 def create_vpc(params = {}, = {}) req = build_request(:create_vpc, params) req.send_request() end |
#create_vpc_block_public_access_exclusion(params = {}) ⇒ Types::CreateVpcBlockPublicAccessExclusionResult
Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
20127 20128 20129 20130 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20127 def create_vpc_block_public_access_exclusion(params = {}, = {}) req = build_request(:create_vpc_block_public_access_exclusion, params) req.send_request() end |
#create_vpc_encryption_control(params = {}) ⇒ Types::CreateVpcEncryptionControlResult
Creates a VPC Encryption Control configuration for a specified VPC. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements for standards like HIPAA, FedRAMP, and PCI DSS.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
20214 20215 20216 20217 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20214 def create_vpc_encryption_control(params = {}, = {}) req = build_request(:create_vpc_encryption_control, 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.
20451 20452 20453 20454 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20451 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.
20529 20530 20531 20532 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20529 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.
20666 20667 20668 20669 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20666 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.
20784 20785 20786 20787 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20784 def create_vpc_peering_connection(params = {}, = {}) req = build_request(:create_vpc_peering_connection, params) req.send_request() end |
#create_vpn_concentrator(params = {}) ⇒ Types::CreateVpnConcentratorResult
Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.
20845 20846 20847 20848 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 20845 def create_vpn_concentrator(params = {}, = {}) req = build_request(:create_vpn_concentrator, 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.
21087 21088 21089 21090 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21087 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.
21124 21125 21126 21127 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21124 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.
21205 21206 21207 21208 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21205 def create_vpn_gateway(params = {}, = {}) req = build_request(:create_vpn_gateway, params) req.send_request() end |
#delete_application_status_check(params = {}) ⇒ Types::DeleteApplicationStatusCheckResult
Deletes an application status check. The following rules apply:
Deleting a check automatically removes all of its associations.
Use
DescribeApplicationStatusChecksto view existing checks before deleting.
21308 21309 21310 21311 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21308 def delete_application_status_check(params = {}, = {}) req = build_request(:delete_application_status_check, params) req.send_request() end |
#delete_capacity_manager_data_export(params = {}) ⇒ Types::DeleteCapacityManagerDataExportResult
Deletes an existing Capacity Manager data export configuration. This stops future scheduled exports but does not delete previously exported files from S3.
21345 21346 21347 21348 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21345 def delete_capacity_manager_data_export(params = {}, = {}) req = build_request(:delete_capacity_manager_data_export, 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.
21394 21395 21396 21397 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21394 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.
21431 21432 21433 21434 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21431 def delete_client_vpn_endpoint(params = {}, = {}) req = build_request(:delete_client_vpn_endpoint, params) req.send_request() end |
#delete_client_vpn_endpoint_authorization_policy(params = {}) ⇒ Types::DeleteClientVpnEndpointAuthorizationPolicyResult
Deletes the authorization policy for a Client VPN endpoint.
21466 21467 21468 21469 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21466 def (params = {}, = {}) req = build_request(:delete_client_vpn_endpoint_authorization_policy, 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.
21515 21516 21517 21518 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21515 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.
21556 21557 21558 21559 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21556 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.
21598 21599 21600 21601 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21598 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.
21637 21638 21639 21640 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21637 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.
21678 21679 21680 21681 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21678 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.
21713 21714 21715 21716 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21713 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 Fleet request.
After you delete an EC2 Fleet request, it launches no new instances.
You must also specify whether a deleted EC2 Fleet request should
terminate its instances. If you choose to terminate the instances, the
EC2 Fleet request enters the deleted_terminating state. Otherwise,
it enters the deleted_running state, and the instances continue to
run until they are interrupted or you terminate them manually.
A deleted instant fleet with running instances is not supported.
When you delete an instant fleet, Amazon EC2 automatically
terminates all its instances. For fleets with more than 1000
instances, the deletion request might fail. If your fleet has more
than 1000 instances, first terminate most of the instances manually,
leaving 1000 or fewer. Then delete the fleet, and the remaining
instances will be terminated automatically.
Terminating an instance is permanent and irreversible.
After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see How instance termination works.
Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage.
Restrictions
You can delete up to 25 fleets of type
instantin a single request.You can delete up to 100 fleets of type
maintainorrequestin 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 request and the instances in the fleet in the Amazon EC2 User Guide.
21822 21823 21824 21825 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21822 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.
21862 21863 21864 21865 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21862 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).
21897 21898 21899 21900 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21897 def delete_fpga_image(params = {}, = {}) req = build_request(:delete_fpga_image, params) req.send_request() end |
#delete_image_usage_report(params = {}) ⇒ Types::DeleteImageUsageReportResult
Deletes the specified image usage report.
For more information, see View your AMI usage in the Amazon EC2 User Guide.
21939 21940 21941 21942 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21939 def delete_image_usage_report(params = {}, = {}) req = build_request(:delete_image_usage_report, params) req.send_request() end |
#delete_instance_connect_endpoint(params = {}) ⇒ Types::DeleteInstanceConnectEndpointResult
Deletes the specified EC2 Instance Connect Endpoint.
21998 21999 22000 22001 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 21998 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.
22046 22047 22048 22049 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22046 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.
22085 22086 22087 22088 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22085 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.
22173 22174 22175 22176 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22173 def delete_ipam(params = {}, = {}) req = build_request(:delete_ipam, params) req.send_request() end |
#delete_ipam_external_resource_verification_token(params = {}) ⇒ Types::DeleteIpamExternalResourceVerificationTokenResult
Delete a verification token.
A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
22226 22227 22228 22229 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22226 def delete_ipam_external_resource_verification_token(params = {}, = {}) req = build_request(:delete_ipam_external_resource_verification_token, params) req.send_request() end |
#delete_ipam_internet_registry_association(params = {}) ⇒ Types::DeleteIpamInternetRegistryAssociationResult
Deletes an IPAM internet registry association. Before deleting, you must remove all routing policy registrations associated with the internet registry.
22276 22277 22278 22279 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22276 def delete_ipam_internet_registry_association(params = {}, = {}) req = build_request(:delete_ipam_internet_registry_association, params) req.send_request() end |
#delete_ipam_policy(params = {}) ⇒ Types::DeleteIpamPolicyResult
Deletes an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
22330 22331 22332 22333 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22330 def delete_ipam_policy(params = {}, = {}) req = build_request(:delete_ipam_policy, 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.
22420 22421 22422 22423 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22420 def delete_ipam_pool(params = {}, = {}) req = build_request(:delete_ipam_pool, params) req.send_request() end |
#delete_ipam_prefix_list_resolver(params = {}) ⇒ Types::DeleteIpamPrefixListResolverResult
Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.
22468 22469 22470 22471 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22468 def delete_ipam_prefix_list_resolver(params = {}, = {}) req = build_request(:delete_ipam_prefix_list_resolver, params) req.send_request() end |
#delete_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::DeleteIpamPrefixListResolverTargetResult
Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization.
For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.
22525 22526 22527 22528 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22525 def delete_ipam_prefix_list_resolver_target(params = {}, = {}) req = build_request(:delete_ipam_prefix_list_resolver_target, 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.
22575 22576 22577 22578 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22575 def delete_ipam_resource_discovery(params = {}, = {}) req = build_request(:delete_ipam_resource_discovery, params) req.send_request() end |
#delete_ipam_routing_policy_registration(params = {}) ⇒ Types::DeleteIpamRoutingPolicyRegistrationResult
Deletes a routing policy registration for a specified CIDR prefix.
22633 22634 22635 22636 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22633 def delete_ipam_routing_policy_registration(params = {}, = {}) req = build_request(:delete_ipam_routing_policy_registration, 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.
22689 22690 22691 22692 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22689 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.
22740 22741 22742 22743 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22740 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.
22818 22819 22820 22821 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22818 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.
22920 22921 22922 22923 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22920 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.
22977 22978 22979 22980 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 22977 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.
23023 23024 23025 23026 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23023 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.
23069 23070 23071 23072 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23069 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.
23114 23115 23116 23117 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23114 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_local_gateway_virtual_interface(params = {}) ⇒ Types::DeleteLocalGatewayVirtualInterfaceResult
Deletes the specified local gateway virtual interface.
23164 23165 23166 23167 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23164 def delete_local_gateway_virtual_interface(params = {}, = {}) req = build_request(:delete_local_gateway_virtual_interface, params) req.send_request() end |
#delete_local_gateway_virtual_interface_group(params = {}) ⇒ Types::DeleteLocalGatewayVirtualInterfaceGroupResult
Delete the specified local gateway interface group.
23210 23211 23212 23213 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23210 def delete_local_gateway_virtual_interface_group(params = {}, = {}) req = build_request(:delete_local_gateway_virtual_interface_group, 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.
23259 23260 23261 23262 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23259 def delete_managed_prefix_list(params = {}, = {}) req = build_request(:delete_managed_prefix_list, params) req.send_request() end |
#delete_metric_category(params = {}) ⇒ Types::DeleteMetricCategoryResult
Deletes the specified metric category. Associations between the metric category and your instances are removed asynchronously.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
23302 23303 23304 23305 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23302 def delete_metric_category(params = {}, = {}) req = build_request(:delete_metric_category, 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.
23354 23355 23356 23357 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23354 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.
23394 23395 23396 23397 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23394 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.
23443 23444 23445 23446 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23443 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.
23478 23479 23480 23481 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23478 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.
23513 23514 23515 23516 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23513 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.
23548 23549 23550 23551 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23548 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.
23583 23584 23585 23586 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23583 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.
23622 23623 23624 23625 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23622 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.
23665 23666 23667 23668 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23665 def (params = {}, = {}) req = build_request(:delete_network_interface_permission, params) req.send_request() end |
#delete_networking_flex_cost_allocation_policies(params = {}) ⇒ Types::DeleteNetworkingFlexCostAllocationPoliciesResult
Deletes one or more flex cost allocation policies.
23707 23708 23709 23710 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23707 def delete_networking_flex_cost_allocation_policies(params = {}, = {}) req = build_request(:delete_networking_flex_cost_allocation_policies, 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. You cannot delete a placement group that is a parent of a cluster placement group. Delete the cluster placement groups first. For more information, see Placement groups in the Amazon EC2 User Guide.
23758 23759 23760 23761 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23758 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.
23808 23809 23810 23811 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23808 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.
23849 23850 23851 23852 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23849 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.
23902 23903 23904 23905 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23902 def delete_route(params = {}, = {}) req = build_request(:delete_route, params) req.send_request() end |
#delete_route_server(params = {}) ⇒ Types::DeleteRouteServerResult
Deletes the specified route server.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
23975 23976 23977 23978 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 23975 def delete_route_server(params = {}, = {}) req = build_request(:delete_route_server, params) req.send_request() end |
#delete_route_server_endpoint(params = {}) ⇒ Types::DeleteRouteServerEndpointResult
Deletes the specified route server endpoint.
A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
24028 24029 24030 24031 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24028 def delete_route_server_endpoint(params = {}, = {}) req = build_request(:delete_route_server_endpoint, params) req.send_request() end |
#delete_route_server_peer(params = {}) ⇒ Types::DeleteRouteServerPeerResult
Deletes the specified BGP peer from a route server.
A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
24090 24091 24092 24093 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24090 def delete_route_server_peer(params = {}, = {}) req = build_request(:delete_route_server_peer, 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.
24130 24131 24132 24133 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24130 def delete_route_table(params = {}, = {}) req = build_request(:delete_route_table, params) req.send_request() end |
#delete_secondary_network(params = {}) ⇒ Types::DeleteSecondaryNetworkResult
Deletes a secondary network. You must delete all secondary subnets in the secondary network before you can delete the secondary network.
24229 24230 24231 24232 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24229 def delete_secondary_network(params = {}, = {}) req = build_request(:delete_secondary_network, params) req.send_request() end |
#delete_secondary_subnet(params = {}) ⇒ Types::DeleteSecondarySubnetResult
Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.
24334 24335 24336 24337 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24334 def delete_secondary_subnet(params = {}, = {}) req = build_request(:delete_secondary_subnet, params) req.send_request() end |
#delete_security_group(params = {}) ⇒ Types::DeleteSecurityGroupResult
Deletes a security group.
If you attempt to delete a security group that is associated with an
instance or network interface, is referenced by another security group
in the same VPC, or has a VPC association, the operation fails with
DependencyViolation.
24395 24396 24397 24398 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24395 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 deregister the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon EBS User Guide.
24457 24458 24459 24460 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24457 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.
24490 24491 24492 24493 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24490 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.
24529 24530 24531 24532 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24529 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.
24572 24573 24574 24575 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24572 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.
24648 24649 24650 24651 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24648 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.
24686 24687 24688 24689 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24686 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.
24721 24722 24723 24724 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24721 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.
24756 24757 24758 24759 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24756 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.
24794 24795 24796 24797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24794 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.
24851 24852 24853 24854 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24851 def delete_transit_gateway(params = {}, = {}) req = build_request(:delete_transit_gateway, params) req.send_request() end |
#delete_transit_gateway_client_vpn_attachment(params = {}) ⇒ Types::DeleteTransitGatewayClientVpnAttachmentResult
Deletes a Transit Gateway attachment for a Client VPN endpoint. The Transit Gateway owner can delete the attachment to remove the association between the Client VPN endpoint and the Transit Gateway.
24893 24894 24895 24896 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24893 def (params = {}, = {}) req = build_request(:delete_transit_gateway_client_vpn_attachment, 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.
24937 24938 24939 24940 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24937 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.
24989 24990 24991 24992 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 24989 def delete_transit_gateway_connect_peer(params = {}, = {}) req = build_request(:delete_transit_gateway_connect_peer, params) req.send_request() end |
#delete_transit_gateway_metering_policy(params = {}) ⇒ Types::DeleteTransitGatewayMeteringPolicyResult
Deletes a transit gateway metering policy.
25032 25033 25034 25035 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25032 def delete_transit_gateway_metering_policy(params = {}, = {}) req = build_request(:delete_transit_gateway_metering_policy, params) req.send_request() end |
#delete_transit_gateway_metering_policy_entry(params = {}) ⇒ Types::DeleteTransitGatewayMeteringPolicyEntryResult
Deletes an entry from a transit gateway metering policy.
25085 25086 25087 25088 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25085 def delete_transit_gateway_metering_policy_entry(params = {}, = {}) req = build_request(:delete_transit_gateway_metering_policy_entry, params) req.send_request() end |
#delete_transit_gateway_multicast_domain(params = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult
Deletes the specified transit gateway multicast domain.
25131 25132 25133 25134 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25131 def delete_transit_gateway_multicast_domain(params = {}, = {}) req = build_request(:delete_transit_gateway_multicast_domain, params) req.send_request() end |
#delete_transit_gateway_network_function_attachment(params = {}) ⇒ Types::DeleteTransitGatewayNetworkFunctionAttachmentResult
Deletes the specified network function attachment. The attachment must
be in the available or pendingAcceptance state.
25180 25181 25182 25183 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25180 def (params = {}, = {}) req = build_request(:delete_transit_gateway_network_function_attachment, params) req.send_request() end |
#delete_transit_gateway_peering_attachment(params = {}) ⇒ Types::DeleteTransitGatewayPeeringAttachmentResult
Deletes a transit gateway peering attachment.
25232 25233 25234 25235 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25232 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.
25273 25274 25275 25276 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25273 def delete_transit_gateway_policy_table(params = {}, = {}) req = build_request(:delete_transit_gateway_policy_table, params) req.send_request() end |
#delete_transit_gateway_policy_table_entry(params = {}) ⇒ Types::DeleteTransitGatewayPolicyTableEntryResult
Deletes the specified transit gateway policy table entry.
25321 25322 25323 25324 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25321 def delete_transit_gateway_policy_table_entry(params = {}, = {}) req = build_request(:delete_transit_gateway_policy_table_entry, 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.
25368 25369 25370 25371 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25368 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.
25417 25418 25419 25420 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25417 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. Before you can delete a transit gateway route table, you must disassociate all attachments from it by using DisassociateTransitGatewayRouteTable and wait for the disassociations to complete. You can't delete a transit gateway route table that is the default association route table or default propagation route table for the transit gateway. To change the default route tables, use ModifyTransitGateway.
25466 25467 25468 25469 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25466 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.
25514 25515 25516 25517 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25514 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.
25563 25564 25565 25566 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25563 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.
25661 25662 25663 25664 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25661 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.
25721 25722 25723 25724 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25721 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.
25785 25786 25787 25788 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25785 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.
25861 25862 25863 25864 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25861 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.
25914 25915 25916 25917 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25914 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 default security group, network ACL, and route table for the VPC.
If you created a flow log for the VPC that you are deleting, note that flow logs for deleted VPCs are eventually automatically removed.
25961 25962 25963 25964 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 25961 def delete_vpc(params = {}, = {}) req = build_request(:delete_vpc, params) req.send_request() end |
#delete_vpc_block_public_access_exclusion(params = {}) ⇒ Types::DeleteVpcBlockPublicAccessExclusionResult
Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
26017 26018 26019 26020 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26017 def delete_vpc_block_public_access_exclusion(params = {}, = {}) req = build_request(:delete_vpc_block_public_access_exclusion, params) req.send_request() end |
#delete_vpc_encryption_control(params = {}) ⇒ Types::DeleteVpcEncryptionControlResult
Deletes a VPC Encryption Control configuration. This removes the encryption policy enforcement from the specified VPC.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
26087 26088 26089 26090 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26087 def delete_vpc_encryption_control(params = {}, = {}) req = build_request(:delete_vpc_encryption_control, params) req.send_request() end |
#delete_vpc_endpoint_connection_notifications(params = {}) ⇒ Types::DeleteVpcEndpointConnectionNotificationsResult
Deletes the specified VPC endpoint connection notifications.
26125 26126 26127 26128 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26125 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.
26166 26167 26168 26169 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26166 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.
26215 26216 26217 26218 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26215 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.
26255 26256 26257 26258 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26255 def delete_vpc_peering_connection(params = {}, = {}) req = build_request(:delete_vpc_peering_connection, params) req.send_request() end |
#delete_vpn_concentrator(params = {}) ⇒ Types::DeleteVpnConcentratorResult
Deletes the specified VPN concentrator.
26290 26291 26292 26293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26290 def delete_vpn_concentrator(params = {}, = {}) req = build_request(:delete_vpn_concentrator, 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.
26334 26335 26336 26337 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26334 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.
26364 26365 26366 26367 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26364 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.
26396 26397 26398 26399 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26396 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 and you must not have any IP addresses allocated from its address range.
26450 26451 26452 26453 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26450 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.
26501 26502 26503 26504 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26501 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.
26552 26553 26554 26555 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26552 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.
26594 26595 26596 26597 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26594 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 = {}) ⇒ Types::DeregisterImageResult
Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances.
If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin in the Amazon EBS User Guide.
When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered.
Deregistering an AMI does not delete the following:
Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them.
For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs.
For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs.
For more information, see Deregister an Amazon EC2 AMI in the Amazon EC2 User Guide.
26678 26679 26680 26681 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26678 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.
26720 26721 26722 26723 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26720 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.
26767 26768 26769 26770 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26767 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.
26814 26815 26816 26817 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26814 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.
26974 26975 26976 26977 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 26974 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_account_vpc_encryption_control(params = {}) ⇒ Types::DescribeAccountVpcEncryptionControlResult
Describes the account-level VPC Encryption Control configuration for your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
27028 27029 27030 27031 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27028 def describe_account_vpc_encryption_control(params = {}, = {}) req = build_request(:describe_account_vpc_encryption_control, 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 14 days after the transfers have been accepted.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
27098 27099 27100 27101 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27098 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.
27228 27229 27230 27231 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27228 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.
27292 27293 27294 27295 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27292 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.
27346 27347 27348 27349 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27346 def describe_aggregate_id_format(params = {}, = {}) req = build_request(:describe_aggregate_id_format, params) req.send_request() end |
#describe_application_status(params = {}) ⇒ Types::DescribeApplicationStatusResult
Describes the aggregated application health status for the specified instances. The following rules apply:
The instance-level status is derived from all application status checks with the aggregation setting set to
included.Use
DescribeApplicationStatusChecksto view the configuration of individual checks.Use
EnableApplicationStatusCheckSuppressionto temporarily suppress health check results from affecting the instance-level status.
27526 27527 27528 27529 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27526 def describe_application_status(params = {}, = {}) req = build_request(:describe_application_status, params) req.send_request() end |
#describe_application_status_check_associations(params = {}) ⇒ Types::DescribeApplicationStatusCheckAssociationsResult
Describes the associations for one or more application status checks. For more information, see Application status checks. To avoid timeouts and retrieve complete results, use the pagination parameters.
27642 27643 27644 27645 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27642 def describe_application_status_check_associations(params = {}, = {}) req = build_request(:describe_application_status_check_associations, params) req.send_request() end |
#describe_application_status_checks(params = {}) ⇒ Types::DescribeApplicationStatusChecksResult
Describes application status checks, including configuration details
such as protocol, port, path, thresholds, and associations. Results
are paginated. Use the NextToken parameter to retrieve additional
results. The following rules apply:
If you do not specify any application status check IDs, all checks in your account are returned.
Use
DescribeApplicationStatusto see the actual health status of instances.
27815 27816 27817 27818 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27815 def describe_application_status_checks(params = {}, = {}) req = build_request(:describe_application_status_checks, 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.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon EC2 User Guide.
27988 27989 27990 27991 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 27988 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.
28047 28048 28049 28050 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28047 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
28148 28149 28150 28151 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28148 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 provisioned for use with Amazon Web Services resources through through bring your own IP addresses (BYOIP).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28208 28209 28210 28211 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28208 def describe_byoip_cidrs(params = {}, = {}) req = build_request(:describe_byoip_cidrs, params) req.send_request() end |
#describe_capacity_block_extension_history(params = {}) ⇒ Types::DescribeCapacityBlockExtensionHistoryResult
Describes the events for the specified Capacity Block extension during the specified time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28300 28301 28302 28303 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28300 def describe_capacity_block_extension_history(params = {}, = {}) req = build_request(:describe_capacity_block_extension_history, params) req.send_request() end |
#describe_capacity_block_extension_offerings(params = {}) ⇒ Types::DescribeCapacityBlockExtensionOfferingsResult
Describes Capacity Block extension offerings available for purchase 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.
28371 28372 28373 28374 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28371 def describe_capacity_block_extension_offerings(params = {}, = {}) req = build_request(:describe_capacity_block_extension_offerings, 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 can purchase a specific GPU instance type or EC2 UltraServer for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28480 28481 28482 28483 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28480 def describe_capacity_block_offerings(params = {}, = {}) req = build_request(:describe_capacity_block_offerings, params) req.send_request() end |
#describe_capacity_block_status(params = {}) ⇒ Types::DescribeCapacityBlockStatusResult
Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28558 28559 28560 28561 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28558 def describe_capacity_block_status(params = {}, = {}) req = build_request(:describe_capacity_block_status, params) req.send_request() end |
#describe_capacity_blocks(params = {}) ⇒ Types::DescribeCapacityBlocksResult
Describes details about Capacity Blocks 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.
28657 28658 28659 28660 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28657 def describe_capacity_blocks(params = {}, = {}) req = build_request(:describe_capacity_blocks, params) req.send_request() end |
#describe_capacity_manager_data_exports(params = {}) ⇒ Types::DescribeCapacityManagerDataExportsResult
Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28732 28733 28734 28735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28732 def describe_capacity_manager_data_exports(params = {}, = {}) req = build_request(:describe_capacity_manager_data_exports, params) req.send_request() end |
#describe_capacity_reservation_billing_requests(params = {}) ⇒ Types::DescribeCapacityReservationBillingRequestsResult
Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28834 28835 28836 28837 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28834 def describe_capacity_reservation_billing_requests(params = {}, = {}) req = build_request(:describe_capacity_reservation_billing_requests, params) req.send_request() end |
#describe_capacity_reservation_cancellation_quotes(params = {}) ⇒ Types::DescribeCapacityReservationCancellationQuotesResult
Describes one or more Capacity Reservation cancellation quotes. The
results describe only the quotes that you have previously generated by
using the CreateCapacityReservationCancellationQuote action.
28912 28913 28914 28915 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28912 def describe_capacity_reservation_cancellation_quotes(params = {}, = {}) req = build_request(:describe_capacity_reservation_cancellation_quotes, params) req.send_request() end |
#describe_capacity_reservation_date_change_quotes(params = {}) ⇒ Types::DescribeCapacityReservationDateChangeQuotesResult
Describes one or more Capacity Reservation date change quotes that you
generated by using the CreateCapacityReservationDateChangeQuote
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
28991 28992 28993 28994 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 28991 def describe_capacity_reservation_date_change_quotes(params = {}, = {}) req = build_request(:describe_capacity_reservation_date_change_quotes, 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.
29136 29137 29138 29139 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29136 def describe_capacity_reservation_fleets(params = {}, = {}) req = build_request(:describe_capacity_reservation_fleets, params) req.send_request() end |
#describe_capacity_reservation_topology(params = {}) ⇒ Types::DescribeCapacityReservationTopologyResult
Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the Amazon Web Services network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads.
Capacity Reservation topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide.
null value
for capacityBlockId because the data might not have fully propagated
across all subsystems. For more information, see Eventual consistency
in the Amazon EC2 API in the Amazon EC2 Developer Guide.
For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.
29254 29255 29256 29257 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29254 def describe_capacity_reservation_topology(params = {}, = {}) req = build_request(:describe_capacity_reservation_topology, 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.
29452 29453 29454 29455 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29452 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.
29537 29538 29539 29540 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29537 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.
29636 29637 29638 29639 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29636 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.
29709 29710 29711 29712 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29709 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.
29792 29793 29794 29795 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29792 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.
29910 29911 29912 29913 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29910 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.
29985 29986 29987 29988 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 29985 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.
30067 30068 30069 30070 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30067 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.
30139 30140 30141 30142 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30139 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
30223 30224 30225 30226 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30223 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
30340 30341 30342 30343 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30340 def describe_customer_gateways(params = {}, = {}) req = build_request(:describe_customer_gateways, params) req.send_request() end |
#describe_declarative_policies_reports(params = {}) ⇒ Types::DescribeDeclarativePoliciesReportsResult
Describes the metadata of an account status report, including the status of the report.
To view the full report, download it from the Amazon S3 bucket where
it was saved. Reports are accessible only when they have the
complete status. Reports with other statuses (running,
cancelled, or error) are not available in the S3 bucket. For more
information about downloading objects from an S3 bucket, see
Downloading objects in the Amazon Simple Storage Service User
Guide.
For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.
30420 30421 30422 30423 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30420 def describe_declarative_policies_reports(params = {}, = {}) req = build_request(:describe_declarative_policies_reports, 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.
30554 30555 30556 30557 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30554 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.
30638 30639 30640 30641 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30638 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.
30725 30726 30727 30728 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30725 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.
30794 30795 30796 30797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30794 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
30851 30852 30853 30854 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30851 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.
30932 30933 30934 30935 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 30932 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.
31018 31019 31020 31021 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31018 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.
31103 31104 31105 31106 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31103 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.
31187 31188 31189 31190 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31187 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.
31539 31540 31541 31542 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31539 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.
31657 31658 31659 31660 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31657 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).
31705 31706 31707 31708 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31705 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.
31825 31826 31827 31828 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31825 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.
31920 31921 31922 31923 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 31920 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.
32009 32010 32011 32012 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32009 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.
32127 32128 32129 32130 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32127 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.
32220 32221 32222 32223 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32220 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.
32285 32286 32287 32288 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32285 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.
32355 32356 32357 32358 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32355 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.
32474 32475 32476 32477 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32474 def describe_image_attribute(params = {}, = {}) req = build_request(:describe_image_attribute, params) req.send_request() end |
#describe_image_references(params = {}) ⇒ Types::DescribeImageReferencesResult
Describes your Amazon Web Services resources that are referencing the specified images.
For more information, see Identify your resources referencing specified AMIs in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
32574 32575 32576 32577 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32574 def describe_image_references(params = {}, = {}) req = build_request(:describe_image_references, params) req.send_request() end |
#describe_image_usage_report_entries(params = {}) ⇒ Types::DescribeImageUsageReportEntriesResult
Describes the entries in image usage reports, showing how your images are used across other Amazon Web Services accounts.
For more information, see View your AMI usage in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
32667 32668 32669 32670 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32667 def describe_image_usage_report_entries(params = {}, = {}) req = build_request(:describe_image_usage_report_entries, params) req.send_request() end |
#describe_image_usage_reports(params = {}) ⇒ Types::DescribeImageUsageReportsResult
Describes the configuration and status of image usage reports, filtered by report IDs or image IDs.
For more information, see View your AMI usage 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):
- image_usage_report_available
32783 32784 32785 32786 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 32783 def describe_image_usage_reports(params = {}, = {}) req = build_request(:describe_image_usage_reports, 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.
When Allowed AMIs is set to enabled, only allowed images are
returned in the results, with the imageAllowed field set to true
for each image. In audit-mode, the imageAllowed field is set to
true for images that meet the account's Allowed AMIs criteria, and
false for images that don't meet the criteria. For more
information, see Allowed AMIs.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer 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):
- image_available
- image_exists
33256 33257 33258 33259 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33256 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.
33345 33346 33347 33348 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33345 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
33425 33426 33427 33428 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33425 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. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.
33585 33586 33587 33588 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33585 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.
33701 33702 33703 33704 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33701 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 a burstable performance instance, Amazon
EC2 returns the standard credit option.
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.
33806 33807 33808 33809 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33806 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.
33840 33841 33842 33843 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33840 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.
33965 33966 33967 33968 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 33965 def describe_instance_event_windows(params = {}, = {}) req = build_request(:describe_instance_event_windows, params) req.send_request() end |
#describe_instance_image_metadata(params = {}) ⇒ Types::DescribeInstanceImageMetadataResult
Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.
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.
If you specify an instance ID that is not valid, an instance that
doesn't exist, or an instance that you do not own, an error
(InvalidInstanceID.NotFound) is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34133 34134 34135 34136 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34133 def (params = {}, = {}) req = build_request(:describe_instance_image_metadata, params) req.send_request() end |
#describe_instance_sql_ha_history_states(params = {}) ⇒ Types::DescribeInstanceSqlHaHistoryStatesResult
Describes the historical SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.
34237 34238 34239 34240 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34237 def describe_instance_sql_ha_history_states(params = {}, = {}) req = build_request(:describe_instance_sql_ha_history_states, params) req.send_request() end |
#describe_instance_sql_ha_states(params = {}) ⇒ Types::DescribeInstanceSqlHaStatesResult
Describes the SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.
34321 34322 34323 34324 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34321 def describe_instance_sql_ha_states(params = {}, = {}) req = build_request(:describe_instance_sql_ha_states, 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.
Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly.
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 Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer 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
34598 34599 34600 34601 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34598 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.
Instance topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide.
null value for
capacityBlockId because the data might not have fully propagated
across all subsystems. For more information, see Eventual consistency
in the Amazon EC2 API in the Amazon EC2 Developer Guide.
For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
34724 34725 34726 34727 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34724 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.
34816 34817 34818 34819 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 34816 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. To include instance types that are not supported in the
current Region, set IncludeUnsupportedInRegion to true.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
35203 35204 35205 35206 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 35203 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.
The response includes SQL license exemption status information for instances registered with the SQL LE service, providing visibility into license exemption configuration and status.
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.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer 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):
- instance_exists
- instance_running
- instance_stopped
- instance_terminated
36028 36029 36030 36031 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36028 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
36163 36164 36165 36166 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36163 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.
36217 36218 36219 36220 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36217 def describe_ipam_byoasn(params = {}, = {}) req = build_request(:describe_ipam_byoasn, params) req.send_request() end |
#describe_ipam_external_resource_verification_tokens(params = {}) ⇒ Types::DescribeIpamExternalResourceVerificationTokensResult
Describe verification tokens.
A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
36315 36316 36317 36318 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36315 def describe_ipam_external_resource_verification_tokens(params = {}, = {}) req = build_request(:describe_ipam_external_resource_verification_tokens, params) req.send_request() end |
#describe_ipam_internet_registry_associations(params = {}) ⇒ Types::DescribeIpamInternetRegistryAssociationsResult
Describes one or more IPAM internet registry associations. We recommend using pagination to ensure that the operation returns quickly and successfully.
36388 36389 36390 36391 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36388 def describe_ipam_internet_registry_associations(params = {}, = {}) req = build_request(:describe_ipam_internet_registry_associations, params) req.send_request() end |
#describe_ipam_policies(params = {}) ⇒ Types::DescribeIpamPoliciesResult
Describes one or more IPAM policies.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
36462 36463 36464 36465 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36462 def describe_ipam_policies(params = {}, = {}) req = build_request(:describe_ipam_policies, params) req.send_request() end |
#describe_ipam_pool_allocations(params = {}) ⇒ Types::DescribeIpamPoolAllocationsResult
Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID.
If you specify IpamPoolAllocationIds, the results include only the
specified allocations. If you do not specify IpamPoolAllocationIds,
the results include all allocations owned by you. You can use
Filters to narrow the results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36557 36558 36559 36560 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36557 def describe_ipam_pool_allocations(params = {}, = {}) req = build_request(:describe_ipam_pool_allocations, 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.
36655 36656 36657 36658 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36655 def describe_ipam_pools(params = {}, = {}) req = build_request(:describe_ipam_pools, params) req.send_request() end |
#describe_ipam_prefix_list_resolver_targets(params = {}) ⇒ Types::DescribeIpamPrefixListResolverTargetsResult
Describes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36738 36739 36740 36741 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36738 def describe_ipam_prefix_list_resolver_targets(params = {}, = {}) req = build_request(:describe_ipam_prefix_list_resolver_targets, params) req.send_request() end |
#describe_ipam_prefix_list_resolvers(params = {}) ⇒ Types::DescribeIpamPrefixListResolversResult
Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
36815 36816 36817 36818 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36815 def describe_ipam_prefix_list_resolvers(params = {}, = {}) req = build_request(:describe_ipam_prefix_list_resolvers, 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.
36888 36889 36890 36891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36888 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.
36961 36962 36963 36964 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 36961 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.
37043 37044 37045 37046 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37043 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.
37138 37139 37140 37141 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37138 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.
37213 37214 37215 37216 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37213 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 EC2 User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- key_pair_exists
37327 37328 37329 37330 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37327 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.
37731 37732 37733 37734 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37731 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.
37851 37852 37853 37854 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37851 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.
37939 37940 37941 37942 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 37939 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.
38026 38027 38028 38029 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38026 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.
38113 38114 38115 38116 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38113 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.
38194 38195 38196 38197 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38194 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.
38287 38288 38289 38290 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38287 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.
38362 38363 38364 38365 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38362 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.
38437 38438 38439 38440 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38437 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.
38500 38501 38502 38503 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38500 def describe_mac_hosts(params = {}, = {}) req = build_request(:describe_mac_hosts, params) req.send_request() end |
#describe_mac_modification_tasks(params = {}) ⇒ Types::DescribeMacModificationTasksResult
Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
38597 38598 38599 38600 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38597 def describe_mac_modification_tasks(params = {}, = {}) req = build_request(:describe_mac_modification_tasks, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
38676 38677 38678 38679 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38676 def describe_managed_prefix_lists(params = {}, = {}) req = build_request(:describe_managed_prefix_lists, params) req.send_request() end |
#describe_metric_categories(params = {}) ⇒ Types::DescribeMetricCategoriesResult
Describes the specified metric categories, or all of your metric categories.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
38760 38761 38762 38763 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38760 def describe_metric_categories(params = {}, = {}) req = build_request(:describe_metric_categories, 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.
38853 38854 38855 38856 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 38853 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
39021 39022 39023 39024 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39021 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.
39218 39219 39220 39221 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39218 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.
39303 39304 39305 39306 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39303 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.
39368 39369 39370 39371 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 39368 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.
40354 40355 40356 40357 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40354 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.
40468 40469 40470 40471 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40468 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.
40608 40609 40610 40611 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40608 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.
40687 40688 40689 40690 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 40687 def (params = {}, = {}) req = build_request(:describe_network_interface_permissions, params) req.send_request() end |
#describe_network_interfaces(params = {}) ⇒ Types::DescribeNetworkInterfacesResult
Describes the specified network interfaces or all 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:
attachment.instance-id, group-id, mac-address,
private-dns-name, private-ip-address, 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
41038 41039 41040 41041 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41038 def describe_network_interfaces(params = {}, = {}) req = build_request(:describe_network_interfaces, params) req.send_request() end |
#describe_networking_flex_cost_allocation_policies(params = {}) ⇒ Types::DescribeNetworkingFlexCostAllocationPoliciesResult
Describes one or more of your flex cost allocation policies. We recommend using pagination to ensure that the operation returns quickly and successfully.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41149 41150 41151 41152 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41149 def describe_networking_flex_cost_allocation_policies(params = {}, = {}) req = build_request(:describe_networking_flex_cost_allocation_policies, params) req.send_request() end |
#describe_networking_flex_cost_allocation_policy_associations(params = {}) ⇒ Types::DescribeNetworkingFlexCostAllocationPolicyAssociationsResult
Describes the associations between your flex cost allocation policies and network resources. We recommend using pagination to ensure that the operation returns quickly and successfully.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41226 41227 41228 41229 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41226 def describe_networking_flex_cost_allocation_policy_associations(params = {}, = {}) req = build_request(:describe_networking_flex_cost_allocation_policy_associations, params) req.send_request() end |
#describe_outpost_lags(params = {}) ⇒ Types::DescribeOutpostLagsResult
Describes the Outposts link aggregation groups (LAGs).
41325 41326 41327 41328 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41325 def describe_outpost_lags(params = {}, = {}) req = build_request(:describe_outpost_lags, params) req.send_request() end |
#describe_placement_groups(params = {}) ⇒ Types::DescribePlacementGroupsResult
Describes the specified placement groups or all of your placement groups.
GroupId parameter. Specifying the name of a shared placement group
using the GroupNames parameter will result in an error.
For more information, see Placement groups in the Amazon EC2 User Guide.
41435 41436 41437 41438 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41435 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
41503 41504 41505 41506 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41503 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.
41585 41586 41587 41588 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41585 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.
41659 41660 41661 41662 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41659 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.
41800 41801 41802 41803 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41800 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.
41884 41885 41886 41887 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 41884 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.
42027 42028 42029 42030 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42027 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.
42128 42129 42130 42131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42128 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.
42242 42243 42244 42245 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42242 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.
42458 42459 42460 42461 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42458 def describe_reserved_instances_offerings(params = {}, = {}) req = build_request(:describe_reserved_instances_offerings, params) req.send_request() end |
#describe_route_server_endpoints(params = {}) ⇒ Types::DescribeRouteServerEndpointsResult
Describes one or more route server endpoints.
A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42537 42538 42539 42540 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42537 def describe_route_server_endpoints(params = {}, = {}) req = build_request(:describe_route_server_endpoints, params) req.send_request() end |
#describe_route_server_peers(params = {}) ⇒ Types::DescribeRouteServerPeersResult
Describes one or more route server peers.
A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:
Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42628 42629 42630 42631 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42628 def describe_route_server_peers(params = {}, = {}) req = build_request(:describe_route_server_peers, params) req.send_request() end |
#describe_route_servers(params = {}) ⇒ Types::DescribeRouteServersResult
Describes one or more route servers.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
42723 42724 42725 42726 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42723 def describe_route_servers(params = {}, = {}) req = build_request(:describe_route_servers, 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.
42947 42948 42949 42950 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 42947 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.
43066 43067 43068 43069 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43066 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.
43160 43161 43162 43163 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43160 def describe_scheduled_instances(params = {}, = {}) req = build_request(:describe_scheduled_instances, params) req.send_request() end |
#describe_secondary_interfaces(params = {}) ⇒ Types::DescribeSecondaryInterfacesResult
Describes one or more of your secondary interfaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
43396 43397 43398 43399 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43396 def describe_secondary_interfaces(params = {}, = {}) req = build_request(:describe_secondary_interfaces, params) req.send_request() end |
#describe_secondary_networks(params = {}) ⇒ Types::DescribeSecondaryNetworksResult
Describes one or more secondary networks.
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):
- secondary_network_create_complete
- secondary_network_delete_complete
43614 43615 43616 43617 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43614 def describe_secondary_networks(params = {}, = {}) req = build_request(:describe_secondary_networks, params) req.send_request() end |
#describe_secondary_subnets(params = {}) ⇒ Types::DescribeSecondarySubnetsResult
Describes one or more of your secondary subnets.
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):
- secondary_subnet_create_complete
- secondary_subnet_delete_complete
43794 43795 43796 43797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43794 def describe_secondary_subnets(params = {}, = {}) req = build_request(:describe_secondary_subnets, params) req.send_request() end |
#describe_security_group_references(params = {}) ⇒ Types::DescribeSecurityGroupReferencesResult
Describes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request.
43857 43858 43859 43860 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43857 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.
43952 43953 43954 43955 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 43952 def describe_security_group_rules(params = {}, = {}) req = build_request(:describe_security_group_rules, params) req.send_request() end |
#describe_security_group_vpc_associations(params = {}) ⇒ Types::DescribeSecurityGroupVpcAssociationsResult
Describes security group VPC associations made with AssociateSecurityGroupVpc.
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_vpc_association_associated
- security_group_vpc_association_disassociated
44038 44039 44040 44041 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44038 def describe_security_group_vpc_associations(params = {}, = {}) req = build_request(:describe_security_group_vpc_associations, 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
44284 44285 44286 44287 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44284 def describe_security_groups(params = {}, = {}) req = build_request(:describe_security_groups, params) req.send_request() end |
#describe_service_link_virtual_interfaces(params = {}) ⇒ Types::DescribeServiceLinkVirtualInterfacesResult
Describes the Outpost service link virtual interfaces.
44372 44373 44374 44375 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44372 def describe_service_link_virtual_interfaces(params = {}, = {}) req = build_request(:describe_service_link_virtual_interfaces, 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.
44445 44446 44447 44448 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44445 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.
44529 44530 44531 44532 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44529 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
allgroup. 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.
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
44800 44801 44802 44803 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44800 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.
44859 44860 44861 44862 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44859 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.
44938 44939 44940 44941 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 44938 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.
45072 45073 45074 45075 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45072 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.
45402 45403 45404 45405 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45402 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
45764 45765 45766 45767 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45764 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.
45932 45933 45934 45935 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 45932 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 referenced across a VPC peering connection, transit gateway connection, or with a security group VPC association. Rules are stale when they reference a deleted security group. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted, across a transit gateway where the transit gateway has been deleted (or the transit gateway security group referencing feature has been disabled), or if a security group VPC association has been disassociated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
46034 46035 46036 46037 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46034 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 S3 in the Amazon EC2 User Guide.
For more information, see Store and restore an AMI using 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
46146 46147 46148 46149 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46146 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
46376 46377 46378 46379 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46376 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.
46507 46508 46509 46510 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46507 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.
46608 46609 46610 46611 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46608 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.
46711 46712 46713 46714 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46711 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.
46804 46805 46806 46807 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46804 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.
46885 46886 46887 46888 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46885 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.
46987 46988 46989 46990 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 46987 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.
47070 47071 47072 47073 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47070 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.
47151 47152 47153 47154 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47151 def describe_transit_gateway_connects(params = {}, = {}) req = build_request(:describe_transit_gateway_connects, params) req.send_request() end |
#describe_transit_gateway_metering_policies(params = {}) ⇒ Types::DescribeTransitGatewayMeteringPoliciesResult
Describes one or more transit gateway metering policies.
47217 47218 47219 47220 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47217 def describe_transit_gateway_metering_policies(params = {}, = {}) req = build_request(:describe_transit_gateway_metering_policies, 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.
47295 47296 47297 47298 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47295 def describe_transit_gateway_multicast_domains(params = {}, = {}) req = build_request(:describe_transit_gateway_multicast_domains, params) req.send_request() end |
#describe_transit_gateway_network_function_attachments(params = {}) ⇒ Types::DescribeTransitGatewayNetworkFunctionAttachmentsResult
Describes one or more network function attachments. You can describe attachments that you own or that are attached to a transit gateway that you own.
47379 47380 47381 47382 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47379 def (params = {}, = {}) req = build_request(:describe_transit_gateway_network_function_attachments, 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.
47480 47481 47482 47483 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47480 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.
47545 47546 47547 47548 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47545 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.
47616 47617 47618 47619 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47616 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.
47701 47702 47703 47704 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47701 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.
47786 47787 47788 47789 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47786 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.
47909 47910 47911 47912 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47909 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.
47981 47982 47983 47984 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 47981 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.
48098 48099 48100 48101 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48098 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.
48173 48174 48175 48176 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48173 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.
48248 48249 48250 48251 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48248 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.
48323 48324 48325 48326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48323 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.
48411 48412 48413 48414 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48411 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.
48482 48483 48484 48485 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48482 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 and then check the volume for data
consistency. For more information, see Work with an impaired EBS
volume.
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.
48732 48733 48734 48735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 48732 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
49009 49010 49011 49012 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49009 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.
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.
49132 49133 49134 49135 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49132 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.
49216 49217 49218 49219 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49216 def describe_vpc_attribute(params = {}, = {}) req = build_request(:describe_vpc_attribute, params) req.send_request() end |
#describe_vpc_block_public_access_exclusions(params = {}) ⇒ Types::DescribeVpcBlockPublicAccessExclusionsResult
Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
49323 49324 49325 49326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49323 def describe_vpc_block_public_access_exclusions(params = {}, = {}) req = build_request(:describe_vpc_block_public_access_exclusions, params) req.send_request() end |
#describe_vpc_block_public_access_options(params = {}) ⇒ Types::DescribeVpcBlockPublicAccessOptionsResult
Describe VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
49370 49371 49372 49373 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49370 def (params = {}, = {}) req = build_request(:describe_vpc_block_public_access_options, params) req.send_request() end |
#describe_vpc_classic_link(params = {}) ⇒ Types::DescribeVpcClassicLinkResult
Describes the ClassicLink status of the specified VPCs.
49436 49437 49438 49439 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49436 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.
49494 49495 49496 49497 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49494 def describe_vpc_classic_link_dns_support(params = {}, = {}) req = build_request(:describe_vpc_classic_link_dns_support, params) req.send_request() end |
#describe_vpc_encryption_controls(params = {}) ⇒ Types::DescribeVpcEncryptionControlsResult
Describes one or more VPC Encryption Control configurations. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements You can filter the results to return information about specific encryption controls or VPCs.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
49598 49599 49600 49601 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49598 def describe_vpc_encryption_controls(params = {}, = {}) req = build_request(:describe_vpc_encryption_controls, params) req.send_request() end |
#describe_vpc_endpoint_associations(params = {}) ⇒ Types::DescribeVpcEndpointAssociationsResult
Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.
49687 49688 49689 49690 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49687 def describe_vpc_endpoint_associations(params = {}, = {}) req = build_request(:describe_vpc_endpoint_associations, 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.
49769 49770 49771 49772 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49769 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.
49868 49869 49870 49871 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49868 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.
49981 49982 49983 49984 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 49981 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. Principal ARNs with path components aren't supported.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
50059 50060 50061 50062 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50059 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.
50182 50183 50184 50185 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50182 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.
50323 50324 50325 50326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50323 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
50464 50465 50466 50467 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50464 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
50666 50667 50668 50669 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50666 def describe_vpcs(params = {}, = {}) req = build_request(:describe_vpcs, params) req.send_request() end |
#describe_vpn_concentrators(params = {}) ⇒ Types::DescribeVpnConcentratorsResult
Describes one or more of your VPN concentrators.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
50732 50733 50734 50735 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50732 def describe_vpn_concentrators(params = {}, = {}) req = build_request(:describe_vpn_concentrators, 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
50902 50903 50904 50905 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50902 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.
50996 50997 50998 50999 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 50996 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.
51042 51043 51044 51045 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51042 def detach_classic_link_vpc(params = {}, = {}) req = build_request(:detach_classic_link_vpc, params) req.send_request() end |
#detach_image_watermark(params = {}) ⇒ Types::DetachImageWatermarkResult
Removes a watermark from the specified AMI. This is an idempotent operation. It succeeds even if the watermark does not exist on the image.
Removing a watermark from an image does not affect derivative images that already carry the watermark.
Only the AMI owner can detach watermarks.
51089 51090 51091 51092 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51089 def detach_image_watermark(params = {}, = {}) req = build_request(:detach_image_watermark, 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.
51134 51135 51136 51137 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51134 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.
51196 51197 51198 51199 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51196 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.
51296 51297 51298 51299 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51296 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
Web Services-managed resources. Attempting to do this results in the
UnsupportedOperationException exception.
For more information, see Detach an Amazon EBS volume in the Amazon EBS User Guide.
51407 51408 51409 51410 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51407 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.
51448 51449 51450 51451 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51448 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.
51493 51494 51495 51496 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51493 def disable_address_transfer(params = {}, = {}) req = build_request(:disable_address_transfer, params) req.send_request() end |
#disable_allowed_images_settings(params = {}) ⇒ Types::DisableAllowedImagesSettingsResult
Disables Allowed AMIs for your account in the specified Amazon Web
Services Region. When set to disabled, the image criteria in your
Allowed AMIs settings do not apply, and no restrictions are placed on
AMI discoverability or usage. Users in your account can launch
instances using any public AMI or AMI shared with your account.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
51542 51543 51544 51545 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51542 def disable_allowed_images_settings(params = {}, = {}) req = build_request(:disable_allowed_images_settings, params) req.send_request() end |
#disable_application_status_check_suppression(params = {}) ⇒ Types::DisableApplicationStatusCheckSuppressionResult
Disables suppression of application status checks for the specified instances. After suppression is disabled, health check results resume affecting the instance-level application status. You can specify a maximum of 100 instance IDs for each request.
51626 51627 51628 51629 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51626 def disable_application_status_check_suppression(params = {}, = {}) req = build_request(:disable_application_status_check_suppression, params) req.send_request() end |
#disable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::DisableAwsNetworkPerformanceMetricSubscriptionResult
Disables Infrastructure Performance metric subscriptions.
51675 51676 51677 51678 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51675 def disable_aws_network_performance_metric_subscription(params = {}, = {}) req = build_request(:disable_aws_network_performance_metric_subscription, params) req.send_request() end |
#disable_capacity_manager(params = {}) ⇒ Types::DisableCapacityManagerResult
Disables EC2 Capacity Manager for your account. This stops data ingestion and removes access to capacity analytics and optimization recommendations. Previously collected data is retained but no new data will be processed.
51719 51720 51721 51722 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51719 def disable_capacity_manager(params = {}, = {}) req = build_request(:disable_capacity_manager, 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.
51764 51765 51766 51767 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51764 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.
51832 51833 51834 51835 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51832 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.
51903 51904 51905 51906 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51903 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.
51960 51961 51962 51963 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 51960 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.
For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.
52002 52003 52004 52005 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52002 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 Amazon EC2 AMI in the Amazon EC2 User Guide.
52044 52045 52046 52047 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52044 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 Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.
52092 52093 52094 52095 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52092 def disable_image_deregistration_protection(params = {}, = {}) req = build_request(:disable_image_deregistration_protection, params) req.send_request() end |
#disable_instance_sql_ha_standby_detections(params = {}) ⇒ Types::DisableInstanceSqlHaStandbyDetectionsResult
Disable Amazon EC2 instances running in an SQL Server High Availability cluster from SQL Server High Availability instance standby detection monitoring. Once disabled, Amazon Web Services no longer monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster.
52142 52143 52144 52145 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52142 def disable_instance_sql_ha_standby_detections(params = {}, = {}) req = build_request(:disable_instance_sql_ha_standby_detections, 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.
52184 52185 52186 52187 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52184 def disable_ipam_organization_admin_account(params = {}, = {}) req = build_request(:disable_ipam_organization_admin_account, params) req.send_request() end |
#disable_ipam_policy(params = {}) ⇒ Types::DisableIpamPolicyResult
Disables an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
52241 52242 52243 52244 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52241 def disable_ipam_policy(params = {}, = {}) req = build_request(:disable_ipam_policy, params) req.send_request() end |
#disable_route_server_propagation(params = {}) ⇒ Types::DisableRouteServerPropagationResult
Disables route propagation from a route server to a specified route table.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
52317 52318 52319 52320 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52317 def disable_route_server_propagation(params = {}, = {}) req = build_request(:disable_route_server_propagation, 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.
52355 52356 52357 52358 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52355 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.
Enabling block public access for snapshots in block-all-sharing mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.
If you disable block public access , these snapshots will become publicly available again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide .
52408 52409 52410 52411 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52408 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.
52457 52458 52459 52460 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52457 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.
52501 52502 52503 52504 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52501 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.
52541 52542 52543 52544 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52541 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.
52577 52578 52579 52580 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52577 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.
An address cannot be disassociated if the all of the following conditions are met:
Network interface has a
publicDualStackDnsNamepublicDnsNamePublic IPv4 address is the primary public IPv4 address
Network interface only has one remaining public IPv4 address
52632 52633 52634 52635 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52632 def disassociate_address(params = {}, = {}) req = build_request(:disassociate_address, params) req.send_request() end |
#disassociate_application_status_check(params = {}) ⇒ Types::DisassociateApplicationStatusCheckResult
Disassociates an application status check from instances or tags. After disassociation, health monitoring stops for the affected instances. The following rules apply:
You must specify either
TargetTagAssociationsorInstanceIds, but not both. Specifying both results in anInvalidParameterCombinationerror.The application status check must already exist and belong to your account.
Tag keys must not be blank.
52752 52753 52754 52755 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52752 def disassociate_application_status_check(params = {}, = {}) req = build_request(:disassociate_application_status_check, params) req.send_request() end |
#disassociate_capacity_reservation_billing_owner(params = {}) ⇒ Types::DisassociateCapacityReservationBillingOwnerResult
Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
52798 52799 52800 52801 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52798 def disassociate_capacity_reservation_billing_owner(params = {}, = {}) req = build_request(:disassociate_capacity_reservation_billing_owner, 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
52851 52852 52853 52854 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52851 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.
52897 52898 52899 52900 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52897 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.
52955 52956 52957 52958 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 52955 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.
53028 53029 53030 53031 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53028 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.
53077 53078 53079 53080 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53077 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.
53126 53127 53128 53129 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53126 def disassociate_ipam_resource_discovery(params = {}, = {}) req = build_request(:disassociate_ipam_resource_discovery, params) req.send_request() end |
#disassociate_kms_key_id(params = {}) ⇒ Types::DisassociateKmsKeyIdResult
Removes an associated KMS key from an Amazon EBS snapshot. After you disassociate the key, it can no longer be used to access the snapshot's data. The snapshot's original encryption key is unaffected.
53169 53170 53171 53172 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53169 def disassociate_kms_key_id(params = {}, = {}) req = build_request(:disassociate_kms_key_id, 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.
53245 53246 53247 53248 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53245 def disassociate_nat_gateway_address(params = {}, = {}) req = build_request(:disassociate_nat_gateway_address, params) req.send_request() end |
#disassociate_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::DisassociateNetworkingFlexCostAllocationPolicyResult
Disassociates a flex cost allocation policy from one or more network resources.
53288 53289 53290 53291 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53288 def disassociate_networking_flex_cost_allocation_policy(params = {}, = {}) req = build_request(:disassociate_networking_flex_cost_allocation_policy, params) req.send_request() end |
#disassociate_route_server(params = {}) ⇒ Types::DisassociateRouteServerResult
Disassociates a route server from a VPC.
A route server association is the connection established between a route server and a VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
53339 53340 53341 53342 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53339 def disassociate_route_server(params = {}, = {}) req = build_request(:disassociate_route_server, 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.
53387 53388 53389 53390 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53387 def disassociate_route_table(params = {}, = {}) req = build_request(:disassociate_route_table, params) req.send_request() end |
#disassociate_security_group_vpc(params = {}) ⇒ Types::DisassociateSecurityGroupVpcResult
Disassociates a security group from a VPC. You cannot disassociate the security group if any Elastic network interfaces in the associated VPC are still associated with the security group. Note that the disassociation is asynchronous and you can check the status of the request with DescribeSecurityGroupVpcAssociations.
53434 53435 53436 53437 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53434 def disassociate_security_group_vpc(params = {}, = {}) req = build_request(:disassociate_security_group_vpc, 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.
53472 53473 53474 53475 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53472 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.
53523 53524 53525 53526 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53523 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.
53567 53568 53569 53570 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53567 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.
53611 53612 53613 53614 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53611 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.
53662 53663 53664 53665 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53662 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).
53711 53712 53713 53714 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53711 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.
53761 53762 53763 53764 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53761 def enable_address_transfer(params = {}, = {}) req = build_request(:enable_address_transfer, params) req.send_request() end |
#enable_allowed_images_settings(params = {}) ⇒ Types::EnableAllowedImagesSettingsResult
Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are accepted:
enabled: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances.audit-mode: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account.The purpose of
audit-modeis to indicate which AMIs will be affected when Allowed AMIs isenabled. Inaudit-mode, each AMI displays either"ImageAllowed": trueor"ImageAllowed": falseto indicate whether the AMI will be discoverable and available to users in the account when Allowed AMIs is enabled.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
53828 53829 53830 53831 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53828 def enable_allowed_images_settings(params = {}, = {}) req = build_request(:enable_allowed_images_settings, params) req.send_request() end |
#enable_application_status_check_suppression(params = {}) ⇒ Types::EnableApplicationStatusCheckSuppressionResult
Suppresses application status checks for the specified instances. While suppressed, health checks continue to run but do not affect the instance-level application status. The following rules apply:
You can specify a maximum of 100 instance IDs for each request.
Use
DisableApplicationStatusCheckSuppressionto resume normal health check reporting.If you do not specify
DurationSeconds, suppression continues indefinitely until you callDisableApplicationStatusCheckSuppression.
53929 53930 53931 53932 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53929 def enable_application_status_check_suppression(params = {}, = {}) req = build_request(:enable_application_status_check_suppression, params) req.send_request() end |
#enable_aws_network_performance_metric_subscription(params = {}) ⇒ Types::EnableAwsNetworkPerformanceMetricSubscriptionResult
Enables Infrastructure Performance subscriptions.
53982 53983 53984 53985 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 53982 def enable_aws_network_performance_metric_subscription(params = {}, = {}) req = build_request(:enable_aws_network_performance_metric_subscription, params) req.send_request() end |
#enable_capacity_manager(params = {}) ⇒ Types::EnableCapacityManagerResult
Enables EC2 Capacity Manager for your account. This starts data ingestion for your EC2 capacity usage across On-Demand, Spot, and Capacity Reservations. Initial data processing may take several hours to complete.
54032 54033 54034 54035 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54032 def enable_capacity_manager(params = {}, = {}) req = build_request(:enable_capacity_manager, 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.
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.
54082 54083 54084 54085 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54082 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.
54176 54177 54178 54179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54176 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.
For more information, see Amazon EBS fast snapshot restore in the Amazon EBS User Guide.
54258 54259 54260 54261 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54258 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 Amazon EC2 AMI in the Amazon EC2 User Guide.
54307 54308 54309 54310 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54307 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.
54360 54361 54362 54363 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54360 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.
54413 54414 54415 54416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54413 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.
For more information, see Protect an Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.
54464 54465 54466 54467 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54464 def enable_image_deregistration_protection(params = {}, = {}) req = build_request(:enable_image_deregistration_protection, params) req.send_request() end |
#enable_instance_sql_ha_standby_detections(params = {}) ⇒ Types::EnableInstanceSqlHaStandbyDetectionsResult
Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring. Once enabled, Amazon Web Services monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster. If the instances are determined to be standby failover nodes, Amazon Web Services automatically applies SQL Server licensing fee waiver for those instances.
To register an instance, it must be running a Windows SQL Server license-included AMI and have the Amazon Web Services Systems Manager agent installed and running. Only Windows Server 2019 and later and SQL Server (Standard and Enterprise editions) 2017 and later are supported. For more information, see Prerequisites for using SQL Server High Availability instance standby detection.
54536 54537 54538 54539 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54536 def enable_instance_sql_ha_standby_detections(params = {}, = {}) req = build_request(:enable_instance_sql_ha_standby_detections, params) req.send_request() end |
#enable_ipam_internet_registry_association(params = {}) ⇒ Types::EnableIpamInternetRegistryAssociationResult
Enables Resource Public Key Infrastructure (RPKI) on an existing IPAM internet registry association by providing BGP Public Key Infrastructure (BPKI) certificate details. After enabling, you can create Route Origin Authorizations (ROAs) for prefixes registered with the internet registry.
54622 54623 54624 54625 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54622 def enable_ipam_internet_registry_association(params = {}, = {}) req = build_request(:enable_ipam_internet_registry_association, 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.
54665 54666 54667 54668 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54665 def enable_ipam_organization_admin_account(params = {}, = {}) req = build_request(:enable_ipam_organization_admin_account, params) req.send_request() end |
#enable_ipam_policy(params = {}) ⇒ Types::EnableIpamPolicyResult
Enables an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
For more information, see Define public IPv4 allocation strategy with IPAM policies in the Amazon VPC IPAM User Guide.
54729 54730 54731 54732 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54729 def enable_ipam_policy(params = {}, = {}) req = build_request(:enable_ipam_policy, 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.
54766 54767 54768 54769 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54766 def enable_reachability_analyzer_organization_sharing(params = {}, = {}) req = build_request(:enable_reachability_analyzer_organization_sharing, params) req.send_request() end |
#enable_route_server_propagation(params = {}) ⇒ Types::EnableRouteServerPropagationResult
Defines which route tables the route server can update with routes.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
54818 54819 54820 54821 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54818 def enable_route_server_propagation(params = {}, = {}) req = build_request(:enable_route_server_propagation, 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.
54856 54857 54858 54859 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54856 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.
Enabling block public access for snapshots in block all sharing mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.
If you later disable block public access or change the mode to block new sharing, these snapshots will become publicly available again.
For more information, see Block public access for snapshots in the Amazon EBS User Guide.
54928 54929 54930 54931 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54928 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.
54977 54978 54979 54980 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 54977 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.
55024 55025 55026 55027 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55024 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.
55063 55064 55065 55066 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55063 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.
55107 55108 55109 55110 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55107 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.
55146 55147 55148 55149 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55146 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.
55185 55186 55187 55188 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55185 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.
55224 55225 55226 55227 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55224 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.
55330 55331 55332 55333 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55330 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.
55415 55416 55417 55418 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55415 def export_transit_gateway_routes(params = {}, = {}) req = build_request(:export_transit_gateway_routes, params) req.send_request() end |
#export_verified_access_instance_client_configuration(params = {}) ⇒ Types::ExportVerifiedAccessInstanceClientConfigurationResult
Exports the client configuration for a Verified Access instance.
55473 55474 55475 55476 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55473 def export_verified_access_instance_client_configuration(params = {}, = {}) req = build_request(:export_verified_access_instance_client_configuration, params) req.send_request() end |
#get_active_vpn_tunnel_status(params = {}) ⇒ Types::GetActiveVpnTunnelStatusResult
Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.
55522 55523 55524 55525 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55522 def get_active_vpn_tunnel_status(params = {}, = {}) req = build_request(:get_active_vpn_tunnel_status, params) req.send_request() end |
#get_allowed_images_settings(params = {}) ⇒ Types::GetAllowedImagesSettingsResult
Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
55592 55593 55594 55595 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55592 def get_allowed_images_settings(params = {}, = {}) req = build_request(:get_allowed_images_settings, 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.
55636 55637 55638 55639 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55636 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.
55688 55689 55690 55691 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55688 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.
55769 55770 55771 55772 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55769 def get_aws_network_performance_data(params = {}, = {}) req = build_request(:get_aws_network_performance_data, params) req.send_request() end |
#get_capacity_manager_attributes(params = {}) ⇒ Types::GetCapacityManagerAttributesResult
Retrieves the current configuration and status of EC2 Capacity Manager for your account, including enablement status, Organizations access settings, and data ingestion status.
55814 55815 55816 55817 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55814 def get_capacity_manager_attributes(params = {}, = {}) req = build_request(:get_capacity_manager_attributes, params) req.send_request() end |
#get_capacity_manager_metric_data(params = {}) ⇒ Types::GetCapacityManagerMetricDataResult
Retrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
55928 55929 55930 55931 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 55928 def get_capacity_manager_metric_data(params = {}, = {}) req = build_request(:get_capacity_manager_metric_data, params) req.send_request() end |
#get_capacity_manager_metric_dimensions(params = {}) ⇒ Types::GetCapacityManagerMetricDimensionsResult
Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
56033 56034 56035 56036 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56033 def get_capacity_manager_metric_dimensions(params = {}, = {}) req = build_request(:get_capacity_manager_metric_dimensions, params) req.send_request() end |
#get_capacity_manager_monitored_tag_keys(params = {}) ⇒ Types::GetCapacityManagerMonitoredTagKeysResult
Retrieves the tag keys that are currently being monitored by EC2 Capacity Manager. Monitored tag keys are included as dimensions in capacity metric data, enabling you to group and filter metrics by tag values.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
56087 56088 56089 56090 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56087 def get_capacity_manager_monitored_tag_keys(params = {}, = {}) req = build_request(:get_capacity_manager_monitored_tag_keys, params) req.send_request() end |
#get_capacity_manager_supportability_scores(params = {}) ⇒ Types::GetCapacityManagerSupportabilityScoresResult
Scores how well each instance type and Availability Zone combination can support a capacity request, based on current Amazon EC2 capacity. The response includes a score for each combination and an aggregate score for all combinations in the request. This action doesn't launch or reserve instances, and a score doesn't guarantee that a later launch will succeed.
Call this action in the Region where you turned on Capacity Manager. A single request can include Availability Zones in any Region. Real-time supportability checks are available only to Amazon Web Services Support customers on the Unified Operations plan.
For more information, see Check supportability in the Amazon EC2 User Guide.
56241 56242 56243 56244 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56241 def get_capacity_manager_supportability_scores(params = {}, = {}) req = build_request(:get_capacity_manager_supportability_scores, 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.
56320 56321 56322 56323 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56320 def get_capacity_reservation_usage(params = {}, = {}) req = build_request(:get_capacity_reservation_usage, params) req.send_request() end |
#get_client_vpn_endpoint_authorization_policy(params = {}) ⇒ Types::GetClientVpnEndpointAuthorizationPolicyResult
Describes the authorization policy for a Client VPN endpoint.
56363 56364 56365 56366 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56363 def (params = {}, = {}) req = build_request(:get_client_vpn_endpoint_authorization_policy, params) req.send_request() end |
#get_coip_pool_usage(params = {}) ⇒ Types::GetCoipPoolUsageResult
Describes the allocations from the specified customer-owned address pool.
56439 56440 56441 56442 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56439 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.
For more information, see Instance console output in the Amazon EC2 User Guide.
56511 56512 56513 56514 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56511 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.
56563 56564 56565 56566 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56563 def get_console_screenshot(params = {}, = {}) req = build_request(:get_console_screenshot, params) req.send_request() end |
#get_declarative_policies_report_summary(params = {}) ⇒ Types::GetDeclarativePoliciesReportSummaryResult
Retrieves a summary of the account status report.
To view the full report, download it from the Amazon S3 bucket where
it was saved. Reports are accessible only when they have the
complete status. Reports with other statuses (running,
cancelled, or error) are not available in the S3 bucket. For more
information about downloading objects from an S3 bucket, see
Downloading objects in the Amazon Simple Storage Service User
Guide.
For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.
56639 56640 56641 56642 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56639 def get_declarative_policies_report_summary(params = {}, = {}) req = build_request(:get_declarative_policies_report_summary, 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.
56683 56684 56685 56686 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56683 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.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
56722 56723 56724 56725 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56722 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.
56763 56764 56765 56766 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56763 def get_ebs_encryption_by_default(params = {}, = {}) req = build_request(:get_ebs_encryption_by_default, params) req.send_request() end |
#get_enabled_ipam_policy(params = {}) ⇒ Types::GetEnabledIpamPolicyResult
Gets the enabled IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
56808 56809 56810 56811 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56808 def get_enabled_ipam_policy(params = {}, = {}) req = build_request(:get_enabled_ipam_policy, 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 or Amazon Web Services
Cloud WAN Flow Logs and Amazon Athena.
56881 56882 56883 56884 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56881 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.
56939 56940 56941 56942 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56939 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.
56992 56993 56994 56995 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 56992 def get_host_reservation_purchase_preview(params = {}, = {}) req = build_request(:get_host_reservation_purchase_preview, params) req.send_request() end |
#get_image_ancestry(params = {}) ⇒ Types::GetImageAncestryResult
Retrieves the ancestry chain of the specified AMI, tracing its lineage back to the root AMI. For more information, see AMI ancestry in Amazon EC2 User Guide.
57038 57039 57040 57041 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57038 def get_image_ancestry(params = {}, = {}) req = build_request(:get_image_ancestry, 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.
57079 57080 57081 57082 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57079 def get_image_block_public_access_state(params = {}, = {}) req = build_request(:get_image_block_public_access_state, params) req.send_request() end |
#get_image_findings(params = {}) ⇒ Types::GetImageFindingsResult
Describes the Amazon Inspector vulnerability findings for the specified AMI.
You can get findings for AMIs that you own, AMIs that are shared with you, and public AMIs. Amazon Inspector returns findings only for AMIs that it has scanned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
57147 57148 57149 57150 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57147 def get_image_findings(params = {}, = {}) req = build_request(:get_image_findings, 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.
57192 57193 57194 57195 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57192 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.
57245 57246 57247 57248 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57245 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, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating mixed instance groups 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.
57396 57397 57398 57399 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57396 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.
57452 57453 57454 57455 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57452 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.
57538 57539 57540 57541 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57538 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.
57612 57613 57614 57615 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57612 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.
57696 57697 57698 57699 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57696 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.
57777 57778 57779 57780 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57777 def get_ipam_discovered_resource_cidrs(params = {}, = {}) req = build_request(:get_ipam_discovered_resource_cidrs, params) req.send_request() end |
#get_ipam_discovered_routes(params = {}) ⇒ Types::GetIpamDiscoveredRoutesResult
Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.
57853 57854 57855 57856 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57853 def get_ipam_discovered_routes(params = {}, = {}) req = build_request(:get_ipam_discovered_routes, params) req.send_request() end |
#get_ipam_internet_registry_association_asns(params = {}) ⇒ Types::GetIpamInternetRegistryAssociationAsnsResult
Retrieves Autonomous System Numbers (ASNs) registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
57915 57916 57917 57918 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57915 def get_ipam_internet_registry_association_asns(params = {}, = {}) req = build_request(:get_ipam_internet_registry_association_asns, params) req.send_request() end |
#get_ipam_internet_registry_association_cidrs(params = {}) ⇒ Types::GetIpamInternetRegistryAssociationCidrsResult
Retrieves IP address CIDRs registered with an internet registry for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
57976 57977 57978 57979 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 57976 def get_ipam_internet_registry_association_cidrs(params = {}, = {}) req = build_request(:get_ipam_internet_registry_association_cidrs, params) req.send_request() end |
#get_ipam_policy_allocation_rules(params = {}) ⇒ Types::GetIpamPolicyAllocationRulesResult
Gets the allocation rules for an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.
58066 58067 58068 58069 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58066 def get_ipam_policy_allocation_rules(params = {}, = {}) req = build_request(:get_ipam_policy_allocation_rules, params) req.send_request() end |
#get_ipam_policy_organization_targets(params = {}) ⇒ Types::GetIpamPolicyOrganizationTargetsResult
Gets the Amazon Web Services Organizations targets for an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.
58136 58137 58138 58139 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58136 def get_ipam_policy_organization_targets(params = {}, = {}) req = build_request(:get_ipam_policy_organization_targets, 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.
58225 58226 58227 58228 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58225 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.
58298 58299 58300 58301 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58298 def get_ipam_pool_cidrs(params = {}, = {}) req = build_request(:get_ipam_pool_cidrs, params) req.send_request() end |
#get_ipam_prefix_list_resolver_rules(params = {}) ⇒ Types::GetIpamPrefixListResolverRulesResult
Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
58376 58377 58378 58379 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58376 def get_ipam_prefix_list_resolver_rules(params = {}, = {}) req = build_request(:get_ipam_prefix_list_resolver_rules, params) req.send_request() end |
#get_ipam_prefix_list_resolver_version_entries(params = {}) ⇒ Types::GetIpamPrefixListResolverVersionEntriesResult
Retrieves the CIDR entries for a specific version of an IPAM prefix list resolver. This shows the actual CIDRs that were selected and synchronized at a particular point in time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
58438 58439 58440 58441 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58438 def get_ipam_prefix_list_resolver_version_entries(params = {}, = {}) req = build_request(:get_ipam_prefix_list_resolver_version_entries, params) req.send_request() end |
#get_ipam_prefix_list_resolver_versions(params = {}) ⇒ Types::GetIpamPrefixListResolverVersionsResult
Retrieves version information for an IPAM prefix list resolver.
Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes.
Version example:
Initial State (Version 1)
Production environment:
vpc-prod-web (10.1.0.0/16) - tagged env=prod
vpc-prod-db (10.2.0.0/16) - tagged env=prod
Resolver rule: Include all VPCs tagged env=prod
Version 1 CIDRs: 10.1.0.0/16, 10.2.0.0/16
Infrastructure Change (Version 2)
New VPC added:
- vpc-prod-api (10.3.0.0/16) - tagged env=prod
^
IPAM automatically detects the change and creates a new version.
Version 2 CIDRs: 10.1.0.0/16, 10.2.0.0/16, 10.3.0.0/16
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
58537 58538 58539 58540 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58537 def get_ipam_prefix_list_resolver_versions(params = {}, = {}) req = build_request(:get_ipam_prefix_list_resolver_versions, 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.
58649 58650 58651 58652 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58649 def get_ipam_resource_cidrs(params = {}, = {}) req = build_request(:get_ipam_resource_cidrs, params) req.send_request() end |
#get_ipam_route_origin_authorizations(params = {}) ⇒ Types::GetIpamRouteOriginAuthorizationsResult
Retrieves the current Route Origin Authorizations (ROAs) published to the RPKI for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
58707 58708 58709 58710 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58707 def (params = {}, = {}) req = build_request(:get_ipam_route_origin_authorizations, params) req.send_request() end |
#get_ipam_route_protection_findings(params = {}) ⇒ Types::GetIpamRouteProtectionFindingsResult
Retrieves route protection findings for an IPAM. Route protection findings show the Resource Public Key Infrastructure (RPKI) validation status of your Bring Your Own IP (BYOIP) routes. Findings identify routes that have valid, invalid, or unknown validation states. We recommend using pagination to ensure that the operation returns quickly and successfully.
58794 58795 58796 58797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58794 def get_ipam_route_protection_findings(params = {}, = {}) req = build_request(:get_ipam_route_protection_findings, params) req.send_request() end |
#get_ipam_routing_policy_registration_deltas(params = {}) ⇒ Types::GetIpamRoutingPolicyRegistrationDeltasResult
Retrieves the history of routing policy registration changes for an IPAM internet registry association. We recommend using pagination to ensure that the operation returns quickly and successfully.
58865 58866 58867 58868 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58865 def get_ipam_routing_policy_registration_deltas(params = {}, = {}) req = build_request(:get_ipam_routing_policy_registration_deltas, params) req.send_request() end |
#get_ipam_routing_policy_registrations(params = {}) ⇒ Types::GetIpamRoutingPolicyRegistrationsResult
Retrieves routing policy registrations for an IPAM internet registry association. Each registration represents a Route Origin Authorization (ROA) that has been created or is pending publication to the RPKI. We recommend using pagination to ensure that the operation returns quickly and successfully.
58929 58930 58931 58932 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 58929 def get_ipam_routing_policy_registrations(params = {}, = {}) req = build_request(:get_ipam_routing_policy_registrations, 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.
59206 59207 59208 59209 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59206 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.
59258 59259 59260 59261 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59258 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.
59315 59316 59317 59318 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59315 def get_managed_prefix_list_entries(params = {}, = {}) req = build_request(:get_managed_prefix_list_entries, params) req.send_request() end |
#get_managed_resource_visibility(params = {}) ⇒ Types::GetManagedResourceVisibilityResult
Retrieves the managed resource visibility configuration for the account. The response indicates whether managed resources are hidden or visible by default.
59348 59349 59350 59351 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59348 def get_managed_resource_visibility(params = {}, = {}) req = build_request(:get_managed_resource_visibility, 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.
59749 59750 59751 59752 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59749 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.
59868 59869 59870 59871 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59868 def get_network_insights_access_scope_content(params = {}, = {}) req = build_request(:get_network_insights_access_scope_content, params) req.send_request() end |
#get_networking_flex_cost_allocation_policy_versions(params = {}) ⇒ Types::GetNetworkingFlexCostAllocationPolicyVersionsResult
Retrieves the versions of a flex cost allocation policy.
59938 59939 59940 59941 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 59938 def get_networking_flex_cost_allocation_policy_versions(params = {}, = {}) req = build_request(:get_networking_flex_cost_allocation_policy_versions, 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
60007 60008 60009 60010 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60007 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.
60085 60086 60087 60088 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60085 def get_reserved_instances_exchange_quote(params = {}, = {}) req = build_request(:get_reserved_instances_exchange_quote, params) req.send_request() end |
#get_route_server_associations(params = {}) ⇒ Types::GetRouteServerAssociationsResult
Gets information about the associations for the specified route server.
A route server association is the connection established between a route server and a VPC.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
60134 60135 60136 60137 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60134 def get_route_server_associations(params = {}, = {}) req = build_request(:get_route_server_associations, params) req.send_request() end |
#get_route_server_propagations(params = {}) ⇒ Types::GetRouteServerPropagationsResult
Gets information about the route propagations for the specified route server.
When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
60206 60207 60208 60209 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60206 def get_route_server_propagations(params = {}, = {}) req = build_request(:get_route_server_propagations, params) req.send_request() end |
#get_route_server_routing_database(params = {}) ⇒ Types::GetRouteServerRoutingDatabaseResult
Gets the routing database for the specified route server. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
60308 60309 60310 60311 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60308 def get_route_server_routing_database(params = {}, = {}) req = build_request(:get_route_server_routing_database, 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.
60393 60394 60395 60396 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60393 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.
60433 60434 60435 60436 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60433 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.
60474 60475 60476 60477 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60474 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.
60656 60657 60658 60659 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60656 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.
60747 60748 60749 60750 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60747 def get_subnet_cidr_reservations(params = {}, = {}) req = build_request(:get_subnet_cidr_reservations, params) req.send_request() end |
#get_transit_gateway_attachment_nat_configuration(params = {}) ⇒ Types::GetTransitGatewayAttachmentNatConfigurationResult
Describes the NAT configuration for the specified transit gateway attachment. Only the owner of the transit gateway can describe the NAT configuration.
60794 60795 60796 60797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60794 def (params = {}, = {}) req = build_request(:get_transit_gateway_attachment_nat_configuration, 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.
60860 60861 60862 60863 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60860 def (params = {}, = {}) req = build_request(:get_transit_gateway_attachment_propagations, params) req.send_request() end |
#get_transit_gateway_metering_policy_entries(params = {}) ⇒ Types::GetTransitGatewayMeteringPolicyEntriesResult
Retrieves the entries for a transit gateway metering policy.
60930 60931 60932 60933 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 60930 def get_transit_gateway_metering_policy_entries(params = {}, = {}) req = build_request(:get_transit_gateway_metering_policy_entries, 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.
61008 61009 61010 61011 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61008 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.
61071 61072 61073 61074 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61071 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
61162 61163 61164 61165 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61162 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.
61249 61250 61251 61252 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61249 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.
61319 61320 61321 61322 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61319 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.
61390 61391 61392 61393 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61390 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.
61427 61428 61429 61430 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61427 def get_verified_access_endpoint_policy(params = {}, = {}) req = build_request(:get_verified_access_endpoint_policy, params) req.send_request() end |
#get_verified_access_endpoint_targets(params = {}) ⇒ Types::GetVerifiedAccessEndpointTargetsResult
Gets the targets for the specified network CIDR endpoint for Verified Access.
61478 61479 61480 61481 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61478 def get_verified_access_endpoint_targets(params = {}, = {}) req = build_request(:get_verified_access_endpoint_targets, 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.
61516 61517 61518 61519 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61516 def get_verified_access_group_policy(params = {}, = {}) req = build_request(:get_verified_access_group_policy, params) req.send_request() end |
#get_vpc_resources_blocking_encryption_enforcement(params = {}) ⇒ Types::GetVpcResourcesBlockingEncryptionEnforcementResult
Gets information about resources in a VPC that are blocking encryption enforcement.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
61581 61582 61583 61584 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61581 def get_vpc_resources_blocking_encryption_enforcement(params = {}, = {}) req = build_request(:get_vpc_resources_blocking_encryption_enforcement, 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.
61635 61636 61637 61638 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61635 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.
61702 61703 61704 61705 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61702 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.
61753 61754 61755 61756 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61753 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.
61804 61805 61806 61807 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 61804 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.
62073 62074 62075 62076 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62073 def import_image(params = {}, = {}) req = build_request(:import_image, params) req.send_request() end |
#import_instance(params = {}) ⇒ Types::ImportInstanceResult
ImportImage API instead. 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 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.
This API action is not supported by the Command Line Interface (CLI).
62210 62211 62212 62213 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62210 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 using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services.
For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the Amazon EC2 User Guide.
62282 62283 62284 62285 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62282 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.
62435 62436 62437 62438 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62435 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.
For information about the import manifest referenced by this API action, see VM Import Manifest.
This API action is not supported by the Command Line Interface (CLI).
62546 62547 62548 62549 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62546 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.
62612 62613 62614 62615 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62612 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.
62672 62673 62674 62675 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62672 def list_snapshots_in_recycle_bin(params = {}, = {}) req = build_request(:list_snapshots_in_recycle_bin, params) req.send_request() end |
#list_volumes_in_recycle_bin(params = {}) ⇒ Types::ListVolumesInRecycleBinResult
Lists one or more volumes that are currently in the Recycle Bin.
62744 62745 62746 62747 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62744 def list_volumes_in_recycle_bin(params = {}, = {}) req = build_request(:list_volumes_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.
62880 62881 62882 62883 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62880 def lock_snapshot(params = {}, = {}) req = build_request(:lock_snapshot, params) req.send_request() end |
#modify_account_vpc_encryption_control(params = {}) ⇒ Types::ModifyAccountVpcEncryptionControlResult
Modifies the account-level VPC Encryption Control configuration. This sets the encryption control mode and resource exclusions that apply to the VPCs in your account. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
62989 62990 62991 62992 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 62989 def modify_account_vpc_encryption_control(params = {}, = {}) req = build_request(:modify_account_vpc_encryption_control, 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.
63038 63039 63040 63041 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63038 def modify_address_attribute(params = {}, = {}) req = build_request(:modify_address_attribute, params) req.send_request() end |
#modify_application_status_check(params = {}) ⇒ Types::ModifyApplicationStatusCheckResult
Modifies an existing application status check. You can update the protocol, port, path, thresholds, and other configuration settings. The following rules apply:
The application status check must exist and belong to your account.
Changes take effect on the next health check interval.
63234 63235 63236 63237 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63234 def modify_application_status_check(params = {}, = {}) req = build_request(:modify_application_status_check, 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.
63277 63278 63279 63280 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63277 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, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. 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. For more information, see Modify an active Capacity Reservation.
The allowed modifications depend on the state of the Capacity Reservation:
assessingorscheduledstate - You can modify the tags only.pendingstate - You can't modify the Capacity Reservation in any way.activestate but still within the commitment duration - You can't decrease the instance count or set an end date that is within the commitment duration. All other modifications are allowed.activestate with no commitment duration or elapsed commitment duration - All modifications are allowed.expired,cancelled,unsupported, orfailedstate - You can't modify the Capacity Reservation in any way.
For a future-dated Capacity Reservation that has not yet been
delivered, pushing out the start date requires a quote generated by
CreateCapacityReservationDateChangeQuote. For more information, see
Modify an active Capacity Reservation in the Amazon EC2 User
Guide.
63433 63434 63435 63436 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63433 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.
63513 63514 63515 63516 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63513 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.
63693 63694 63695 63696 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63693 def modify_client_vpn_endpoint(params = {}, = {}) req = build_request(:modify_client_vpn_endpoint, params) req.send_request() end |
#modify_client_vpn_endpoint_authorization_policy(params = {}) ⇒ Types::ModifyClientVpnEndpointAuthorizationPolicyResult
Creates or updates the authorization policy for a Client VPN endpoint. A Client VPN endpoint can have one authorization policy. If a policy already exists for the endpoint, the values that you specify replace the corresponding values in the existing policy, and values that you do not specify remain unchanged.
63767 63768 63769 63770 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63767 def (params = {}, = {}) req = build_request(:modify_client_vpn_endpoint_authorization_policy, 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.
63829 63830 63831 63832 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63829 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. 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.
63902 63903 63904 63905 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 63902 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.
64118 64119 64120 64121 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64118 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).
64211 64212 64213 64214 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64211 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.
64302 64303 64304 64305 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64302 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.
64373 64374 64375 64376 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64373 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.
64449 64450 64451 64452 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64449 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.
64612 64613 64614 64615 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64612 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.
64872 64873 64874 64875 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64872 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, run in On-Demand Instance capacity, or only run in a
Capacity Reservation.
64921 64922 64923 64924 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64921 def modify_instance_capacity_reservation_attributes(params = {}, = {}) req = build_request(:modify_instance_capacity_reservation_attributes, params) req.send_request() end |
#modify_instance_connect_endpoint(params = {}) ⇒ Types::ModifyInstanceConnectEndpointResult
Modifies the specified EC2 Instance Connect Endpoint.
For more information, see Modify an EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.
64991 64992 64993 64994 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 64991 def modify_instance_connect_endpoint(params = {}, = {}) req = build_request(:modify_instance_connect_endpoint, params) req.send_request() end |
#modify_instance_cpu_options(params = {}) ⇒ Types::ModifyInstanceCpuOptionsResult
By default, all vCPUs for the instance type are active when you launch an instance. When you configure the number of active vCPUs for the instance, it can help you save on licensing costs and optimize performance. The base cost of the instance remains unchanged.
The number of active vCPUs equals the number of threads per CPU core
multiplied by the number of cores. The instance must be in a Stopped
state before you make changes.
65063 65064 65065 65066 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65063 def (params = {}, = {}) req = build_request(:modify_instance_cpu_options, 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.
65128 65129 65130 65131 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65128 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.
65176 65177 65178 65179 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65176 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.
65290 65291 65292 65293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65290 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.
Modifies the reboot migration behavior during a user-initiated reboot
of an instance that has a pending system-reboot event. For more
information, see Enable or disable reboot migration.
65368 65369 65370 65371 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65368 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.
65457 65458 65459 65460 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65457 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.
65578 65579 65580 65581 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65578 def (params = {}, = {}) req = build_request(:modify_instance_metadata_options, params) req.send_request() end |
#modify_instance_network_performance_options(params = {}) ⇒ Types::ModifyInstanceNetworkPerformanceResult
Change the configuration of the network performance options for an existing instance.
65636 65637 65638 65639 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65636 def (params = {}, = {}) req = build_request(:modify_instance_network_performance_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
hostand 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.
65739 65740 65741 65742 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65739 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.
65857 65858 65859 65860 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65857 def modify_ipam(params = {}, = {}) req = build_request(:modify_ipam, params) req.send_request() end |
#modify_ipam_policy_allocation_rules(params = {}) ⇒ Types::ModifyIpamPolicyAllocationRulesResult
Modifies the allocation rules in an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.
65940 65941 65942 65943 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 65940 def modify_ipam_policy_allocation_rules(params = {}, = {}) req = build_request(:modify_ipam_policy_allocation_rules, 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.
66080 66081 66082 66083 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66080 def modify_ipam_pool(params = {}, = {}) req = build_request(:modify_ipam_pool, params) req.send_request() end |
#modify_ipam_pool_allocation(params = {}) ⇒ Types::ModifyIpamPoolAllocationResult
Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.
66135 66136 66137 66138 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66135 def modify_ipam_pool_allocation(params = {}, = {}) req = build_request(:modify_ipam_pool_allocation, params) req.send_request() end |
#modify_ipam_prefix_list_resolver(params = {}) ⇒ Types::ModifyIpamPrefixListResolverResult
Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.
66214 66215 66216 66217 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66214 def modify_ipam_prefix_list_resolver(params = {}, = {}) req = build_request(:modify_ipam_prefix_list_resolver, params) req.send_request() end |
#modify_ipam_prefix_list_resolver_target(params = {}) ⇒ Types::ModifyIpamPrefixListResolverTargetResult
Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.
66290 66291 66292 66293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66290 def modify_ipam_prefix_list_resolver_target(params = {}, = {}) req = build_request(:modify_ipam_prefix_list_resolver_target, 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.
66377 66378 66379 66380 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66377 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.
66502 66503 66504 66505 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66502 def modify_ipam_resource_discovery(params = {}, = {}) req = build_request(:modify_ipam_resource_discovery, params) req.send_request() end |
#modify_ipam_routing_policy_registration(params = {}) ⇒ Types::ModifyIpamRoutingPolicyRegistrationResult
Modifies an existing routing policy registration. You can update the authorized ASNs, maximum prefix length, and other properties of a Route Origin Authorization (ROA).
66582 66583 66584 66585 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66582 def modify_ipam_routing_policy_registration(params = {}, = {}) req = build_request(:modify_ipam_routing_policy_registration, params) req.send_request() end |
#modify_ipam_scope(params = {}) ⇒ Types::ModifyIpamScopeResult
Modify an IPAM scope.
66656 66657 66658 66659 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66656 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.
66759 66760 66761 66762 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66759 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.
66823 66824 66825 66826 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66823 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.
66921 66922 66923 66924 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66921 def modify_managed_prefix_list(params = {}, = {}) req = build_request(:modify_managed_prefix_list, params) req.send_request() end |
#modify_managed_resource_visibility(params = {}) ⇒ Types::ModifyManagedResourceVisibilityResult
Modifies the managed resource visibility configuration for the account. Use this operation to control whether managed resources are hidden or visible by default. Visibility settings are account-wide and affect all IAM principals uniformly. Hidden resources remain fully operational and billable.
66961 66962 66963 66964 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 66961 def modify_managed_resource_visibility(params = {}, = {}) req = build_request(:modify_managed_resource_visibility, params) req.send_request() end |
#modify_metric_category(params = {}) ⇒ Types::ModifyMetricCategoryResult
Modifies the metrics in the specified metric category. The metrics that you specify replace the existing metrics.
Instances that are associated with the metric category are updated asynchronously.
For more information, see Use metric categories for additional metrics in the Amazon EC2 User Guide.
67024 67025 67026 67027 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67024 def modify_metric_category(params = {}, = {}) req = build_request(:modify_metric_category, 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.
67181 67182 67183 67184 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67181 def modify_network_interface_attribute(params = {}, = {}) req = build_request(:modify_network_interface_attribute, params) req.send_request() end |
#modify_networking_flex_cost_allocation_policy(params = {}) ⇒ Types::ModifyNetworkingFlexCostAllocationPolicyResult
Modifies a flex cost allocation policy. Changing a policy document or
ShowBackEnabled creates a new version of the policy. Changing only
the description doesn't create a new version.
A policy can have up to 100 versions. Versions are never removed, so
after a policy reaches 100 versions, you can't change its policy
document or ShowBackEnabled. Policies that are managed by a
declarative policy aren't subject to this limit.
67304 67305 67306 67307 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67304 def modify_networking_flex_cost_allocation_policy(params = {}, = {}) req = build_request(:modify_networking_flex_cost_allocation_policy, params) req.send_request() end |
#modify_private_dns_name_options(params = {}) ⇒ Types::ModifyPrivateDnsNameOptionsResult
Modifies the options for instance hostnames for the specified instance.
67358 67359 67360 67361 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67358 def (params = {}, = {}) req = build_request(:modify_private_dns_name_options, params) req.send_request() end |
#modify_public_ip_dns_name_options(params = {}) ⇒ Types::ModifyPublicIpDnsNameOptionsResult
Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
67424 67425 67426 67427 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67424 def (params = {}, = {}) req = build_request(:modify_public_ip_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.
67485 67486 67487 67488 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67485 def modify_reserved_instances(params = {}, = {}) req = build_request(:modify_reserved_instances, params) req.send_request() end |
#modify_route_server(params = {}) ⇒ Types::ModifyRouteServerResult
Modifies the configuration of an existing route server.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
67593 67594 67595 67596 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67593 def modify_route_server(params = {}, = {}) req = build_request(:modify_route_server, params) req.send_request() end |
#modify_security_group_rules(params = {}) ⇒ Types::ModifySecurityGroupRulesResult
Modifies the rules of a security group.
67646 67647 67648 67649 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67646 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.
67761 67762 67763 67764 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67761 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.
67811 67812 67813 67814 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 67811 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.
68012 68013 68014 68015 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68012 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
MapCustomerOwnedIpOnLaunchandCustomerOwnedIpv4Pool. These two parameters act as a single attribute.To modify a subnet on an Outpost server, set either
EnableLniAtDeviceIndexorDisableLniAtDeviceIndex.
For more information about Amazon Web Services Outposts, see the following:
68171 68172 68173 68174 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68171 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.
68263 68264 68265 68266 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68263 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.
68369 68370 68371 68372 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68369 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.
68462 68463 68464 68465 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68462 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.
68543 68544 68545 68546 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68543 def modify_transit_gateway(params = {}, = {}) req = build_request(:modify_transit_gateway, params) req.send_request() end |
#modify_transit_gateway_attachment_nat_configuration(params = {}) ⇒ Types::ModifyTransitGatewayAttachmentNatConfigurationResult
Modifies the NAT configuration for the specified transit gateway attachment. Use this operation to do the following:
Enable or disable NAT gateway support for the attachment.
Specify whether the transit gateway installs routes for the NAT CIDRs.
Replace the NAT gateway rules for the attachment.
Only the owner of the transit gateway can modify the NAT configuration.
With NAT gateway support enabled, the transit gateway translates
addresses in each rule's MatchSourceCidr range to the corresponding
addresses in its NatCidr range.
The transit gateway applies changes asynchronously. To check the
result, use GetTransitGatewayAttachmentNatConfiguration.
68647 68648 68649 68650 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68647 def (params = {}, = {}) req = build_request(:modify_transit_gateway_attachment_nat_configuration, params) req.send_request() end |
#modify_transit_gateway_metering_policy(params = {}) ⇒ Types::ModifyTransitGatewayMeteringPolicyResult
Modifies a transit gateway metering policy.
68698 68699 68700 68701 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68698 def modify_transit_gateway_metering_policy(params = {}, = {}) req = build_request(:modify_transit_gateway_metering_policy, params) req.send_request() end |
#modify_transit_gateway_network_function_attachment(params = {}) ⇒ Types::ModifyTransitGatewayNetworkFunctionAttachmentResult
Adds Availability Zones to or removes Availability Zones from the
specified network function attachment. The attachment must be in the
available state. You must specify at least one Availability Zone to
add or remove, and the attachment must keep at least one Availability
Zone.
Adding an Availability Zone provisions a new Gateway Load Balancer endpoint in that Availability Zone. If the endpoint service doesn't automatically accept connection requests, the endpoint service owner must accept the endpoint connection for each Availability Zone that you add.
68776 68777 68778 68779 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68776 def (params = {}, = {}) req = build_request(:modify_transit_gateway_network_function_attachment, params) req.send_request() end |
#modify_transit_gateway_policy_table_entry(params = {}) ⇒ Types::ModifyTransitGatewayPolicyTableEntryResult
Modifies the specified transit gateway policy table entry.
68844 68845 68846 68847 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68844 def modify_transit_gateway_policy_table_entry(params = {}, = {}) req = build_request(:modify_transit_gateway_policy_table_entry, 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.
68899 68900 68901 68902 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68899 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.
68966 68967 68968 68969 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 68966 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.
69120 69121 69122 69123 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69120 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.
69189 69190 69191 69192 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69189 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.
69258 69259 69260 69261 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69258 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.
69327 69328 69329 69330 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69327 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.
69400 69401 69402 69403 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69400 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.
69486 69487 69488 69489 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69486 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.
69607 69608 69609 69610 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69607 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 you initiate a volume modification, you must wait for that
modification to reach the completed state before you can initiate
another modification for the same volume. You can modify a volume up
to four times within a rolling 24-hour period, as long as the volume
is in the in-use or available state, and all previous
modifications for that volume are completed. If you exceed this
limit, you get an error message that indicates when you can perform
your next modification.
69773 69774 69775 69776 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69773 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.
69837 69838 69839 69840 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69837 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.
69918 69919 69920 69921 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69918 def modify_vpc_attribute(params = {}, = {}) req = build_request(:modify_vpc_attribute, params) req.send_request() end |
#modify_vpc_block_public_access_exclusion(params = {}) ⇒ Types::ModifyVpcBlockPublicAccessExclusionResult
Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.
69980 69981 69982 69983 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 69980 def modify_vpc_block_public_access_exclusion(params = {}, = {}) req = build_request(:modify_vpc_block_public_access_exclusion, params) req.send_request() end |
#modify_vpc_block_public_access_options(params = {}) ⇒ Types::ModifyVpcBlockPublicAccessOptionsResult
Modify VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
70044 70045 70046 70047 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70044 def (params = {}, = {}) req = build_request(:modify_vpc_block_public_access_options, params) req.send_request() end |
#modify_vpc_encryption_control(params = {}) ⇒ Types::ModifyVpcEncryptionControlResult
Modifies the encryption control configuration for a VPC. You can update the encryption mode and exclusion settings for various gateway types and peering connections.
For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.
70169 70170 70171 70172 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70169 def modify_vpc_encryption_control(params = {}, = {}) req = build_request(:modify_vpc_encryption_control, 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.
70281 70282 70283 70284 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70281 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.
70327 70328 70329 70330 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70327 def modify_vpc_endpoint_connection_notification(params = {}, = {}) req = build_request(:modify_vpc_endpoint_connection_notification, params) req.send_request() end |
#modify_vpc_endpoint_payer_responsibility(params = {}) ⇒ Types::ModifyVpcEndpointPayerResponsibilityResult
Modifies the billing account for VPC endpoint usage/charges.
70380 70381 70382 70383 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70380 def modify_vpc_endpoint_payer_responsibility(params = {}, = {}) req = build_request(:modify_vpc_endpoint_payer_responsibility, params) req.send_request() end |
#modify_vpc_endpoint_service_configuration(params = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult
Modifies the attributes of the specified VPC endpoint service configuration.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
70470 70471 70472 70473 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70470 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.
70511 70512 70513 70514 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70511 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. Principal ARNs with path components aren't supported.
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.
By default, principals that you grant permissions to can create VPC
endpoints that connect to your endpoint service. For Gateway Load
Balancer endpoint services, you can instead grant permissions so that
principals can create transit gateway attachments that connect to your
endpoint service. To do so, specify transit-gateway-attachment for
PermissionType. The two permission types are independent. A
principal can have either or both.
70598 70599 70600 70601 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70598 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.
70670 70671 70672 70673 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70670 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.
70723 70724 70725 70726 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70723 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.
70888 70889 70890 70891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 70888 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.
71032 71033 71034 71035 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71032 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.
71141 71142 71143 71144 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71141 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.
71334 71335 71336 71337 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71334 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.
71388 71389 71390 71391 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71388 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. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
71449 71450 71451 71452 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71449 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.
71514 71515 71516 71517 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71514 def move_byoip_cidr_to_ipam(params = {}, = {}) req = build_request(:move_byoip_cidr_to_ipam, params) req.send_request() end |
#move_capacity_reservation_instances(params = {}) ⇒ Types::MoveCapacityReservationInstancesResult
Move available capacity from a source Capacity Reservation to a
destination Capacity Reservation. The source Capacity Reservation and
the destination Capacity Reservation must be active, owned by your
Amazon Web Services account, and share the following:
Instance type
Platform
Availability Zone
Tenancy
Placement group
Capacity Reservation end time -
At specific timeorManually.
71700 71701 71702 71703 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71700 def move_capacity_reservation_instances(params = {}, = {}) req = build_request(:move_capacity_reservation_instances, 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.
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 the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. 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.
For more information, see Onboard your address range.
71837 71838 71839 71840 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71837 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.
71894 71895 71896 71897 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71894 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.
71991 71992 71993 71994 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 71991 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.
72060 72061 72062 72063 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72060 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.
72185 72186 72187 72188 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72185 def purchase_capacity_block(params = {}, = {}) req = build_request(:purchase_capacity_block, params) req.send_request() end |
#purchase_capacity_block_extension(params = {}) ⇒ Types::PurchaseCapacityBlockExtensionResult
Purchase the Capacity Block extension for use with your account. You must specify the ID of the Capacity Block extension offering you are purchasing.
72240 72241 72242 72243 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72240 def purchase_capacity_block_extension(params = {}, = {}) req = build_request(:purchase_capacity_block_extension, 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.
72333 72334 72335 72336 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72333 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.
72405 72406 72407 72408 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72405 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.
72491 72492 72493 72494 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72491 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.
72548 72549 72550 72551 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72548 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 an AMI from a snapshot and Create an instance-store backed AMI in the Amazon EC2 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 an AMI from a snapshot and Use encryption with EBS-backed AMIs in the Amazon EC2 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.
In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require
correct licensing information to be present on the AMI. For more
information, see Understand AMI billing information in the
Amazon EC2 User Guide. When creating an AMI from a snapshot, the
RegisterImage operation derives the correct billing information from
the snapshot's metadata, but this requires the appropriate metadata
to be present. To verify if the correct billing information was
applied, check the PlatformDetails field on the new AMI. If the
field is empty or doesn't match the expected operating system code
(for example, Windows, RedHat, SUSE, or SQL), the AMI creation was
unsuccessful, and you should discard the AMI and instead create the
AMI from an instance. For more information, see Create an AMI from an
instance in the Amazon EC2 User Guide.
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 is not 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.
72840 72841 72842 72843 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72840 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.
72888 72889 72890 72891 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72888 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.
72948 72949 72950 72951 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 72948 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.
73009 73010 73011 73012 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73009 def register_transit_gateway_multicast_group_sources(params = {}, = {}) req = build_request(:register_transit_gateway_multicast_group_sources, params) req.send_request() end |
#reject_capacity_reservation_billing_ownership(params = {}) ⇒ Types::RejectCapacityReservationBillingOwnershipResult
Rejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
73050 73051 73052 73053 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73050 def reject_capacity_reservation_billing_ownership(params = {}, = {}) req = build_request(:reject_capacity_reservation_billing_ownership, params) req.send_request() end |
#reject_transit_gateway_client_vpn_attachment(params = {}) ⇒ Types::RejectTransitGatewayClientVpnAttachmentResult
Rejects a Transit Gateway attachment request for a Client VPN endpoint. The Transit Gateway owner can reject the attachment request to prevent the Client VPN endpoint from routing traffic through the Transit Gateway.
73093 73094 73095 73096 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73093 def (params = {}, = {}) req = build_request(:reject_transit_gateway_client_vpn_attachment, 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.
73145 73146 73147 73148 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73145 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.
73197 73198 73199 73200 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73197 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.
73251 73252 73253 73254 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73251 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.
73304 73305 73306 73307 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73304 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.
73344 73345 73346 73347 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73344 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. Alternatively, you can disassociate an Elastic IP address without releasing it.
[Nondefault VPC] You must 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 Release an Elastic IP address.
73417 73418 73419 73420 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73417 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.
73463 73464 73465 73466 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73463 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.
73523 73524 73525 73526 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73523 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.
73568 73569 73570 73571 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73568 def replace_iam_instance_profile_association(params = {}, = {}) req = build_request(:replace_iam_instance_profile_association, params) req.send_request() end |
#replace_image_criteria_in_allowed_images_settings(params = {}) ⇒ Types::ReplaceImageCriteriaInAllowedImagesSettingsResult
Sets or replaces the criteria for Allowed AMIs.
The ImageCriteria can include up to:
- 10
ImageCriterion
^
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
73654 73655 73656 73657 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73654 def replace_image_criteria_in_allowed_images_settings(params = {}, = {}) req = build_request(:replace_image_criteria_in_allowed_images_settings, params) req.send_request() end |
#replace_image_instance_type_specification(params = {}) ⇒ Types::ReplaceImageInstanceTypeSpecificationResult
Replaces or removes the instance type specification for an AMI. The instance type specification defines which instance types are compatible with the AMI.
When you launch an instance using RunInstances, Amazon EC2
validates the requested instance type against the AMI's instance type
specification. If the instance type is not compatible, the request
fails with an InvalidParameterCombination error.
You can specify supported instance types, unsupported instance types, or both. The evaluation logic is as follows:
No specification set – all instance types are allowed.
Only
UnsupportedInstanceTypesset – All instance types are allowed except those that match the unsupported list.SupportedInstanceTypesset – The instance type must match the supported list and must not match the unsupported list.
Instance type entries support wildcard patterns using * (for
example, t3.* matches all t3 sizes).
To remove an existing instance type specification, omit the
InstanceTypeSpecification parameter or set it to null.
To set the instance type specification, you must be the AMI owner. You cannot set an instance type specification on an AMI that is listed in Amazon Web Services Marketplace, and you cannot list an AMI in Amazon Web Services Marketplace if it has an instance type specification set.
73730 73731 73732 73733 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73730 def replace_image_instance_type_specification(params = {}, = {}) req = build_request(:replace_image_instance_type_specification, 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.
73794 73795 73796 73797 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73794 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.
73899 73900 73901 73902 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 73899 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.
74021 74022 74023 74024 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74021 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.
74090 74091 74092 74093 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74090 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.
74147 74148 74149 74150 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74147 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.
74190 74191 74192 74193 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74190 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.
74272 74273 74274 74275 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74272 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.
74817 74818 74819 74820 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 74817 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.
75233 75234 75235 75236 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75233 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.
75282 75283 75284 75285 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75282 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.
75323 75324 75325 75326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75323 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.
75364 75365 75366 75367 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75364 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.
75412 75413 75414 75415 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75412 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.
75475 75476 75477 75478 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75475 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.
75509 75510 75511 75512 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75509 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.
75565 75566 75567 75568 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75565 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.
75610 75611 75612 75613 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75610 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 Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin in the Amazon EC2 User Guide.
75651 75652 75653 75654 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75651 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.
75708 75709 75710 75711 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75708 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.
75769 75770 75771 75772 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75769 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.
75836 75837 75838 75839 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75836 def restore_snapshot_tier(params = {}, = {}) req = build_request(:restore_snapshot_tier, params) req.send_request() end |
#restore_volume_from_recycle_bin(params = {}) ⇒ Types::RestoreVolumeFromRecycleBinResult
Restores a volume from the Recycle Bin. For more information, see Restore volumes from the Recycle Bin in the Amazon EBS User Guide.
75877 75878 75879 75880 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75877 def restore_volume_from_recycle_bin(params = {}, = {}) req = build_request(:restore_volume_from_recycle_bin, params) req.send_request() end |
#revoke_client_vpn_ingress(params = {}) ⇒ Types::RevokeClientVpnIngressResult
Removes an ingress authorization rule from a Client VPN endpoint.
75931 75932 75933 75934 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 75931 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.
76093 76094 76095 76096 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 76093 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.
76275 76276 76277 76278 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 76275 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.
77185 77186 77187 77188 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77185 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.
77315 77316 77317 77318 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77315 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.
77405 77406 77407 77408 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77405 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.
77500 77501 77502 77503 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77500 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
77599 77600 77601 77602 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77599 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.
77650 77651 77652 77653 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77650 def send_diagnostic_interrupt(params = {}, = {}) req = build_request(:send_diagnostic_interrupt, params) req.send_request() end |
#start_declarative_policies_report(params = {}) ⇒ Types::StartDeclarativePoliciesReportResult
Generates an account status report. The report is generated asynchronously, and can take several hours to complete.
The report provides the current status of all attributes supported by
declarative policies for the accounts within the specified scope. The
scope is determined by the specified TargetId, which can represent
an individual account, or all the accounts that fall under the
specified organizational unit (OU) or root (the entire Amazon Web
Services Organization).
The report is saved to your specified S3 bucket, using the following path structure (with the capitalized placeholders representing your specific values):
s3://AMZN-S3-DEMO-BUCKET/YOUR-OPTIONAL-S3-PREFIX/ec2_TARGETID_REPORTID_YYYYMMDDTHHMMZ.csv
Prerequisites for generating a report
The
StartDeclarativePoliciesReportAPI can only be called by the management account or delegated administrators for the organization.An S3 bucket must be available before generating the report (you can create a new one or use an existing one), it must be in the same Region where the report generation request is made, and it must have an appropriate bucket policy. For a sample S3 policy, see Sample Amazon S3 policy under Examples.
Trusted access must be enabled for the service for which the declarative policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations console, this is done automatically when you enable declarative policies. The API uses the following service principal to identify the EC2 service:
ec2.amazonaws.com. For more information on how to enable trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using Organizations with other Amazon Web Services services in the Amazon Web Services Organizations User Guide.Only one report per organization can be generated at a time. Attempting to generate a report while another is in progress will result in an error.
For more information, including the required IAM permissions to run this API, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.
77766 77767 77768 77769 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77766 def start_declarative_policies_report(params = {}, = {}) req = build_request(:start_declarative_policies_report, 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.
77867 77868 77869 77870 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77867 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.
77941 77942 77943 77944 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 77941 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.
78926 78927 78928 78929 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 78926 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.
78968 78969 78970 78971 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 78968 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. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. By default,
this includes a graceful operating system (OS) shutdown. To bypass the
graceful shutdown, use the skipOsShutdown parameter; however, this
might risk data integrity.
You can use the StopInstances operation together with the Hibernate
parameter to hibernate an instance if the instance is enabled for
hibernation and meets the hibernation prerequisites. Stopping
an instance doesn't preserve data stored in RAM, while hibernation
does. If hibernation fails, a normal shutdown occurs. For more
information, see Hibernate your Amazon EC2 instance in the
Amazon EC2 User Guide.
If your instance appears stuck in the stopping state, there might be
an issue with the underlying host computer. You can use the
StopInstances operation together with the Force parameter to force
stop your instance. For more information, see Troubleshoot Amazon EC2
instance stop issues in the Amazon EC2 User Guide.
Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the Amazon EC2 User Guide.
We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing.
You can't stop or hibernate instance store-backed instances.
79127 79128 79129 79130 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79127 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.
79183 79184 79185 79186 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79183 def terminate_client_vpn_connections(params = {}, = {}) req = build_request(:terminate_client_vpn_connections, params) req.send_request() end |
#terminate_instances(params = {}) ⇒ Types::TerminateInstancesResult
Terminates (deletes) the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
Terminating an instance is permanent and irreversible.
After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see How instance termination works.
Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage.
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-1aare 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.
By default, the TerminateInstances operation includes a graceful
operating system (OS) shutdown. To bypass the graceful shutdown, use
the skipOsShutdown parameter; however, this might risk data
integrity.
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 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
Amazon EC2 instance state changes in the Amazon EC2 User Guide.
When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and Troubleshooting terminating your instance in the Amazon EC2 User Guide.
79358 79359 79360 79361 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79358 def terminate_instances(params = {}, = {}) req = build_request(:terminate_instances, params) req.send_request() end |
#unassign_ipv_6_addresses(params = {}) ⇒ Types::UnassignIpv6AddressesResult
Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.
79401 79402 79403 79404 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79401 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 the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface.
79446 79447 79448 79449 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79446 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.
79525 79526 79527 79528 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79525 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.
79563 79564 79565 79566 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79563 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.
79616 79617 79618 79619 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79616 def unmonitor_instances(params = {}, = {}) req = build_request(:unmonitor_instances, params) req.send_request() end |
#update_capacity_manager_monitored_tag_keys(params = {}) ⇒ Types::UpdateCapacityManagerMonitoredTagKeysResult
Activates or deactivates tag keys for monitoring by EC2 Capacity Manager. Activated tag keys are included as dimensions in capacity metric data, enabling you to group and filter metrics by tag values.
79672 79673 79674 79675 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79672 def update_capacity_manager_monitored_tag_keys(params = {}, = {}) req = build_request(:update_capacity_manager_monitored_tag_keys, params) req.send_request() end |
#update_capacity_manager_organizations_access(params = {}) ⇒ Types::UpdateCapacityManagerOrganizationsAccessResult
Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current account.
79722 79723 79724 79725 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79722 def update_capacity_manager_organizations_access(params = {}, = {}) req = build_request(:update_capacity_manager_organizations_access, params) req.send_request() end |
#update_interruptible_capacity_reservation_allocation(params = {}) ⇒ Types::UpdateInterruptibleCapacityReservationAllocationResult
Modifies the number of instances allocated to an interruptible reservation, allowing you to add more capacity or reclaim capacity to your source Capacity Reservation.
79783 79784 79785 79786 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79783 def update_interruptible_capacity_reservation_allocation(params = {}, = {}) req = build_request(:update_interruptible_capacity_reservation_allocation, 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.
79905 79906 79907 79908 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 79905 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.
80028 80029 80030 80031 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 80028 def update_security_group_rule_descriptions_ingress(params = {}, = {}) req = build_request(:update_security_group_rule_descriptions_ingress, params) req.send_request() end |
#validate_security_group_quotas_for_interface(params = {}) ⇒ Types::ValidateSecurityGroupQuotasForInterfaceResult
Validates whether the specified security groups can be associated with a single network interface. The operation checks Amazon Virtual Private Cloud (Amazon VPC) quotas. It checks inbound or outbound rules per security group and security groups per network interface. Only authorized Amazon Web Services services can call this operation.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
80077 80078 80079 80080 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 80077 def validate_security_group_quotas_for_interface(params = {}, = {}) req = build_request(:validate_security_group_quotas_for_interface, 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 |
| image_usage_report_available | #describe_image_usage_reports | 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 |
| secondary_network_create_complete | #describe_secondary_networks | 10 | 30 |
| secondary_network_delete_complete | #describe_secondary_networks | 10 | 30 |
| secondary_subnet_create_complete | #describe_secondary_subnets | 10 | 30 |
| secondary_subnet_delete_complete | #describe_secondary_subnets | 10 | 30 |
| security_group_exists | #describe_security_groups | 5 | 6 |
| security_group_vpc_association_associated | #describe_security_group_vpc_associations | 10 | 7 |
| security_group_vpc_association_disassociated | #describe_security_group_vpc_associations | 10 | 7 |
| 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 |
80289 80290 80291 80292 80293 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 80289 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.
80132 80133 80134 80135 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/client.rb', line 80132 def withdraw_byoip_cidr(params = {}, = {}) req = build_request(:withdraw_byoip_cidr, params) req.send_request() end |