You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.
ec2(config = list(), credentials = list(), endpoint = NULL, region = NULL)A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- ec2(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| accept_address_transfer | Accepts an Elastic IP address transfer |
| accept_reserved_instances_exchange_quote | Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call |
| accept_transit_gateway_multicast_domain_associations | Accepts a request to associate subnets with a transit gateway multicast domain |
| accept_transit_gateway_peering_attachment | Accepts a transit gateway peering attachment request |
| accept_transit_gateway_vpc_attachment | Accepts a request to attach a VPC to a transit gateway |
| accept_vpc_endpoint_connections | Accepts connection requests to your VPC endpoint service |
| accept_vpc_peering_connection | Accept a VPC peering connection request |
| advertise_byoip_cidr | 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 | Allocates an Elastic IP address to your Amazon Web Services account |
| allocate_hosts | Allocates a Dedicated Host to your account |
| allocate_ipam_pool_cidr | Allocate a CIDR from an IPAM pool |
| apply_security_groups_to_client_vpn_target_network | Applies a security group to the association between the target network and the Client VPN endpoint |
| assign_ipv_6_addresses | Assigns one or more IPv6 addresses to the specified network interface |
| assign_private_ip_addresses | Assigns one or more secondary private IP addresses to the specified network interface |
| assign_private_nat_gateway_address | Assigns private IPv4 addresses to a private NAT gateway |
| associate_address | Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface |
| associate_client_vpn_target_network | Associates a target network with a Client VPN endpoint |
| associate_dhcp_options | 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 | Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate |
| associate_iam_instance_profile | Associates an IAM instance profile with a running or stopped instance |
| associate_instance_event_window | Associates one or more targets with an event window |
| associate_ipam_byoasn | Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region |
| associate_ipam_resource_discovery | Associates an IPAM resource discovery with an Amazon VPC IPAM |
| associate_nat_gateway_address | Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway |
| associate_route_table | Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC |
| associate_subnet_cidr_block | Associates a CIDR block with your subnet |
| associate_transit_gateway_multicast_domain | Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain |
| associate_transit_gateway_policy_table | Associates the specified transit gateway attachment with a transit gateway policy table |
| associate_transit_gateway_route_table | Associates the specified attachment with the specified transit gateway route table |
| associate_trunk_interface | Associates a branch network interface with a trunk network interface |
| associate_vpc_cidr_block | Associates a CIDR block with your VPC |
| attach_classic_link_vpc | This action is deprecated |
| attach_internet_gateway | Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC |
| attach_network_interface | Attaches a network interface to an instance |
| attach_verified_access_trust_provider | Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance |
| attach_volume | Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name |
| attach_vpn_gateway | Attaches a virtual private gateway to a VPC |
| authorize_client_vpn_ingress | Adds an ingress authorization rule to a Client VPN endpoint |
| authorize_security_group_egress | Adds the specified outbound (egress) rules to a security group |
| authorize_security_group_ingress | Adds the specified inbound (ingress) rules to a security group |
| bundle_instance | Bundles an Amazon instance store-backed Windows instance |
| cancel_bundle_task | Cancels a bundling operation for an instance store-backed Windows instance |
| cancel_capacity_reservation | Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled |
| cancel_capacity_reservation_fleets | Cancels one or more Capacity Reservation Fleets |
| cancel_conversion_task | Cancels an active conversion task |
| cancel_export_task | Cancels an active export task |
| cancel_image_launch_permission | Removes your Amazon Web Services account from the launch permissions for the specified AMI |
| cancel_import_task | Cancels an in-process import virtual machine or import snapshot task |
| cancel_reserved_instances_listing | Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace |
| cancel_spot_fleet_requests | Cancels the specified Spot Fleet requests |
| cancel_spot_instance_requests | Cancels one or more Spot Instance requests |
| confirm_product_instance | Determines whether a product code is associated with an instance |
| copy_fpga_image | Copies the specified Amazon FPGA Image (AFI) to the current Region |
| copy_image | Initiates an AMI copy operation |
| copy_snapshot | Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3 |
| create_capacity_reservation | Creates a new Capacity Reservation with the specified attributes |
| create_capacity_reservation_by_splitting | Create a new Capacity Reservation by splitting the available capacity of the source Capacity Reservation |
| create_capacity_reservation_fleet | Creates a Capacity Reservation Fleet |
| create_carrier_gateway | Creates a carrier gateway |
| create_client_vpn_endpoint | Creates a Client VPN endpoint |
| create_client_vpn_route | Adds a route to a network to a Client VPN endpoint |
| create_coip_cidr | Creates a range of customer-owned IP addresses |
| create_coip_pool | Creates a pool of customer-owned IP (CoIP) addresses |
| create_customer_gateway | Provides information to Amazon Web Services about your customer gateway device |
| create_default_subnet | Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC |
| create_default_vpc | Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone |
| create_dhcp_options | Creates a custom set of DHCP options |
| create_egress_only_internet_gateway | [IPv6 only] Creates an egress-only internet gateway for your VPC |
| create_fleet | Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances |
| create_flow_logs | Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC |
| create_fpga_image | Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP) |
| create_image | Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped |
| create_instance_connect_endpoint | Creates an EC2 Instance Connect Endpoint |
| create_instance_event_window | Creates an event window in which scheduled events for the associated Amazon EC2 instances can run |
| create_instance_export_task | Exports a running or stopped instance to an Amazon S3 bucket |
| create_internet_gateway | Creates an internet gateway for use with a VPC |
| create_ipam | Create an IPAM |
| create_ipam_external_resource_verification_token | Create a verification token |
| create_ipam_pool | Create an IP address pool for Amazon VPC IP Address Manager (IPAM) |
| create_ipam_resource_discovery | Creates an IPAM resource discovery |
| create_ipam_scope | Create an IPAM scope |
| create_key_pair | Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format |
| create_launch_template | Creates a launch template |
| create_launch_template_version | Creates a new version of a launch template |
| create_local_gateway_route | Creates a static route for the specified local gateway route table |
| create_local_gateway_route_table | Creates a local gateway route table |
| create_local_gateway_route_table_virtual_interface_group_association | Creates a local gateway route table virtual interface group association |
| create_local_gateway_route_table_vpc_association | Associates the specified VPC with the specified local gateway route table |
| create_managed_prefix_list | Creates a managed prefix list |
| create_nat_gateway | Creates a NAT gateway in the specified subnet |
| create_network_acl | Creates a network ACL in a VPC |
| create_network_acl_entry | Creates an entry (a rule) in a network ACL with the specified rule number |
| create_network_insights_access_scope | Creates a Network Access Scope |
| create_network_insights_path | Creates a path to analyze for reachability |
| create_network_interface | Creates a network interface in the specified subnet |
| create_network_interface_permission | Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account |
| create_placement_group | Creates a placement group in which to launch instances |
| create_public_ipv_4_pool | Creates a public IPv4 address pool |
| create_replace_root_volume_task | Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance |
| create_reserved_instances_listing | Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace |
| create_restore_image_task | Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask |
| create_route | Creates a route in a route table within a VPC |
| create_route_table | Creates a route table for the specified VPC |
| create_security_group | Creates a security group |
| create_snapshot | Creates a snapshot of an EBS volume and stores it in Amazon S3 |
| create_snapshots | Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3 |
| create_spot_datafeed_subscription | Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs |
| create_store_image_task | Stores an AMI as a single object in an Amazon S3 bucket |
| create_subnet | Creates a subnet in the specified VPC |
| create_subnet_cidr_reservation | Creates a subnet CIDR reservation |
| create_tags | Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources |
| create_traffic_mirror_filter | Creates a Traffic Mirror filter |
| create_traffic_mirror_filter_rule | Creates a Traffic Mirror filter rule |
| create_traffic_mirror_session | Creates a Traffic Mirror session |
| create_traffic_mirror_target | Creates a target for your Traffic Mirror session |
| create_transit_gateway | Creates a transit gateway |
| create_transit_gateway_connect | Creates a Connect attachment from a specified transit gateway attachment |
| create_transit_gateway_connect_peer | Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance |
| create_transit_gateway_multicast_domain | Creates a multicast domain using the specified transit gateway |
| create_transit_gateway_peering_attachment | Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter) |
| create_transit_gateway_policy_table | Creates a transit gateway policy table |
| create_transit_gateway_prefix_list_reference | Creates a reference (route) to a prefix list in a specified transit gateway route table |
| create_transit_gateway_route | Creates a static route for the specified transit gateway route table |
| create_transit_gateway_route_table | Creates a route table for the specified transit gateway |
| create_transit_gateway_route_table_announcement | Advertises a new transit gateway route table |
| create_transit_gateway_vpc_attachment | Attaches the specified VPC to the specified transit gateway |
| create_verified_access_endpoint | 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 | 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 | 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 | A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices |
| create_volume | Creates an EBS volume that can be attached to an instance in the same Availability Zone |
| create_vpc | Creates a VPC with the specified CIDR blocks |
| create_vpc_endpoint | Creates a VPC endpoint |
| create_vpc_endpoint_connection_notification | Creates a connection notification for a specified VPC endpoint or VPC endpoint service |
| create_vpc_endpoint_service_configuration | Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect |
| create_vpc_peering_connection | Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection |
| create_vpn_connection | Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway |
| create_vpn_connection_route | Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway |
| create_vpn_gateway | Creates a virtual private gateway |
| delete_carrier_gateway | Deletes a carrier gateway |
| delete_client_vpn_endpoint | Deletes the specified Client VPN endpoint |
| delete_client_vpn_route | Deletes a route from a Client VPN endpoint |
| delete_coip_cidr | Deletes a range of customer-owned IP addresses |
| delete_coip_pool | Deletes a pool of customer-owned IP (CoIP) addresses |
| delete_customer_gateway | Deletes the specified customer gateway |
| delete_dhcp_options | Deletes the specified set of DHCP options |
| delete_egress_only_internet_gateway | Deletes an egress-only internet gateway |
| delete_fleets | Deletes the specified EC2 Fleets |
| delete_flow_logs | Deletes one or more flow logs |
| delete_fpga_image | Deletes the specified Amazon FPGA Image (AFI) |
| delete_instance_connect_endpoint | Deletes the specified EC2 Instance Connect Endpoint |
| delete_instance_event_window | Deletes the specified event window |
| delete_internet_gateway | Deletes the specified internet gateway |
| delete_ipam | Delete an IPAM |
| delete_ipam_external_resource_verification_token | Delete a verification token |
| delete_ipam_pool | Delete an IPAM pool |
| delete_ipam_resource_discovery | Deletes an IPAM resource discovery |
| delete_ipam_scope | Delete the scope for an IPAM |
| delete_key_pair | Deletes the specified key pair, by removing the public key from Amazon EC2 |
| delete_launch_template | Deletes a launch template |
| delete_launch_template_versions | Deletes one or more versions of a launch template |
| delete_local_gateway_route | Deletes the specified route from the specified local gateway route table |
| delete_local_gateway_route_table | Deletes a local gateway route table |
| delete_local_gateway_route_table_virtual_interface_group_association | Deletes a local gateway route table virtual interface group association |
| delete_local_gateway_route_table_vpc_association | Deletes the specified association between a VPC and local gateway route table |
| delete_managed_prefix_list | Deletes the specified managed prefix list |
| delete_nat_gateway | Deletes the specified NAT gateway |
| delete_network_acl | Deletes the specified network ACL |
| delete_network_acl_entry | Deletes the specified ingress or egress entry (rule) from the specified network ACL |
| delete_network_insights_access_scope | Deletes the specified Network Access Scope |
| delete_network_insights_access_scope_analysis | Deletes the specified Network Access Scope analysis |
| delete_network_insights_analysis | Deletes the specified network insights analysis |
| delete_network_insights_path | Deletes the specified path |
| delete_network_interface | Deletes the specified network interface |
| delete_network_interface_permission | Deletes a permission for a network interface |
| delete_placement_group | Deletes the specified placement group |
| delete_public_ipv_4_pool | Delete a public IPv4 pool |
| delete_queued_reserved_instances | Deletes the queued purchases for the specified Reserved Instances |
| delete_route | Deletes the specified route from the specified route table |
| delete_route_table | Deletes the specified route table |
| delete_security_group | Deletes a security group |
| delete_snapshot | Deletes the specified snapshot |
| delete_spot_datafeed_subscription | Deletes the data feed for Spot Instances |
| delete_subnet | Deletes the specified subnet |
| delete_subnet_cidr_reservation | Deletes a subnet CIDR reservation |
| delete_tags | Deletes the specified set of tags from the specified set of resources |
| delete_traffic_mirror_filter | Deletes the specified Traffic Mirror filter |
| delete_traffic_mirror_filter_rule | Deletes the specified Traffic Mirror rule |
| delete_traffic_mirror_session | Deletes the specified Traffic Mirror session |
| delete_traffic_mirror_target | Deletes the specified Traffic Mirror target |
| delete_transit_gateway | Deletes the specified transit gateway |
| delete_transit_gateway_connect | Deletes the specified Connect attachment |
| delete_transit_gateway_connect_peer | Deletes the specified Connect peer |
| delete_transit_gateway_multicast_domain | Deletes the specified transit gateway multicast domain |
| delete_transit_gateway_peering_attachment | Deletes a transit gateway peering attachment |
| delete_transit_gateway_policy_table | Deletes the specified transit gateway policy table |
| delete_transit_gateway_prefix_list_reference | Deletes a reference (route) to a prefix list in a specified transit gateway route table |
| delete_transit_gateway_route | Deletes the specified route from the specified transit gateway route table |
| delete_transit_gateway_route_table | Deletes the specified transit gateway route table |
| delete_transit_gateway_route_table_announcement | Advertises to the transit gateway that a transit gateway route table is deleted |
| delete_transit_gateway_vpc_attachment | Deletes the specified VPC attachment |
| delete_verified_access_endpoint | Delete an Amazon Web Services Verified Access endpoint |
| delete_verified_access_group | Delete an Amazon Web Services Verified Access group |
| delete_verified_access_instance | Delete an Amazon Web Services Verified Access instance |
| delete_verified_access_trust_provider | Delete an Amazon Web Services Verified Access trust provider |
| delete_volume | Deletes the specified EBS volume |
| delete_vpc | Deletes the specified VPC |
| delete_vpc_endpoint_connection_notifications | Deletes the specified VPC endpoint connection notifications |
| delete_vpc_endpoints | Deletes the specified VPC endpoints |
| delete_vpc_endpoint_service_configurations | Deletes the specified VPC endpoint service configurations |
| delete_vpc_peering_connection | Deletes a VPC peering connection |
| delete_vpn_connection | Deletes the specified VPN connection |
| delete_vpn_connection_route | Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway |
| delete_vpn_gateway | Deletes the specified virtual private gateway |
| deprovision_byoip_cidr | 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 | Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account |
| deprovision_ipam_pool_cidr | Deprovision a CIDR provisioned from an IPAM pool |
| deprovision_public_ipv_4_pool_cidr | Deprovision a CIDR from a public IPv4 pool |
| deregister_image | Deregisters the specified AMI |
| deregister_instance_event_notification_attributes | 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 | Deregisters the specified members (network interfaces) from the transit gateway multicast group |
| deregister_transit_gateway_multicast_group_sources | Deregisters the specified sources (network interfaces) from the transit gateway multicast group |
| describe_account_attributes | Describes attributes of your Amazon Web Services account |
| describe_addresses | Describes the specified Elastic IP addresses or all of your Elastic IP addresses |
| describe_addresses_attribute | Describes the attributes of the specified Elastic IP addresses |
| describe_address_transfers | Describes an Elastic IP address transfer |
| describe_aggregate_id_format | Describes the longer ID format settings for all resource types in a specific Region |
| describe_availability_zones | Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you |
| describe_aws_network_performance_metric_subscriptions | Describes the current Infrastructure Performance metric subscriptions |
| describe_bundle_tasks | Describes the specified bundle tasks or all of your bundle tasks |
| describe_byoip_cidrs | Describes the IP address ranges that were specified in calls to ProvisionByoipCidr |
| describe_capacity_block_offerings | Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using |
| describe_capacity_reservation_fleets | Describes one or more Capacity Reservation Fleets |
| describe_capacity_reservations | Describes one or more of your Capacity Reservations |
| describe_carrier_gateways | Describes one or more of your carrier gateways |
| describe_classic_link_instances | This action is deprecated |
| describe_client_vpn_authorization_rules | Describes the authorization rules for a specified Client VPN endpoint |
| describe_client_vpn_connections | 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 | Describes one or more Client VPN endpoints in the account |
| describe_client_vpn_routes | Describes the routes for the specified Client VPN endpoint |
| describe_client_vpn_target_networks | Describes the target networks associated with the specified Client VPN endpoint |
| describe_coip_pools | Describes the specified customer-owned address pools or all of your customer-owned address pools |
| describe_conversion_tasks | Describes the specified conversion tasks or all your conversion tasks |
| describe_customer_gateways | Describes one or more of your VPN customer gateways |
| describe_dhcp_options | Describes your DHCP option sets |
| describe_egress_only_internet_gateways | Describes your egress-only internet gateways |
| describe_elastic_gpus | Amazon Elastic Graphics reached end of life on January 8, 2024 |
| describe_export_image_tasks | Describes the specified export image tasks or all of your export image tasks |
| describe_export_tasks | Describes the specified export instance tasks or all of your export instance tasks |
| describe_fast_launch_images | Describe details for Windows AMIs that are configured for Windows fast launch |
| describe_fast_snapshot_restores | Describes the state of fast snapshot restores for your snapshots |
| describe_fleet_history | Describes the events for the specified EC2 Fleet during the specified time |
| describe_fleet_instances | Describes the running instances for the specified EC2 Fleet |
| describe_fleets | Describes the specified EC2 Fleet or all of your EC2 Fleets |
| describe_flow_logs | Describes one or more flow logs |
| describe_fpga_image_attribute | Describes the specified attribute of the specified Amazon FPGA Image (AFI) |
| describe_fpga_images | Describes the Amazon FPGA Images (AFIs) available to you |
| describe_host_reservation_offerings | Describes the Dedicated Host reservations that are available to purchase |
| describe_host_reservations | Describes reservations that are associated with Dedicated Hosts in your account |
| describe_hosts | Describes the specified Dedicated Hosts or all your Dedicated Hosts |
| describe_iam_instance_profile_associations | Describes your IAM instance profile associations |
| describe_identity_id_format | Describes the ID format settings for resources for the specified IAM user, IAM role, or root user |
| describe_id_format | 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_image_attribute | Describes the specified attribute of the specified AMI |
| describe_images | Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you |
| describe_import_image_tasks | Displays details about an import virtual machine or import snapshot tasks that are already created |
| describe_import_snapshot_tasks | Describes your import snapshot tasks |
| describe_instance_attribute | Describes the specified attribute of the specified instance |
| describe_instance_connect_endpoints | Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints |
| describe_instance_credit_specifications | Describes the credit option for CPU usage of the specified burstable performance instances |
| describe_instance_event_notification_attributes | Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region |
| describe_instance_event_windows | Describes the specified event windows or all event windows |
| describe_instances | Describes the specified instances or all instances |
| describe_instance_status | Describes the status of the specified instances or all of your instances |
| describe_instance_topology | 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 | Lists the instance types that are offered for the specified location |
| describe_instance_types | Describes the specified instance types |
| describe_internet_gateways | Describes your internet gateways |
| describe_ipam_byoasn | Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated |
| describe_ipam_external_resource_verification_tokens | Describe verification tokens |
| describe_ipam_pools | Get information about your IPAM pools |
| describe_ipam_resource_discoveries | Describes IPAM resource discoveries |
| describe_ipam_resource_discovery_associations | Describes resource discovery association with an Amazon VPC IPAM |
| describe_ipams | Get information about your IPAM pools |
| describe_ipam_scopes | Get information about your IPAM scopes |
| describe_ipv_6_pools | Describes your IPv6 address pools |
| describe_key_pairs | Describes the specified key pairs or all of your key pairs |
| describe_launch_templates | Describes one or more launch templates |
| describe_launch_template_versions | Describes one or more versions of a specified launch template |
| describe_local_gateway_route_tables | Describes one or more local gateway route tables |
| describe_local_gateway_route_table_virtual_interface_group_associations | Describes the associations between virtual interface groups and local gateway route tables |
| describe_local_gateway_route_table_vpc_associations | Describes the specified associations between VPCs and local gateway route tables |
| describe_local_gateways | Describes one or more local gateways |
| describe_local_gateway_virtual_interface_groups | Describes the specified local gateway virtual interface groups |
| describe_local_gateway_virtual_interfaces | Describes the specified local gateway virtual interfaces |
| describe_locked_snapshots | Describes the lock status for a snapshot |
| describe_mac_hosts | Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts |
| describe_managed_prefix_lists | Describes your managed prefix lists and any Amazon Web Services-managed prefix lists |
| describe_moving_addresses | This action is deprecated |
| describe_nat_gateways | Describes your NAT gateways |
| describe_network_acls | Describes your network ACLs |
| describe_network_insights_access_scope_analyses | Describes the specified Network Access Scope analyses |
| describe_network_insights_access_scopes | Describes the specified Network Access Scopes |
| describe_network_insights_analyses | Describes one or more of your network insights analyses |
| describe_network_insights_paths | Describes one or more of your paths |
| describe_network_interface_attribute | Describes a network interface attribute |
| describe_network_interface_permissions | Describes the permissions for your network interfaces |
| describe_network_interfaces | Describes one or more of your network interfaces |
| describe_placement_groups | Describes the specified placement groups or all of your placement groups |
| describe_prefix_lists | 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 | 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 | Describes the specified IPv4 address pools |
| describe_regions | Describes the Regions that are enabled for your account, or all Regions |
| describe_replace_root_volume_tasks | Describes a root volume replacement task |
| describe_reserved_instances | Describes one or more of the Reserved Instances that you purchased |
| describe_reserved_instances_listings | Describes your account's Reserved Instance listings in the Reserved Instance Marketplace |
| describe_reserved_instances_modifications | Describes the modifications made to your Reserved Instances |
| describe_reserved_instances_offerings | Describes Reserved Instance offerings that are available for purchase |
| describe_route_tables | Describes your route tables |
| describe_scheduled_instance_availability | Finds available schedules that meet the specified criteria |
| describe_scheduled_instances | Describes the specified Scheduled Instances or all your Scheduled Instances |
| describe_security_group_references | Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request |
| describe_security_group_rules | Describes one or more of your security group rules |
| describe_security_groups | Describes the specified security groups or all of your security groups |
| describe_snapshot_attribute | Describes the specified attribute of the specified snapshot |
| describe_snapshots | Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you |
| describe_snapshot_tier_status | Describes the storage tier status of one or more Amazon EBS snapshots |
| describe_spot_datafeed_subscription | Describes the data feed for Spot Instances |
| describe_spot_fleet_instances | Describes the running instances for the specified Spot Fleet |
| describe_spot_fleet_request_history | Describes the events for the specified Spot Fleet request during the specified time |
| describe_spot_fleet_requests | Describes your Spot Fleet requests |
| describe_spot_instance_requests | Describes the specified Spot Instance requests |
| describe_spot_price_history | Describes the Spot price history |
| describe_stale_security_groups | Describes the stale security group rules for security groups in a specified VPC |
| describe_store_image_tasks | Describes the progress of the AMI store tasks |
| describe_subnets | Describes your subnets |
| describe_tags | Describes the specified tags for your EC2 resources |
| describe_traffic_mirror_filter_rules | Describe traffic mirror filters that determine the traffic that is mirrored |
| describe_traffic_mirror_filters | Describes one or more Traffic Mirror filters |
| describe_traffic_mirror_sessions | Describes one or more Traffic Mirror sessions |
| describe_traffic_mirror_targets | Information about one or more Traffic Mirror targets |
| describe_transit_gateway_attachments | Describes one or more attachments between resources and transit gateways |
| describe_transit_gateway_connect_peers | Describes one or more Connect peers |
| describe_transit_gateway_connects | Describes one or more Connect attachments |
| describe_transit_gateway_multicast_domains | Describes one or more transit gateway multicast domains |
| describe_transit_gateway_peering_attachments | Describes your transit gateway peering attachments |
| describe_transit_gateway_policy_tables | Describes one or more transit gateway route policy tables |
| describe_transit_gateway_route_table_announcements | Describes one or more transit gateway route table advertisements |
| describe_transit_gateway_route_tables | Describes one or more transit gateway route tables |
| describe_transit_gateways | Describes one or more transit gateways |
| describe_transit_gateway_vpc_attachments | Describes one or more VPC attachments |
| describe_trunk_interface_associations | Describes one or more network interface trunk associations |
| describe_verified_access_endpoints | Describes the specified Amazon Web Services Verified Access endpoints |
| describe_verified_access_groups | Describes the specified Verified Access groups |
| describe_verified_access_instance_logging_configurations | Describes the specified Amazon Web Services Verified Access instances |
| describe_verified_access_instances | Describes the specified Amazon Web Services Verified Access instances |
| describe_verified_access_trust_providers | Describes the specified Amazon Web Services Verified Access trust providers |
| describe_volume_attribute | Describes the specified attribute of the specified volume |
| describe_volumes | Describes the specified EBS volumes or all of your EBS volumes |
| describe_volumes_modifications | Describes the most recent volume modification request for the specified EBS volumes |
| describe_volume_status | Describes the status of the specified volumes |
| describe_vpc_attribute | Describes the specified attribute of the specified VPC |
| describe_vpc_classic_link | This action is deprecated |
| describe_vpc_classic_link_dns_support | This action is deprecated |
| describe_vpc_endpoint_connection_notifications | Describes the connection notifications for VPC endpoints and VPC endpoint services |
| describe_vpc_endpoint_connections | Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance |
| describe_vpc_endpoints | Describes your VPC endpoints |
| describe_vpc_endpoint_service_configurations | Describes the VPC endpoint service configurations in your account (your services) |
| describe_vpc_endpoint_service_permissions | Describes the principals (service consumers) that are permitted to discover your VPC endpoint service |
| describe_vpc_endpoint_services | Describes available services to which you can create a VPC endpoint |
| describe_vpc_peering_connections | Describes your VPC peering connections |
| describe_vpcs | Describes your VPCs |
| describe_vpn_connections | Describes one or more of your VPN connections |
| describe_vpn_gateways | Describes one or more of your virtual private gateways |
| detach_classic_link_vpc | This action is deprecated |
| detach_internet_gateway | Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC |
| detach_network_interface | Detaches a network interface from an instance |
| detach_verified_access_trust_provider | Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance |
| detach_volume | Detaches an EBS volume from an instance |
| detach_vpn_gateway | Detaches a virtual private gateway from a VPC |
| disable_address_transfer | Disables Elastic IP address transfer |
| disable_aws_network_performance_metric_subscription | Disables Infrastructure Performance metric subscriptions |
| disable_ebs_encryption_by_default | Disables EBS encryption by default for your account in the current Region |
| disable_fast_launch | Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots |
| disable_fast_snapshot_restores | Disables fast snapshot restores for the specified snapshots in the specified Availability Zones |
| disable_image | Sets the AMI state to disabled and removes all launch permissions from the AMI |
| disable_image_block_public_access | Disables block public access for AMIs at the account level in the specified Amazon Web Services Region |
| disable_image_deprecation | Cancels the deprecation of the specified AMI |
| disable_image_deregistration_protection | Disables deregistration protection for an AMI |
| disable_ipam_organization_admin_account | Disable the IPAM account |
| disable_serial_console_access | Disables access to the EC2 serial console of all instances for your account |
| disable_snapshot_block_public_access | 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 | Disables the specified resource attachment from propagating routes to the specified propagation route table |
| disable_vgw_route_propagation | Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC |
| disable_vpc_classic_link | This action is deprecated |
| disable_vpc_classic_link_dns_support | This action is deprecated |
| disassociate_address | Disassociates an Elastic IP address from the instance or network interface it's associated with |
| disassociate_client_vpn_target_network | Disassociates a target network from the specified Client VPN endpoint |
| disassociate_enclave_certificate_iam_role | Disassociates an IAM role from an Certificate Manager (ACM) certificate |
| disassociate_iam_instance_profile | Disassociates an IAM instance profile from a running or stopped instance |
| disassociate_instance_event_window | Disassociates one or more targets from an event window |
| disassociate_ipam_byoasn | Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR |
| disassociate_ipam_resource_discovery | Disassociates a resource discovery from an Amazon VPC IPAM |
| disassociate_nat_gateway_address | Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway |
| disassociate_route_table | Disassociates a subnet or gateway from a route table |
| disassociate_subnet_cidr_block | Disassociates a CIDR block from a subnet |
| disassociate_transit_gateway_multicast_domain | Disassociates the specified subnets from the transit gateway multicast domain |
| disassociate_transit_gateway_policy_table | Removes the association between an an attachment and a policy table |
| disassociate_transit_gateway_route_table | Disassociates a resource attachment from a transit gateway route table |
| disassociate_trunk_interface | Removes an association between a branch network interface with a trunk network interface |
| disassociate_vpc_cidr_block | Disassociates a CIDR block from a VPC |
| enable_address_transfer | Enables Elastic IP address transfer |
| enable_aws_network_performance_metric_subscription | Enables Infrastructure Performance subscriptions |
| enable_ebs_encryption_by_default | Enables EBS encryption by default for your account in the current Region |
| enable_fast_launch | 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 | Enables fast snapshot restores for the specified snapshots in the specified Availability Zones |
| enable_image | Re-enables a disabled AMI |
| enable_image_block_public_access | Enables block public access for AMIs at the account level in the specified Amazon Web Services Region |
| enable_image_deprecation | Enables deprecation of the specified AMI at the specified date and time |
| enable_image_deregistration_protection | Enables deregistration protection for an AMI |
| enable_ipam_organization_admin_account | Enable an Organizations member account as the IPAM admin account |
| enable_reachability_analyzer_organization_sharing | Establishes a trust relationship between Reachability Analyzer and Organizations |
| enable_serial_console_access | Enables access to the EC2 serial console of all instances for your account |
| enable_snapshot_block_public_access | 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 | Enables the specified attachment to propagate routes to the specified propagation route table |
| enable_vgw_route_propagation | Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC |
| enable_volume_io | 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 | This action is deprecated |
| enable_vpc_classic_link_dns_support | This action is deprecated |
| export_client_vpn_client_certificate_revocation_list | Downloads the client certificate revocation list for the specified Client VPN endpoint |
| export_client_vpn_client_configuration | Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint |
| export_image | Exports an Amazon Machine Image (AMI) to a VM file |
| export_transit_gateway_routes | Exports routes from the specified transit gateway route table to the specified S3 bucket |
| get_associated_enclave_certificate_iam_roles | Returns the IAM roles that are associated with the specified ACM (ACM) certificate |
| get_associated_ipv_6_pool_cidrs | Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool |
| get_aws_network_performance_data | Gets network performance data |
| get_capacity_reservation_usage | Gets usage information about a Capacity Reservation |
| get_coip_pool_usage | Describes the allocations from the specified customer-owned address pool |
| get_console_output | Gets the console output for the specified instance |
| get_console_screenshot | Retrieve a JPG-format screenshot of a running instance to help with troubleshooting |
| get_default_credit_specification | Describes the default credit option for CPU usage of a burstable performance instance family |
| get_ebs_default_kms_key_id | Describes the default KMS key for EBS encryption by default for your account in this Region |
| get_ebs_encryption_by_default | Describes whether EBS encryption by default is enabled for your account in the current Region |
| get_flow_logs_integration_template | Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena |
| get_groups_for_capacity_reservation | Lists the resource groups to which a Capacity Reservation has been added |
| get_host_reservation_purchase_preview | Preview a reservation purchase with configurations that match those of your Dedicated Host |
| get_image_block_public_access_state | Gets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region |
| get_instance_metadata_defaults | 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 | Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance |
| get_instance_types_from_instance_requirements | Returns a list of instance types with the specified instance attributes |
| get_instance_uefi_data | A binary representation of the UEFI variable store |
| get_ipam_address_history | Retrieve historical information about a CIDR within an IPAM scope |
| get_ipam_discovered_accounts | Gets IPAM discovered accounts |
| get_ipam_discovered_public_addresses | Gets the public IP addresses that have been discovered by IPAM |
| get_ipam_discovered_resource_cidrs | Returns the resource CIDRs that are monitored as part of a resource discovery |
| get_ipam_pool_allocations | Get a list of all the CIDR allocations in an IPAM pool |
| get_ipam_pool_cidrs | Get the CIDRs provisioned to an IPAM pool |
| get_ipam_resource_cidrs | Returns resource CIDRs managed by IPAM in a given scope |
| get_launch_template_data | Retrieves the configuration data of the specified instance |
| get_managed_prefix_list_associations | Gets information about the resources that are associated with the specified managed prefix list |
| get_managed_prefix_list_entries | Gets information about the entries for a specified managed prefix list |
| get_network_insights_access_scope_analysis_findings | Gets the findings for the specified Network Access Scope analysis |
| get_network_insights_access_scope_content | Gets the content for the specified Network Access Scope |
| get_password_data | Retrieves the encrypted administrator password for a running Windows instance |
| get_reserved_instances_exchange_quote | Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance |
| get_security_groups_for_vpc | 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 | Retrieves the access status of your account to the EC2 serial console of all instances |
| get_snapshot_block_public_access_state | Gets the current state of block public access for snapshots setting for the account and Region |
| get_spot_placement_scores | Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements |
| get_subnet_cidr_reservations | Gets information about the subnet CIDR reservations |
| get_transit_gateway_attachment_propagations | Lists the route tables to which the specified resource attachment propagates routes |
| get_transit_gateway_multicast_domain_associations | Gets information about the associations for the transit gateway multicast domain |
| get_transit_gateway_policy_table_associations | Gets a list of the transit gateway policy table associations |
| get_transit_gateway_policy_table_entries | Returns a list of transit gateway policy table entries |
| get_transit_gateway_prefix_list_references | Gets information about the prefix list references in a specified transit gateway route table |
| get_transit_gateway_route_table_associations | Gets information about the associations for the specified transit gateway route table |
| get_transit_gateway_route_table_propagations | Gets information about the route table propagations for the specified transit gateway route table |
| get_verified_access_endpoint_policy | Get the Verified Access policy associated with the endpoint |
| get_verified_access_group_policy | Shows the contents of the Verified Access policy associated with the group |
| get_vpn_connection_device_sample_configuration | 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 | Obtain a list of customer gateway devices for which sample configuration files can be provided |
| get_vpn_tunnel_replacement_status | Get details of available tunnel endpoint maintenance |
| import_client_vpn_client_certificate_revocation_list | Uploads a client certificate revocation list to the specified Client VPN endpoint |
| import_image | 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 |
| import_instance | We recommend that you use the ImportImage API |
| import_key_pair | Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool |
| import_snapshot | Imports a disk into an EBS snapshot |
| import_volume | Creates an import volume task using metadata from the specified disk image |
| list_images_in_recycle_bin | Lists one or more AMIs that are currently in the Recycle Bin |
| list_snapshots_in_recycle_bin | Lists one or more snapshots that are currently in the Recycle Bin |
| lock_snapshot | Locks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration |
| modify_address_attribute | Modifies an attribute of the specified Elastic IP address |
| modify_availability_zone_group | Changes the opt-in status of the specified zone group for your account |
| modify_capacity_reservation | Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released |
| modify_capacity_reservation_fleet | Modifies a Capacity Reservation Fleet |
| modify_client_vpn_endpoint | Modifies the specified Client VPN endpoint |
| modify_default_credit_specification | Modifies the default credit option for CPU usage of burstable performance instances |
| modify_ebs_default_kms_key_id | Changes the default KMS key for EBS encryption by default for your account in this Region |
| modify_fleet | Modifies the specified EC2 Fleet |
| modify_fpga_image_attribute | Modifies the specified attribute of the specified Amazon FPGA Image (AFI) |
| modify_hosts | Modify the auto-placement setting of a Dedicated Host |
| modify_identity_id_format | 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_id_format | Modifies the ID format for the specified resource on a per-Region basis |
| modify_image_attribute | Modifies the specified attribute of the specified AMI |
| modify_instance_attribute | Modifies the specified attribute of the specified instance |
| modify_instance_capacity_reservation_attributes | Modifies the Capacity Reservation settings for a stopped instance |
| modify_instance_credit_specification | Modifies the credit option for CPU usage on a running or stopped burstable performance instance |
| modify_instance_event_start_time | Modifies the start time for a scheduled Amazon EC2 instance event |
| modify_instance_event_window | Modifies the specified event window |
| modify_instance_maintenance_options | Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default |
| modify_instance_metadata_defaults | Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region |
| modify_instance_metadata_options | Modify the instance metadata parameters on a running or stopped instance |
| modify_instance_placement | Modifies the placement attributes for a specified instance |
| modify_ipam | Modify the configurations of an IPAM |
| modify_ipam_pool | Modify the configurations of an IPAM pool |
| modify_ipam_resource_cidr | Modify a resource CIDR |
| modify_ipam_resource_discovery | Modifies a resource discovery |
| modify_ipam_scope | Modify an IPAM scope |
| modify_launch_template | Modifies a launch template |
| modify_local_gateway_route | Modifies the specified local gateway route |
| modify_managed_prefix_list | Modifies the specified managed prefix list |
| modify_network_interface_attribute | Modifies the specified network interface attribute |
| modify_private_dns_name_options | Modifies the options for instance hostnames for the specified instance |
| modify_reserved_instances | Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type |
| modify_security_group_rules | Modifies the rules of a security group |
| modify_snapshot_attribute | Adds or removes permission settings for the specified snapshot |
| modify_snapshot_tier | Archives an Amazon EBS snapshot |
| modify_spot_fleet_request | Modifies the specified Spot Fleet request |
| modify_subnet_attribute | Modifies a subnet attribute |
| modify_traffic_mirror_filter_network_services | Allows or restricts mirroring network services |
| modify_traffic_mirror_filter_rule | Modifies the specified Traffic Mirror rule |
| modify_traffic_mirror_session | Modifies a Traffic Mirror session |
| modify_transit_gateway | Modifies the specified transit gateway |
| modify_transit_gateway_prefix_list_reference | Modifies a reference (route) to a prefix list in a specified transit gateway route table |
| modify_transit_gateway_vpc_attachment |
if (FALSE) {
svc <- ec2()
# This example allocates an Elastic IP address.
svc$allocate_address()
}
Run the code above in your browser using DataLab