Ec2
This page documents function available when using the Ec2
module, created with @service Ec2
.
Index
Main.Ec2.accept_reserved_instances_exchange_quote
Main.Ec2.accept_transit_gateway_multicast_domain_associations
Main.Ec2.accept_transit_gateway_peering_attachment
Main.Ec2.accept_transit_gateway_vpc_attachment
Main.Ec2.accept_vpc_endpoint_connections
Main.Ec2.accept_vpc_peering_connection
Main.Ec2.advertise_byoip_cidr
Main.Ec2.allocate_address
Main.Ec2.allocate_hosts
Main.Ec2.apply_security_groups_to_client_vpn_target_network
Main.Ec2.assign_ipv6_addresses
Main.Ec2.assign_private_ip_addresses
Main.Ec2.associate_address
Main.Ec2.associate_client_vpn_target_network
Main.Ec2.associate_dhcp_options
Main.Ec2.associate_enclave_certificate_iam_role
Main.Ec2.associate_iam_instance_profile
Main.Ec2.associate_route_table
Main.Ec2.associate_subnet_cidr_block
Main.Ec2.associate_transit_gateway_multicast_domain
Main.Ec2.associate_transit_gateway_route_table
Main.Ec2.associate_vpc_cidr_block
Main.Ec2.attach_classic_link_vpc
Main.Ec2.attach_internet_gateway
Main.Ec2.attach_network_interface
Main.Ec2.attach_volume
Main.Ec2.attach_vpn_gateway
Main.Ec2.authorize_client_vpn_ingress
Main.Ec2.authorize_security_group_egress
Main.Ec2.authorize_security_group_ingress
Main.Ec2.bundle_instance
Main.Ec2.cancel_bundle_task
Main.Ec2.cancel_capacity_reservation
Main.Ec2.cancel_conversion_task
Main.Ec2.cancel_export_task
Main.Ec2.cancel_import_task
Main.Ec2.cancel_reserved_instances_listing
Main.Ec2.cancel_spot_fleet_requests
Main.Ec2.cancel_spot_instance_requests
Main.Ec2.confirm_product_instance
Main.Ec2.copy_fpga_image
Main.Ec2.copy_image
Main.Ec2.copy_snapshot
Main.Ec2.create_capacity_reservation
Main.Ec2.create_carrier_gateway
Main.Ec2.create_client_vpn_endpoint
Main.Ec2.create_client_vpn_route
Main.Ec2.create_customer_gateway
Main.Ec2.create_default_subnet
Main.Ec2.create_default_vpc
Main.Ec2.create_dhcp_options
Main.Ec2.create_egress_only_internet_gateway
Main.Ec2.create_fleet
Main.Ec2.create_flow_logs
Main.Ec2.create_fpga_image
Main.Ec2.create_image
Main.Ec2.create_instance_export_task
Main.Ec2.create_internet_gateway
Main.Ec2.create_key_pair
Main.Ec2.create_launch_template
Main.Ec2.create_launch_template_version
Main.Ec2.create_local_gateway_route
Main.Ec2.create_local_gateway_route_table_vpc_association
Main.Ec2.create_managed_prefix_list
Main.Ec2.create_nat_gateway
Main.Ec2.create_network_acl
Main.Ec2.create_network_acl_entry
Main.Ec2.create_network_insights_path
Main.Ec2.create_network_interface
Main.Ec2.create_network_interface_permission
Main.Ec2.create_placement_group
Main.Ec2.create_replace_root_volume_task
Main.Ec2.create_reserved_instances_listing
Main.Ec2.create_restore_image_task
Main.Ec2.create_route
Main.Ec2.create_route_table
Main.Ec2.create_security_group
Main.Ec2.create_snapshot
Main.Ec2.create_snapshots
Main.Ec2.create_spot_datafeed_subscription
Main.Ec2.create_store_image_task
Main.Ec2.create_subnet
Main.Ec2.create_tags
Main.Ec2.create_traffic_mirror_filter
Main.Ec2.create_traffic_mirror_filter_rule
Main.Ec2.create_traffic_mirror_session
Main.Ec2.create_traffic_mirror_target
Main.Ec2.create_transit_gateway
Main.Ec2.create_transit_gateway_connect
Main.Ec2.create_transit_gateway_connect_peer
Main.Ec2.create_transit_gateway_multicast_domain
Main.Ec2.create_transit_gateway_peering_attachment
Main.Ec2.create_transit_gateway_prefix_list_reference
Main.Ec2.create_transit_gateway_route
Main.Ec2.create_transit_gateway_route_table
Main.Ec2.create_transit_gateway_vpc_attachment
Main.Ec2.create_volume
Main.Ec2.create_vpc
Main.Ec2.create_vpc_endpoint
Main.Ec2.create_vpc_endpoint_connection_notification
Main.Ec2.create_vpc_endpoint_service_configuration
Main.Ec2.create_vpc_peering_connection
Main.Ec2.create_vpn_connection
Main.Ec2.create_vpn_connection_route
Main.Ec2.create_vpn_gateway
Main.Ec2.delete_carrier_gateway
Main.Ec2.delete_client_vpn_endpoint
Main.Ec2.delete_client_vpn_route
Main.Ec2.delete_customer_gateway
Main.Ec2.delete_dhcp_options
Main.Ec2.delete_egress_only_internet_gateway
Main.Ec2.delete_fleets
Main.Ec2.delete_flow_logs
Main.Ec2.delete_fpga_image
Main.Ec2.delete_internet_gateway
Main.Ec2.delete_key_pair
Main.Ec2.delete_launch_template
Main.Ec2.delete_launch_template_versions
Main.Ec2.delete_local_gateway_route
Main.Ec2.delete_local_gateway_route_table_vpc_association
Main.Ec2.delete_managed_prefix_list
Main.Ec2.delete_nat_gateway
Main.Ec2.delete_network_acl
Main.Ec2.delete_network_acl_entry
Main.Ec2.delete_network_insights_analysis
Main.Ec2.delete_network_insights_path
Main.Ec2.delete_network_interface
Main.Ec2.delete_network_interface_permission
Main.Ec2.delete_placement_group
Main.Ec2.delete_queued_reserved_instances
Main.Ec2.delete_route
Main.Ec2.delete_route_table
Main.Ec2.delete_security_group
Main.Ec2.delete_snapshot
Main.Ec2.delete_spot_datafeed_subscription
Main.Ec2.delete_subnet
Main.Ec2.delete_tags
Main.Ec2.delete_traffic_mirror_filter
Main.Ec2.delete_traffic_mirror_filter_rule
Main.Ec2.delete_traffic_mirror_session
Main.Ec2.delete_traffic_mirror_target
Main.Ec2.delete_transit_gateway
Main.Ec2.delete_transit_gateway_connect
Main.Ec2.delete_transit_gateway_connect_peer
Main.Ec2.delete_transit_gateway_multicast_domain
Main.Ec2.delete_transit_gateway_peering_attachment
Main.Ec2.delete_transit_gateway_prefix_list_reference
Main.Ec2.delete_transit_gateway_route
Main.Ec2.delete_transit_gateway_route_table
Main.Ec2.delete_transit_gateway_vpc_attachment
Main.Ec2.delete_volume
Main.Ec2.delete_vpc
Main.Ec2.delete_vpc_endpoint_connection_notifications
Main.Ec2.delete_vpc_endpoint_service_configurations
Main.Ec2.delete_vpc_endpoints
Main.Ec2.delete_vpc_peering_connection
Main.Ec2.delete_vpn_connection
Main.Ec2.delete_vpn_connection_route
Main.Ec2.delete_vpn_gateway
Main.Ec2.deprovision_byoip_cidr
Main.Ec2.deregister_image
Main.Ec2.deregister_instance_event_notification_attributes
Main.Ec2.deregister_transit_gateway_multicast_group_members
Main.Ec2.deregister_transit_gateway_multicast_group_sources
Main.Ec2.describe_account_attributes
Main.Ec2.describe_addresses
Main.Ec2.describe_addresses_attribute
Main.Ec2.describe_aggregate_id_format
Main.Ec2.describe_availability_zones
Main.Ec2.describe_bundle_tasks
Main.Ec2.describe_byoip_cidrs
Main.Ec2.describe_capacity_reservations
Main.Ec2.describe_carrier_gateways
Main.Ec2.describe_classic_link_instances
Main.Ec2.describe_client_vpn_authorization_rules
Main.Ec2.describe_client_vpn_connections
Main.Ec2.describe_client_vpn_endpoints
Main.Ec2.describe_client_vpn_routes
Main.Ec2.describe_client_vpn_target_networks
Main.Ec2.describe_coip_pools
Main.Ec2.describe_conversion_tasks
Main.Ec2.describe_customer_gateways
Main.Ec2.describe_dhcp_options
Main.Ec2.describe_egress_only_internet_gateways
Main.Ec2.describe_elastic_gpus
Main.Ec2.describe_export_image_tasks
Main.Ec2.describe_export_tasks
Main.Ec2.describe_fast_snapshot_restores
Main.Ec2.describe_fleet_history
Main.Ec2.describe_fleet_instances
Main.Ec2.describe_fleets
Main.Ec2.describe_flow_logs
Main.Ec2.describe_fpga_image_attribute
Main.Ec2.describe_fpga_images
Main.Ec2.describe_host_reservation_offerings
Main.Ec2.describe_host_reservations
Main.Ec2.describe_hosts
Main.Ec2.describe_iam_instance_profile_associations
Main.Ec2.describe_id_format
Main.Ec2.describe_identity_id_format
Main.Ec2.describe_image_attribute
Main.Ec2.describe_images
Main.Ec2.describe_import_image_tasks
Main.Ec2.describe_import_snapshot_tasks
Main.Ec2.describe_instance_attribute
Main.Ec2.describe_instance_credit_specifications
Main.Ec2.describe_instance_event_notification_attributes
Main.Ec2.describe_instance_status
Main.Ec2.describe_instance_type_offerings
Main.Ec2.describe_instance_types
Main.Ec2.describe_instances
Main.Ec2.describe_internet_gateways
Main.Ec2.describe_ipv6_pools
Main.Ec2.describe_key_pairs
Main.Ec2.describe_launch_template_versions
Main.Ec2.describe_launch_templates
Main.Ec2.describe_local_gateway_route_table_virtual_interface_group_associations
Main.Ec2.describe_local_gateway_route_table_vpc_associations
Main.Ec2.describe_local_gateway_route_tables
Main.Ec2.describe_local_gateway_virtual_interface_groups
Main.Ec2.describe_local_gateway_virtual_interfaces
Main.Ec2.describe_local_gateways
Main.Ec2.describe_managed_prefix_lists
Main.Ec2.describe_moving_addresses
Main.Ec2.describe_nat_gateways
Main.Ec2.describe_network_acls
Main.Ec2.describe_network_insights_analyses
Main.Ec2.describe_network_insights_paths
Main.Ec2.describe_network_interface_attribute
Main.Ec2.describe_network_interface_permissions
Main.Ec2.describe_network_interfaces
Main.Ec2.describe_placement_groups
Main.Ec2.describe_prefix_lists
Main.Ec2.describe_principal_id_format
Main.Ec2.describe_public_ipv4_pools
Main.Ec2.describe_regions
Main.Ec2.describe_replace_root_volume_tasks
Main.Ec2.describe_reserved_instances
Main.Ec2.describe_reserved_instances_listings
Main.Ec2.describe_reserved_instances_modifications
Main.Ec2.describe_reserved_instances_offerings
Main.Ec2.describe_route_tables
Main.Ec2.describe_scheduled_instance_availability
Main.Ec2.describe_scheduled_instances
Main.Ec2.describe_security_group_references
Main.Ec2.describe_security_groups
Main.Ec2.describe_snapshot_attribute
Main.Ec2.describe_snapshots
Main.Ec2.describe_spot_datafeed_subscription
Main.Ec2.describe_spot_fleet_instances
Main.Ec2.describe_spot_fleet_request_history
Main.Ec2.describe_spot_fleet_requests
Main.Ec2.describe_spot_instance_requests
Main.Ec2.describe_spot_price_history
Main.Ec2.describe_stale_security_groups
Main.Ec2.describe_store_image_tasks
Main.Ec2.describe_subnets
Main.Ec2.describe_tags
Main.Ec2.describe_traffic_mirror_filters
Main.Ec2.describe_traffic_mirror_sessions
Main.Ec2.describe_traffic_mirror_targets
Main.Ec2.describe_transit_gateway_attachments
Main.Ec2.describe_transit_gateway_connect_peers
Main.Ec2.describe_transit_gateway_connects
Main.Ec2.describe_transit_gateway_multicast_domains
Main.Ec2.describe_transit_gateway_peering_attachments
Main.Ec2.describe_transit_gateway_route_tables
Main.Ec2.describe_transit_gateway_vpc_attachments
Main.Ec2.describe_transit_gateways
Main.Ec2.describe_volume_attribute
Main.Ec2.describe_volume_status
Main.Ec2.describe_volumes
Main.Ec2.describe_volumes_modifications
Main.Ec2.describe_vpc_attribute
Main.Ec2.describe_vpc_classic_link
Main.Ec2.describe_vpc_classic_link_dns_support
Main.Ec2.describe_vpc_endpoint_connection_notifications
Main.Ec2.describe_vpc_endpoint_connections
Main.Ec2.describe_vpc_endpoint_service_configurations
Main.Ec2.describe_vpc_endpoint_service_permissions
Main.Ec2.describe_vpc_endpoint_services
Main.Ec2.describe_vpc_endpoints
Main.Ec2.describe_vpc_peering_connections
Main.Ec2.describe_vpcs
Main.Ec2.describe_vpn_connections
Main.Ec2.describe_vpn_gateways
Main.Ec2.detach_classic_link_vpc
Main.Ec2.detach_internet_gateway
Main.Ec2.detach_network_interface
Main.Ec2.detach_volume
Main.Ec2.detach_vpn_gateway
Main.Ec2.disable_ebs_encryption_by_default
Main.Ec2.disable_fast_snapshot_restores
Main.Ec2.disable_serial_console_access
Main.Ec2.disable_transit_gateway_route_table_propagation
Main.Ec2.disable_vgw_route_propagation
Main.Ec2.disable_vpc_classic_link
Main.Ec2.disable_vpc_classic_link_dns_support
Main.Ec2.disassociate_address
Main.Ec2.disassociate_client_vpn_target_network
Main.Ec2.disassociate_enclave_certificate_iam_role
Main.Ec2.disassociate_iam_instance_profile
Main.Ec2.disassociate_route_table
Main.Ec2.disassociate_subnet_cidr_block
Main.Ec2.disassociate_transit_gateway_multicast_domain
Main.Ec2.disassociate_transit_gateway_route_table
Main.Ec2.disassociate_vpc_cidr_block
Main.Ec2.enable_ebs_encryption_by_default
Main.Ec2.enable_fast_snapshot_restores
Main.Ec2.enable_serial_console_access
Main.Ec2.enable_transit_gateway_route_table_propagation
Main.Ec2.enable_vgw_route_propagation
Main.Ec2.enable_volume_io
Main.Ec2.enable_vpc_classic_link
Main.Ec2.enable_vpc_classic_link_dns_support
Main.Ec2.export_client_vpn_client_certificate_revocation_list
Main.Ec2.export_client_vpn_client_configuration
Main.Ec2.export_image
Main.Ec2.export_transit_gateway_routes
Main.Ec2.get_associated_enclave_certificate_iam_roles
Main.Ec2.get_associated_ipv6_pool_cidrs
Main.Ec2.get_capacity_reservation_usage
Main.Ec2.get_coip_pool_usage
Main.Ec2.get_console_output
Main.Ec2.get_console_screenshot
Main.Ec2.get_default_credit_specification
Main.Ec2.get_ebs_default_kms_key_id
Main.Ec2.get_ebs_encryption_by_default
Main.Ec2.get_flow_logs_integration_template
Main.Ec2.get_groups_for_capacity_reservation
Main.Ec2.get_host_reservation_purchase_preview
Main.Ec2.get_launch_template_data
Main.Ec2.get_managed_prefix_list_associations
Main.Ec2.get_managed_prefix_list_entries
Main.Ec2.get_password_data
Main.Ec2.get_reserved_instances_exchange_quote
Main.Ec2.get_serial_console_access_status
Main.Ec2.get_transit_gateway_attachment_propagations
Main.Ec2.get_transit_gateway_multicast_domain_associations
Main.Ec2.get_transit_gateway_prefix_list_references
Main.Ec2.get_transit_gateway_route_table_associations
Main.Ec2.get_transit_gateway_route_table_propagations
Main.Ec2.import_client_vpn_client_certificate_revocation_list
Main.Ec2.import_image
Main.Ec2.import_instance
Main.Ec2.import_key_pair
Main.Ec2.import_snapshot
Main.Ec2.import_volume
Main.Ec2.modify_address_attribute
Main.Ec2.modify_availability_zone_group
Main.Ec2.modify_capacity_reservation
Main.Ec2.modify_client_vpn_endpoint
Main.Ec2.modify_default_credit_specification
Main.Ec2.modify_ebs_default_kms_key_id
Main.Ec2.modify_fleet
Main.Ec2.modify_fpga_image_attribute
Main.Ec2.modify_hosts
Main.Ec2.modify_id_format
Main.Ec2.modify_identity_id_format
Main.Ec2.modify_image_attribute
Main.Ec2.modify_instance_attribute
Main.Ec2.modify_instance_capacity_reservation_attributes
Main.Ec2.modify_instance_credit_specification
Main.Ec2.modify_instance_event_start_time
Main.Ec2.modify_instance_metadata_options
Main.Ec2.modify_instance_placement
Main.Ec2.modify_launch_template
Main.Ec2.modify_managed_prefix_list
Main.Ec2.modify_network_interface_attribute
Main.Ec2.modify_reserved_instances
Main.Ec2.modify_snapshot_attribute
Main.Ec2.modify_spot_fleet_request
Main.Ec2.modify_subnet_attribute
Main.Ec2.modify_traffic_mirror_filter_network_services
Main.Ec2.modify_traffic_mirror_filter_rule
Main.Ec2.modify_traffic_mirror_session
Main.Ec2.modify_transit_gateway
Main.Ec2.modify_transit_gateway_prefix_list_reference
Main.Ec2.modify_transit_gateway_vpc_attachment
Main.Ec2.modify_volume
Main.Ec2.modify_volume_attribute
Main.Ec2.modify_vpc_attribute
Main.Ec2.modify_vpc_endpoint
Main.Ec2.modify_vpc_endpoint_connection_notification
Main.Ec2.modify_vpc_endpoint_service_configuration
Main.Ec2.modify_vpc_endpoint_service_permissions
Main.Ec2.modify_vpc_peering_connection_options
Main.Ec2.modify_vpc_tenancy
Main.Ec2.modify_vpn_connection
Main.Ec2.modify_vpn_connection_options
Main.Ec2.modify_vpn_tunnel_certificate
Main.Ec2.modify_vpn_tunnel_options
Main.Ec2.monitor_instances
Main.Ec2.move_address_to_vpc
Main.Ec2.provision_byoip_cidr
Main.Ec2.purchase_host_reservation
Main.Ec2.purchase_reserved_instances_offering
Main.Ec2.purchase_scheduled_instances
Main.Ec2.reboot_instances
Main.Ec2.register_image
Main.Ec2.register_instance_event_notification_attributes
Main.Ec2.register_transit_gateway_multicast_group_members
Main.Ec2.register_transit_gateway_multicast_group_sources
Main.Ec2.reject_transit_gateway_multicast_domain_associations
Main.Ec2.reject_transit_gateway_peering_attachment
Main.Ec2.reject_transit_gateway_vpc_attachment
Main.Ec2.reject_vpc_endpoint_connections
Main.Ec2.reject_vpc_peering_connection
Main.Ec2.release_address
Main.Ec2.release_hosts
Main.Ec2.replace_iam_instance_profile_association
Main.Ec2.replace_network_acl_association
Main.Ec2.replace_network_acl_entry
Main.Ec2.replace_route
Main.Ec2.replace_route_table_association
Main.Ec2.replace_transit_gateway_route
Main.Ec2.report_instance_status
Main.Ec2.request_spot_fleet
Main.Ec2.request_spot_instances
Main.Ec2.reset_address_attribute
Main.Ec2.reset_ebs_default_kms_key_id
Main.Ec2.reset_fpga_image_attribute
Main.Ec2.reset_image_attribute
Main.Ec2.reset_instance_attribute
Main.Ec2.reset_network_interface_attribute
Main.Ec2.reset_snapshot_attribute
Main.Ec2.restore_address_to_classic
Main.Ec2.restore_managed_prefix_list_version
Main.Ec2.revoke_client_vpn_ingress
Main.Ec2.revoke_security_group_egress
Main.Ec2.revoke_security_group_ingress
Main.Ec2.run_instances
Main.Ec2.run_scheduled_instances
Main.Ec2.search_local_gateway_routes
Main.Ec2.search_transit_gateway_multicast_groups
Main.Ec2.search_transit_gateway_routes
Main.Ec2.send_diagnostic_interrupt
Main.Ec2.start_instances
Main.Ec2.start_network_insights_analysis
Main.Ec2.start_vpc_endpoint_service_private_dns_verification
Main.Ec2.stop_instances
Main.Ec2.terminate_client_vpn_connections
Main.Ec2.terminate_instances
Main.Ec2.unassign_ipv6_addresses
Main.Ec2.unassign_private_ip_addresses
Main.Ec2.unmonitor_instances
Main.Ec2.update_security_group_rule_descriptions_egress
Main.Ec2.update_security_group_rule_descriptions_ingress
Main.Ec2.withdraw_byoip_cidr
Documentation
Main.Ec2.accept_reserved_instances_exchange_quote
— Methodaccept_reserved_instances_exchange_quote(reserved_instance_id)
accept_reserved_instances_exchange_quote(reserved_instance_id, params::Dict{String,<:Any})
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
Arguments
reserved_instance_id
: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TargetConfiguration"
: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
Main.Ec2.accept_transit_gateway_multicast_domain_associations
— Methodaccept_transit_gateway_multicast_domain_associations()
accept_transit_gateway_multicast_domain_associations(params::Dict{String,<:Any})
Accepts a request to associate subnets with a transit gateway multicast domain.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SubnetIds"
: The IDs of the subnets to associate with the transit gateway multicast domain."TransitGatewayAttachmentId"
: The ID of the transit gateway attachment."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.accept_transit_gateway_peering_attachment
— Methodaccept_transit_gateway_peering_attachment(transit_gateway_attachment_id)
accept_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
Arguments
transit_gateway_attachment_id
: The ID of the transit gateway attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.accept_transit_gateway_vpc_attachment
— Methodaccept_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
accept_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
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.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.accept_vpc_endpoint_connections
— Methodaccept_vpc_endpoint_connections(service_id, vpc_endpoint_id)
accept_vpc_endpoint_connections(service_id, vpc_endpoint_id, params::Dict{String,<:Any})
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
Arguments
service_id
: The ID of the VPC endpoint service.vpc_endpoint_id
: The IDs of one or more interface VPC endpoints.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.accept_vpc_peering_connection
— Methodaccept_vpc_peering_connection()
accept_vpc_peering_connection(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."vpcPeeringConnectionId"
: The ID of the VPC peering connection. You must specify this parameter in the request.
Main.Ec2.advertise_byoip_cidr
— Methodadvertise_byoip_cidr(cidr)
advertise_byoip_cidr(cidr, params::Dict{String,<:Any})
Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS 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 AWS. To minimize down time, you can configure your AWS 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 AWS. It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays. To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
Arguments
cidr
: The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.allocate_address
— Methodallocate_address()
allocate_address(params::Dict{String,<:Any})
Allocates an Elastic IP address to your AWS 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 AWS account. You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. [EC2-VPC] 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 AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation. An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Address"
: [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool."CustomerOwnedIpv4Pool"
: The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool."Domain"
: Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic. Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc."NetworkBorderGroup"
: A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. Use DescribeAvailabilityZones to view the network border groups. You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes."PublicIpv4Pool"
: The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead."TagSpecification"
: The tags to assign to the Elastic IP address."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.allocate_hosts
— Methodallocate_hosts(availability_zone, quantity)
allocate_hosts(availability_zone, quantity, params::Dict{String,<:Any})
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.
Arguments
availability_zone
: The Availability Zone in which to allocate the Dedicated Host.quantity
: The number of Dedicated Hosts to allocate to your account with these parameters.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"HostRecovery"
: Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide. Default: off"InstanceFamily"
: Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request."TagSpecification"
: The tags to apply to the Dedicated Host during creation."autoPlacement"
: Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide. Default: on"clientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency."instanceType"
: Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
Main.Ec2.apply_security_groups_to_client_vpn_target_network
— Methodapply_security_groups_to_client_vpn_target_network(client_vpn_endpoint_id, security_group_id, vpc_id)
apply_security_groups_to_client_vpn_target_network(client_vpn_endpoint_id, security_group_id, vpc_id, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.security_group_id
: The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.vpc_id
: The ID of the VPC in which the associated target network is located.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.assign_ipv6_addresses
— Methodassign_ipv6_addresses(network_interface_id)
assign_ipv6_addresses(network_interface_id, params::Dict{String,<:Any})
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide. You must specify either the IPv6 addresses or the IPv6 address count in the request.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ipv6AddressCount"
: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses."ipv6Addresses"
: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
Main.Ec2.assign_private_ip_addresses
— Methodassign_private_ip_addresses(network_interface_id)
assign_private_ip_addresses(network_interface_id, params::Dict{String,<:Any})
Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud 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.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"allowReassignment"
: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface."privateIpAddress"
: One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses. If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range."secondaryPrivateIpAddressCount"
: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
Main.Ec2.associate_address
— Methodassociate_address()
associate_address(params::Dict{String,<:Any})
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. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. [EC2-Classic, VPC in an EC2-VPC-only 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. [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address. [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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllocationId"
: [EC2-VPC] The allocation ID. This is required for EC2-VPC."InstanceId"
: The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state."PublicIp"
: [EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic."allowReassociation"
: [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."networkInterfaceId"
: [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both."privateIpAddress"
: [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
Main.Ec2.associate_client_vpn_target_network
— Methodassociate_client_vpn_target_network(client_vpn_endpoint_id, subnet_id)
associate_client_vpn_target_network(client_vpn_endpoint_id, subnet_id, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.subnet_id
: The ID of the subnet to associate with the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.associate_dhcp_options
— Methodassociate_dhcp_options(dhcp_options_id, vpc_id)
associate_dhcp_options(dhcp_options_id, vpc_id, params::Dict{String,<:Any})
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 Options Sets in the Amazon Virtual Private Cloud User Guide.
Arguments
dhcp_options_id
: The ID of the DHCP options set, or default to associate no DHCP options with the VPC.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.associate_enclave_certificate_iam_role
— Methodassociate_enclave_certificate_iam_role()
associate_enclave_certificate_iam_role(params::Dict{String,<:Any})
Associates an AWS Identity and Access Management (IAM) role with an AWS 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 AWS Certificate Manager for Nitro Enclaves in the AWS 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 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS-managed KMS customer master (CMK) that has an attached attestation-based CMK 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 AWS KMS CMK, you must grant it permission to call kms:Decrypt on the AWS KMS CMK returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the AWS Nitro Enclaves User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CertificateArn"
: The ARN of the ACM certificate with which to associate the IAM role."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RoleArn"
: The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.
Main.Ec2.associate_iam_instance_profile
— Methodassociate_iam_instance_profile(iam_instance_profile, instance_id)
associate_iam_instance_profile(iam_instance_profile, instance_id, params::Dict{String,<:Any})
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
Arguments
iam_instance_profile
: The IAM instance profile.instance_id
: The ID of the instance.
Main.Ec2.associate_route_table
— Methodassociate_route_table(route_table_id)
associate_route_table(route_table_id, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide.
Arguments
route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"GatewayId"
: The ID of the internet gateway or virtual private gateway."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."subnetId"
: The ID of the subnet.
Main.Ec2.associate_subnet_cidr_block
— Methodassociate_subnet_cidr_block(ipv6_cidr_block, subnet_id)
associate_subnet_cidr_block(ipv6_cidr_block, subnet_id, params::Dict{String,<:Any})
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
Arguments
ipv6_cidr_block
: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.subnet_id
: The ID of your subnet.
Main.Ec2.associate_transit_gateway_multicast_domain
— Methodassociate_transit_gateway_multicast_domain()
associate_transit_gateway_multicast_domain(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SubnetIds"
: The IDs of the subnets to associate with the transit gateway multicast domain."TransitGatewayAttachmentId"
: The ID of the transit gateway attachment to associate with the transit gateway multicast domain."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.associate_transit_gateway_route_table
— Methodassociate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id)
associate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.associate_vpc_cidr_block
— Methodassociate_vpc_cidr_block(vpc_id)
associate_vpc_cidr_block(vpc_id, params::Dict{String,<:Any})
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). The IPv6 CIDR block size is fixed at /56. 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 VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CidrBlock"
: An IPv4 CIDR block to associate with the VPC."Ipv6CidrBlock"
: An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request. To let Amazon choose the IPv6 CIDR block for you, omit this parameter."Ipv6CidrBlockNetworkBorderGroup"
: The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location. You must set AmazonProvidedIpv6CidrBlock to true to use this parameter. You can have one IPv6 CIDR block association per network border group."Ipv6Pool"
: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block."amazonProvidedIpv6CidrBlock"
: Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.
Main.Ec2.attach_classic_link_vpc
— Methodattach_classic_link_vpc(security_group_id, instance_id, vpc_id)
attach_classic_link_vpc(security_group_id, instance_id, vpc_id, params::Dict{String,<:Any})
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's 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.
Arguments
security_group_id
: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.instance_id
: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.vpc_id
: The ID of a ClassicLink-enabled VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.attach_internet_gateway
— Methodattach_internet_gateway(internet_gateway_id, vpc_id)
attach_internet_gateway(internet_gateway_id, vpc_id, params::Dict{String,<:Any})
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
Arguments
internet_gateway_id
: The ID of the internet gateway.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.attach_network_interface
— Methodattach_network_interface(device_index, instance_id, network_interface_id)
attach_network_interface(device_index, instance_id, network_interface_id, params::Dict{String,<:Any})
Attaches a network interface to an instance.
Arguments
device_index
: The index of the device for the network interface attachment.instance_id
: The ID of the instance.network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"NetworkCardIndex"
: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.attach_volume
— Methodattach_volume(device, instance_id, volume_id)
attach_volume(device, instance_id, volume_id, params::Dict{String,<:Any})
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use. If a volume has an AWS Marketplace product code: The volume can be attached only to a stopped instance. AWS 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 Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
Arguments
device
: The device name (for example, /dev/sdh or xvdh).instance_id
: The ID of the instance.volume_id
: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.attach_vpn_gateway
— Methodattach_vpn_gateway(vpc_id, vpn_gateway_id)
attach_vpn_gateway(vpc_id, vpn_gateway_id, params::Dict{String,<:Any})
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Arguments
vpc_id
: The ID of the VPC.vpn_gateway_id
: The ID of the virtual private gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.authorize_client_vpn_ingress
— Methodauthorize_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr)
authorize_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr, params::Dict{String,<:Any})
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 AWS or on-premises networks.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.target_network_cidr
: The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccessGroupId"
: The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified."AuthorizeAllGroups"
: Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified."ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: A brief description of the authorization rule."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.authorize_security_group_egress
— Methodauthorize_security_group_egress(group_id)
authorize_security_group_egress(group_id, params::Dict{String,<:Any})
[VPC only] Adds the specified egress rules to a security group for use with a VPC. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups. You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits.
Arguments
group_id
: The ID of the security group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"cidrIp"
: Not supported. Use a set of IP permissions to specify the CIDR."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."fromPort"
: Not supported. Use a set of IP permissions to specify the port."ipPermissions"
: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions."ipProtocol"
: Not supported. Use a set of IP permissions to specify the protocol name or number."sourceSecurityGroupName"
: Not supported. Use a set of IP permissions to specify a destination security group."sourceSecurityGroupOwnerId"
: Not supported. Use a set of IP permissions to specify a destination security group."toPort"
: Not supported. Use a set of IP permissions to specify the port.
Main.Ec2.authorize_security_group_ingress
— Methodauthorize_security_group_ingress()
authorize_security_group_ingress(params::Dict{String,<:Any})
Adds the specified ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups. You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. For more information about VPC security group limits, see Amazon VPC Limits.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CidrIp"
: The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule."FromPort"
: The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule."GroupId"
: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID."GroupName"
: [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request."IpPermissions"
: The sets of IP permissions."IpProtocol"
: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions. [VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule."SourceSecurityGroupName"
: [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC."SourceSecurityGroupOwnerId"
: [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead."ToPort"
: The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes. Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.bundle_instance
— Methodbundle_instance(instance_id, storage)
bundle_instance(instance_id, storage, params::Dict{String,<:Any})
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. This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
Arguments
instance_id
: The ID of the instance to bundle. Type: String Default: None Required: Yesstorage
: The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.cancel_bundle_task
— Methodcancel_bundle_task(bundle_id)
cancel_bundle_task(bundle_id, params::Dict{String,<:Any})
Cancels a bundling operation for an instance store-backed Windows instance.
Arguments
bundle_id
: The ID of the bundle task.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.cancel_capacity_reservation
— Methodcancel_capacity_reservation(capacity_reservation_id)
cancel_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
Arguments
capacity_reservation_id
: The ID of the Capacity Reservation to be cancelled.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.cancel_conversion_task
— Methodcancel_conversion_task(conversion_task_id)
cancel_conversion_task(conversion_task_id, params::Dict{String,<:Any})
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
Arguments
conversion_task_id
: The ID of the conversion task.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."reasonMessage"
: The reason for canceling the conversion task.
Main.Ec2.cancel_export_task
— Methodcancel_export_task(export_task_id)
cancel_export_task(export_task_id, params::Dict{String,<:Any})
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.
Arguments
export_task_id
: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
Main.Ec2.cancel_import_task
— Methodcancel_import_task()
cancel_import_task(params::Dict{String,<:Any})
Cancels an in-process import virtual machine or import snapshot task.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CancelReason"
: The reason for canceling the task."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ImportTaskId"
: The ID of the import image or import snapshot task to be canceled.
Main.Ec2.cancel_reserved_instances_listing
— Methodcancel_reserved_instances_listing(reserved_instances_listing_id)
cancel_reserved_instances_listing(reserved_instances_listing_id, params::Dict{String,<:Any})
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
Arguments
reserved_instances_listing_id
: The ID of the Reserved Instance listing.
Main.Ec2.cancel_spot_fleet_requests
— Methodcancel_spot_fleet_requests(spot_fleet_request_id, terminate_instances)
cancel_spot_fleet_requests(spot_fleet_request_id, terminate_instances, params::Dict{String,<:Any})
Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelledterminating state. Otherwise, the Spot Fleet request enters the cancelledrunning state and the instances continue to run until they are interrupted or you terminate them manually.
Arguments
spot_fleet_request_id
: The IDs of the Spot Fleet requests.terminate_instances
: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.cancel_spot_instance_requests
— Methodcancel_spot_instance_requests(spot_instance_request_id)
cancel_spot_instance_requests(spot_instance_request_id, params::Dict{String,<:Any})
Cancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Arguments
spot_instance_request_id
: One or more Spot Instance request IDs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.confirm_product_instance
— Methodconfirm_product_instance(instance_id, product_code)
confirm_product_instance(instance_id, product_code, params::Dict{String,<:Any})
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.
Arguments
instance_id
: The ID of the instance.product_code
: The product code. This must be a product code that you own.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.copy_fpga_image
— Methodcopy_fpga_image(source_fpga_image_id, source_region)
copy_fpga_image(source_fpga_image_id, source_region, params::Dict{String,<:Any})
Copies the specified Amazon FPGA Image (AFI) to the current Region.
Arguments
source_fpga_image_id
: The ID of the source AFI.source_region
: The Region that contains the source AFI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency."Description"
: The description for the new AFI."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Name"
: The name for the new AFI. The default is the name of the source AFI.
Main.Ec2.copy_image
— Methodcopy_image(name, source_image_id, source_region)
copy_image(name, source_image_id, source_region, params::Dict{String,<:Any})
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an AWS Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask. To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot. To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide. For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
Arguments
name
: The name of the new AMI in the destination Region.source_image_id
: The ID of the AMI to copy.source_region
: The name of the Region that contains the AMI to copy.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference."Description"
: A description for the new AMI in the destination Region."DestinationOutpostArn"
: The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."encrypted"
: Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide."kmsKeyId"
: The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true. You can specify a CMK using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails. The specified CMK must exist in the destination Region. Amazon EBS does not support asymmetric CMKs.
Main.Ec2.copy_snapshot
— Methodcopy_snapshot(source_region, source_snapshot_id)
copy_snapshot(source_region, source_snapshot_id, params::Dict{String,<:Any})
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot. Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide. Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose. For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
Arguments
source_region
: The ID of the Region that contains the snapshot to be copied.source_snapshot_id
: The ID of the EBS snapshot to copy.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: A description for the EBS snapshot."DestinationOutpostArn"
: The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an AWS Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost. For more information, see Copying snapshots from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide."TagSpecification"
: The tags to apply to the new snapshot."destinationRegion"
: The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required. The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."encrypted"
: To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide."kmsKeyId"
: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true. You can specify the CMK using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails."presignedUrl"
: When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
Main.Ec2.create_capacity_reservation
— Methodcreate_capacity_reservation(instance_count, instance_platform, instance_type)
create_capacity_reservation(instance_count, instance_platform, instance_type, params::Dict{String,<:Any})
Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide. Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes. Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
Arguments
instance_count
: The number of instances for which to reserve capacity.instance_platform
: The type of operating system for which to reserve capacity.instance_type
: The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AvailabilityZone"
: The Availability Zone in which to create the Capacity Reservation."AvailabilityZoneId"
: The ID of the Availability Zone in which to create the Capacity Reservation."ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."EbsOptimized"
: Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance."EndDate"
: The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited. If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019."EndDateType"
: Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited. limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited."EphemeralStorage"
: Indicates whether the Capacity Reservation supports instances with temporary, block-level storage."InstanceMatchCriteria"
: Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. Default: open"OutpostArn"
: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation."TagSpecifications"
: The tags to apply to the Capacity Reservation during launch."Tenancy"
: Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is created on hardware that is shared with other AWS accounts. dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
Main.Ec2.create_carrier_gateway
— Methodcreate_carrier_gateway(vpc_id)
create_carrier_gateway(vpc_id, params::Dict{String,<:Any})
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.
Arguments
vpc_id
: The ID of the VPC to associate with the carrier gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to associate with the carrier gateway.
Main.Ec2.create_client_vpn_endpoint
— Methodcreate_client_vpn_endpoint(authentication, client_cidr_block, connection_log_options, server_certificate_arn)
create_client_vpn_endpoint(authentication, client_cidr_block, connection_log_options, server_certificate_arn, params::Dict{String,<:Any})
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.
Arguments
authentication
: Information about the authentication method to be used to authenticate clients.client_cidr_block
: The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.connection_log_options
: Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: Client connection requests Client connection results (successful and unsuccessful) Reasons for unsuccessful client connection requests Client connection termination timeserver_certificate_arn
: The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientConnectOptions"
: The options for managing connection authorization for new client connections."ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: A brief description of the Client VPN endpoint."DnsServers"
: Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SecurityGroupId"
: The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups."SelfServicePortal"
: Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: enabled"SplitTunnel"
: Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. By default, split-tunnel on a VPN endpoint is disabled. For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide."TagSpecification"
: The tags to apply to the Client VPN endpoint during creation."TransportProtocol"
: The transport protocol to be used by the VPN session. Default value: udp"VpcId"
: The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied."VpnPort"
: The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443
Main.Ec2.create_client_vpn_route
— Methodcreate_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, target_vpc_subnet_id)
create_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, target_vpc_subnet_id, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint to which to add the route.destination_cidr_block
: The IPv4 address range, in CIDR notation, of the route destination. For example: To add a route for Internet access, enter 0.0.0.0/0 To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range To add a route for the local network, enter the client CIDR rangetarget_vpc_subnet_id
: The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. Alternatively, if you're adding a route for the local network, specify local.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: A brief description of the route."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_customer_gateway
— Methodcreate_customer_gateway(bgp_asn, type)
create_customer_gateway(bgp_asn, type, params::Dict{String,<:Any})
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway'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 (in the 64512 - 65534 range). Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following: 7224 - reserved in the us-east-1 Region 9059 - reserved in the eu-west-1 Region 17943
- reserved in the ap-southeast-1 Region 10124 - reserved in the ap-northeast-1 Region
For more information, see AWS Site-to-Site VPN in the AWS 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. Identical requests return information about the existing customer gateway and do not create new customer gateways.
Arguments
bgp_asn
: For devices that support BGP, the customer gateway's BGP ASN. Default: 65000type
: The type of VPN connection that this customer gateway supports (ipsec.1).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CertificateArn"
: The Amazon Resource Name (ARN) for the customer gateway certificate."DeviceName"
: A name for the customer gateway device. Length Constraints: Up to 255 characters."IpAddress"
: The Internet-routable IP address for the customer gateway's outside interface. The address must be static."TagSpecification"
: The tags to apply to the customer gateway."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_default_subnet
— Methodcreate_default_subnet(availability_zone)
create_default_subnet(availability_zone, params::Dict{String,<:Any})
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 Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.
Arguments
availability_zone
: The Availability Zone in which to create the default subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_default_vpc
— Methodcreate_default_vpc()
create_default_vpc(params::Dict{String,<:Any})
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 VPC and Default Subnets in the Amazon Virtual Private Cloud 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. If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_dhcp_options
— Methodcreate_dhcp_options(dhcp_configuration)
create_dhcp_options(dhcp_configuration, params::Dict{String,<:Any})
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132. domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server. domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: 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 options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers. 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 currently supported). For more information about these node types, see RFC 2132. Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Arguments
dhcp_configuration
: A DHCP configuration option.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to assign to the DHCP option."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_egress_only_internet_gateway
— Methodcreate_egress_only_internet_gateway(vpc_id)
create_egress_only_internet_gateway(vpc_id, params::Dict{String,<:Any})
[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.
Arguments
vpc_id
: The ID of the VPC for which to create the egress-only internet gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to assign to the egress-only internet gateway.
Main.Ec2.create_fleet
— Methodcreate_fleet(target_capacity_specification, item)
create_fleet(target_capacity_specification, item, params::Dict{String,<:Any})
Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.
Arguments
target_capacity_specification
: The number of units to request.item
: The configuration for the EC2 Fleet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ExcessCapacityTerminationPolicy"
: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet."LaunchTemplateConfigs"
: The configuration for the EC2 Fleet."OnDemandOptions"
: Describes the configuration of On-Demand Instances in an EC2 Fleet."ReplaceUnhealthyInstances"
: Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide."SpotOptions"
: Describes the configuration of Spot Instances in an EC2 Fleet."TagSpecification"
: The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging your resources."TerminateInstancesWithExpiration"
: Indicates whether running instances should be terminated when the EC2 Fleet expires."Type"
: The type of request. The default value is maintain. maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched. For more information, see EC2 Fleet request types in the Amazon EC2 User Guide."ValidFrom"
: The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately."ValidUntil"
: The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
Main.Ec2.create_flow_logs
— Methodcreate_flow_logs(resource_id, resource_type, traffic_type)
create_flow_logs(resource_id, resource_type, traffic_type, params::Dict{String,<:Any})
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 Virtual Private Cloud 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 Virtual Private Cloud User Guide.
Arguments
resource_id
: The ID of the subnet, network interface, or VPC for which you want to create a flow log. Constraints: Maximum of 1000 resourcesresource_type
: The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.traffic_type
: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DeliverLogsPermissionArn"
: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LogDestination"
: Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType. If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead. If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucketARN/subfoldername/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term."LogDestinationType"
: Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName. Default: cloud-watch-logs"LogFormat"
: The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field. Specify the fields using the {field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value."LogGroupName"
: The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName."MaxAggregationInterval"
: The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify. Default: 600"TagSpecification"
: The tags to apply to the flow logs.
Main.Ec2.create_fpga_image
— Methodcreate_fpga_image(input_storage_location)
create_fpga_image(input_storage_location, params::Dict{String,<:Any})
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
Arguments
input_storage_location
: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency."Description"
: A description for the AFI."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LogsStorageLocation"
: The location in Amazon S3 for the output logs."Name"
: A name for the AFI."TagSpecification"
: The tags to apply to the FPGA image during creation.
Main.Ec2.create_image
— Methodcreate_image(instance_id, name)
create_image(instance_id, name, params::Dict{String,<:Any})
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 EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
Arguments
instance_id
: The ID of the instance.name
: A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both. To tag the AMI, the value for ResourceType must be image. To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created. If you specify other values for ResourceType, the request fails. To tag an AMI or snapshot after it has been created, see CreateTags."blockDeviceMapping"
: The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action."description"
: A description for the new image."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."noReboot"
: By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
Main.Ec2.create_instance_export_task
— Methodcreate_instance_export_task(export_to_s3, instance_id, target_environment)
create_instance_export_task(export_to_s3, instance_id, target_environment, params::Dict{String,<:Any})
Exports a running or stopped instance to an Amazon S3 bucket. For information about the 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.
Arguments
export_to_s3
: The format and location for an export instance task.instance_id
: The ID of the instance.target_environment
: The target virtualization environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to apply to the export instance task during creation."description"
: A description for the conversion task or the resource being exported. The maximum length is 255 characters.
Main.Ec2.create_internet_gateway
— Methodcreate_internet_gateway()
create_internet_gateway(params::Dict{String,<:Any})
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 about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to assign to the internet gateway."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_key_pair
— Methodcreate_key_pair(key_name)
create_key_pair(key_name, params::Dict{String,<:Any})
Creates a 2048-bit RSA key pair with the specified name. 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. If a key with the specified name already exists, Amazon EC2 returns an error. You can have up to five thousand key pairs per Region. The key pair returned to you is available only in the 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. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
Arguments
key_name
: A unique name for the key pair. Constraints: Up to 255 ASCII characters
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to apply to the new key pair."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_launch_template
— Methodcreate_launch_template(launch_template_data, launch_template_name)
create_launch_template(launch_template_data, launch_template_name, params::Dict{String,<:Any})
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 Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.
Arguments
launch_template_data
: The information for the launch template.launch_template_name
: A name for the launch template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to apply to the launch template during creation."VersionDescription"
: A description for the first version of the launch template.
Main.Ec2.create_launch_template_version
— Methodcreate_launch_template_version(launch_template_data)
create_launch_template_version(launch_template_data, params::Dict{String,<:Any})
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version. Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions. For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.
Arguments
launch_template_data
: The information for the launch template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LaunchTemplateId"
: The ID of the launch template. You must specify either the launch template ID or launch template name in the request."LaunchTemplateName"
: The name of the launch template. You must specify either the launch template ID or launch template name in the request."SourceVersion"
: The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included."VersionDescription"
: A description for the version of the launch template.
Main.Ec2.create_local_gateway_route
— Methodcreate_local_gateway_route(destination_cidr_block, local_gateway_route_table_id, local_gateway_virtual_interface_group_id)
create_local_gateway_route(destination_cidr_block, local_gateway_route_table_id, local_gateway_virtual_interface_group_id, params::Dict{String,<:Any})
Creates a static route for the specified local gateway route table.
Arguments
destination_cidr_block
: The CIDR range used for destination matches. Routing decisions are based on the most specific match.local_gateway_route_table_id
: The ID of the local gateway route table.local_gateway_virtual_interface_group_id
: The ID of the virtual interface group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_local_gateway_route_table_vpc_association
— Methodcreate_local_gateway_route_table_vpc_association(local_gateway_route_table_id, vpc_id)
create_local_gateway_route_table_vpc_association(local_gateway_route_table_id, vpc_id, params::Dict{String,<:Any})
Associates the specified VPC with the specified local gateway route table.
Arguments
local_gateway_route_table_id
: The ID of the local gateway route table.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to assign to the local gateway route table VPC association.
Main.Ec2.create_managed_prefix_list
— Methodcreate_managed_prefix_list(address_family, max_entries, prefix_list_name)
create_managed_prefix_list(address_family, max_entries, prefix_list_name, params::Dict{String,<:Any})
Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.
Arguments
address_family
: The IP address type. Valid Values: IPv4 | IPv6max_entries
: The maximum number of entries for the prefix list.prefix_list_name
: A name for the prefix list. Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraints: Up to 255 UTF-8 characters in length."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Entry"
: One or more entries for the prefix list."TagSpecification"
: The tags to apply to the prefix list during creation.
Main.Ec2.create_nat_gateway
— Methodcreate_nat_gateway(allocation_id, subnet_id)
create_nat_gateway(allocation_id, subnet_id, params::Dict{String,<:Any})
Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.
Arguments
allocation_id
: The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.subnet_id
: The subnet in which to create the NAT gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. Constraint: Maximum 64 ASCII characters."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to assign to the NAT gateway.
Main.Ec2.create_network_acl
— Methodcreate_network_acl(vpc_id)
create_network_acl(vpc_id, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to assign to the network ACL."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_network_acl_entry
— Methodcreate_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number)
create_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide.
Arguments
egress
: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).network_acl_id
: The ID of the network ACL.protocol
: The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.rule_action
: Indicates whether to allow or deny the traffic that matches the rule.rule_number
: The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Icmp"
: ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block."cidrBlock"
: The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ipv6CidrBlock"
: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64)."portRange"
: TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
Main.Ec2.create_network_insights_path
— Methodcreate_network_insights_path(client_token, destination, protocol, source)
create_network_insights_path(client_token, destination, protocol, source, params::Dict{String,<:Any})
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 What is Reachability Analyzer.
Arguments
client_token
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.destination
: The AWS resource that is the destination of the path.protocol
: The protocol.source
: The AWS resource that is the source of the path.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DestinationIp"
: The IP address of the AWS resource that is the destination of the path."DestinationPort"
: The destination port."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SourceIp"
: The IP address of the AWS resource that is the source of the path."TagSpecification"
: The tags to add to the path.
Main.Ec2.create_network_interface
— Methodcreate_network_interface(subnet_id)
create_network_interface(subnet_id, params::Dict{String,<:Any})
Creates a network interface in the specified subnet. For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
Arguments
subnet_id
: The ID of the subnet to associate with the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"InterfaceType"
: Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide."SecurityGroupId"
: The IDs of one or more security groups."TagSpecification"
: The tags to apply to the new network interface."description"
: A description for the network interface."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ipv6AddressCount"
: The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting."ipv6Addresses"
: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses."privateIpAddress"
: The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary)."privateIpAddresses"
: One or more private IPv4 addresses."secondaryPrivateIpAddressCount"
: The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
Main.Ec2.create_network_interface_permission
— Methodcreate_network_interface_permission(network_interface_id, permission)
create_network_interface_permission(network_interface_id, permission, params::Dict{String,<:Any})
Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single AWS account only, and only one account at a time.
Arguments
network_interface_id
: The ID of the network interface.permission
: The type of permission to grant.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AwsAccountId"
: The AWS account ID."AwsService"
: The AWS service. Currently not supported."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_placement_group
— Methodcreate_placement_group()
create_placement_group(params::Dict{String,<:Any})
Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see Placement groups in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"PartitionCount"
: The number of partitions. Valid only when Strategy is set to partition."TagSpecification"
: The tags to apply to the new placement group."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."groupName"
: A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters"strategy"
: The placement strategy.
Main.Ec2.create_replace_root_volume_task
— Methodcreate_replace_root_volume_task(instance_id)
create_replace_root_volume_task(instance_id, params::Dict{String,<:Any})
Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
Arguments
instance_id
: The ID of the instance for which to replace the root volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SnapshotId"
: The ID of the snapshot from which to restore the replacement root volume. If you want to restore the volume to the initial launch state, omit this parameter."TagSpecification"
: The tags to apply to the root volume replacement task.
Main.Ec2.create_reserved_instances_listing
— Methodcreate_reserved_instances_listing(client_token, instance_count, price_schedules, reserved_instances_id)
create_reserved_instances_listing(client_token, instance_count, price_schedules, reserved_instances_id, params::Dict{String,<:Any})
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. Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. 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 Reserved Instance Marketplace in the Amazon EC2 User Guide.
Arguments
client_token
: Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.instance_count
: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.price_schedules
: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.reserved_instances_id
: The ID of the active Standard Reserved Instance.
Main.Ec2.create_restore_image_task
— Methodcreate_restore_image_task(bucket, object_key)
create_restore_image_task(bucket, object_key, params::Dict{String,<:Any})
Starts a task that restores an AMI from an 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 Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide.
Arguments
bucket
: The name of the S3 bucket that contains the stored AMI object.object_key
: The name of the stored AMI object in the bucket.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Name"
: The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI."TagSpecification"
: The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both. To tag the AMI, the value for ResourceType must be image. To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
Main.Ec2.create_route
— Methodcreate_route(route_table_id)
create_route(route_table_id, params::Dict{String,<:Any})
Creates a route in a route table within a VPC. You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway. 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 Virtual Private Cloud User Guide.
Arguments
route_table_id
: The ID of the route table for the route.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CarrierGatewayId"
: The ID of the carrier gateway. You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone."DestinationPrefixListId"
: The ID of a prefix list used for the destination match."LocalGatewayId"
: The ID of the local gateway."TransitGatewayId"
: The ID of a transit gateway."VpcEndpointId"
: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only."destinationCidrBlock"
: The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18."destinationIpv6CidrBlock"
: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."egressOnlyInternetGatewayId"
: [IPv6 traffic only] The ID of an egress-only internet gateway."gatewayId"
: The ID of an internet gateway or virtual private gateway attached to your VPC."instanceId"
: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached."natGatewayId"
: [IPv4 traffic only] The ID of a NAT gateway."networkInterfaceId"
: The ID of a network interface."vpcPeeringConnectionId"
: The ID of a VPC peering connection.
Main.Ec2.create_route_table
— Methodcreate_route_table(vpc_id)
create_route_table(vpc_id, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to assign to the route table."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_security_group
— Methodcreate_security_group(group_description, group_name)
create_security_group(group_description, group_name, params::Dict{String,<:Any})
Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. You have a default security group for use in EC2-Classic and 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.
Arguments
group_description
: A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!*group_name
: The name of the security group. Constraints: Up to 255 characters in length. Cannot start with sg-. Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!*
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to assign to the security group."VpcId"
: [EC2-VPC] The ID of the VPC. Required for EC2-VPC."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_snapshot
— Methodcreate_snapshot(volume_id)
create_snapshot(volume_id, params::Dict{String,<:Any})
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost. When a snapshot is created, any AWS 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 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. To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. You can tag your snapshots during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
Arguments
volume_id
: The ID of the EBS volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: A description for the snapshot."OutpostArn"
: The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot. To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume. To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost. To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume. For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide."TagSpecification"
: The tags to apply to the snapshot during creation."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_snapshots
— Methodcreate_snapshots(instance_specification)
create_snapshots(instance_specification, params::Dict{String,<:Any})
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters. You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.
Arguments
instance_specification
: The instance to specify which volumes should be included in the snapshots.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CopyTagsFromSource"
: Copies the tags from the specified volume to corresponding snapshot."Description"
: A description propagated to every snapshot specified by the instance."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."OutpostArn"
: The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots. To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance. To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost. To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance. For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide."TagSpecification"
: Tags to apply to every snapshot specified by the instance.
Main.Ec2.create_spot_datafeed_subscription
— Methodcreate_spot_datafeed_subscription(bucket)
create_spot_datafeed_subscription(bucket, params::Dict{String,<:Any})
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
Arguments
bucket
: The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."prefix"
: The prefix for the data feed file names.
Main.Ec2.create_store_image_task
— Methodcreate_store_image_task(bucket, image_id)
create_store_image_task(bucket, image_id, params::Dict{String,<:Any})
Stores an AMI as a single object in an 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 Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide.
Arguments
bucket
: The name of the S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed.image_id
: The ID of the AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."S3ObjectTag"
: The tags to apply to the AMI object that will be stored in the S3 bucket.
Main.Ec2.create_subnet
— Methodcreate_subnet(cidr_block, vpc_id)
create_subnet(cidr_block, vpc_id, params::Dict{String,<:Any})
Creates a subnet in a specified VPC. You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC. If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length. AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use. 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 about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
Arguments
cidr_block
: The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AvailabilityZone"
: The Availability Zone or Local Zone for the subnet. Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet. To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide. To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN."AvailabilityZoneId"
: The AZ ID or the Local Zone ID of the subnet."Ipv6CidrBlock"
: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length."OutpostArn"
: The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet."TagSpecification"
: The tags to assign to the subnet."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_tags
— Methodcreate_tags(resource_id, tag)
create_tags(resource_id, tag, params::Dict{String,<:Any})
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 Tagging Your 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.
Arguments
resource_id
: The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.tag
: The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.create_traffic_mirror_filter
— Methodcreate_traffic_mirror_filter()
create_traffic_mirror_filter(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: The description of the Traffic Mirror filter."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to assign to a Traffic Mirror filter.
Main.Ec2.create_traffic_mirror_filter_rule
— Methodcreate_traffic_mirror_filter_rule(destination_cidr_block, rule_action, rule_number, source_cidr_block, traffic_direction, traffic_mirror_filter_id)
create_traffic_mirror_filter_rule(destination_cidr_block, rule_action, rule_number, source_cidr_block, traffic_direction, traffic_mirror_filter_id, params::Dict{String,<:Any})
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.
Arguments
destination_cidr_block
: The destination CIDR block to assign to the Traffic Mirror rule.rule_action
: The action to take (accept | reject) on the filtered traffic.rule_number
: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.source_cidr_block
: The source CIDR block to assign to the Traffic Mirror rule.traffic_direction
: The type of traffic (ingress | egress).traffic_mirror_filter_id
: The ID of the filter that this rule is associated with.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: The description of the Traffic Mirror rule."DestinationPortRange"
: The destination port range."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Protocol"
: The protocol, for example UDP, to assign to the Traffic Mirror rule. For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website."SourcePortRange"
: The source port range.
Main.Ec2.create_traffic_mirror_session
— Methodcreate_traffic_mirror_session(network_interface_id, session_number, traffic_mirror_filter_id, traffic_mirror_target_id)
create_traffic_mirror_session(network_interface_id, session_number, traffic_mirror_filter_id, traffic_mirror_target_id, params::Dict{String,<:Any})
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.
Arguments
network_interface_id
: The ID of the source network interface.session_number
: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. Valid values are 1-32766.traffic_mirror_filter_id
: The ID of the Traffic Mirror filter.traffic_mirror_target_id
: The ID of the Traffic Mirror target.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: The description of the Traffic Mirror session."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PacketLength"
: The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror."TagSpecification"
: The tags to assign to a Traffic Mirror session."VirtualNetworkId"
: The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.
Main.Ec2.create_traffic_mirror_target
— Methodcreate_traffic_mirror_target()
create_traffic_mirror_target(params::Dict{String,<:Any})
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, or a Network Load Balancer. To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."Description"
: The description of the Traffic Mirror target."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."NetworkInterfaceId"
: The network interface ID that is associated with the target."NetworkLoadBalancerArn"
: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target."TagSpecification"
: The tags to assign to the Traffic Mirror target.
Main.Ec2.create_transit_gateway
— Methodcreate_transit_gateway()
create_transit_gateway(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: A description of the transit gateway."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Options"
: The transit gateway options."TagSpecification"
: The tags to apply to the transit gateway.
Main.Ec2.create_transit_gateway_connect
— Methodcreate_transit_gateway_connect(options, transport_transit_gateway_attachment_id)
create_transit_gateway_connect(options, transport_transit_gateway_attachment_id, params::Dict{String,<:Any})
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 AWS Direct Connect attachment as the underlying transport mechanism.
Arguments
options
: The Connect attachment options.transport_transit_gateway_attachment_id
: The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to apply to the Connect attachment.
Main.Ec2.create_transit_gateway_connect_peer
— Methodcreate_transit_gateway_connect_peer(peer_address, transit_gateway_attachment_id, item)
create_transit_gateway_connect_peer(peer_address, transit_gateway_attachment_id, item, params::Dict{String,<:Any})
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 Transit Gateways Guide.
Arguments
peer_address
: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.transit_gateway_attachment_id
: The ID of the Connect attachment.item
: The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"BgpOptions"
: The BGP options for the Connect peer."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."InsideCidrBlocks"
: The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range."TagSpecification"
: The tags to apply to the Connect peer."TransitGatewayAddress"
: The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
Main.Ec2.create_transit_gateway_multicast_domain
— Methodcreate_transit_gateway_multicast_domain(transit_gateway_id)
create_transit_gateway_multicast_domain(transit_gateway_id, params::Dict{String,<:Any})
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.
Arguments
transit_gateway_id
: The ID of the transit gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Options"
: The options for the transit gateway multicast domain."TagSpecification"
: The tags for the transit gateway multicast domain.
Main.Ec2.create_transit_gateway_peering_attachment
— Methodcreate_transit_gateway_peering_attachment(peer_account_id, peer_region, peer_transit_gateway_id, transit_gateway_id)
create_transit_gateway_peering_attachment(peer_account_id, peer_region, peer_transit_gateway_id, transit_gateway_id, params::Dict{String,<:Any})
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account. After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
Arguments
peer_account_id
: The AWS account ID of the owner of the peer transit gateway.peer_region
: The Region where the peer transit gateway is located.peer_transit_gateway_id
: The ID of the peer transit gateway with which to create the peering attachment.transit_gateway_id
: The ID of the transit gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecification"
: The tags to apply to the transit gateway peering attachment.
Main.Ec2.create_transit_gateway_prefix_list_reference
— Methodcreate_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
create_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Creates a reference (route) to a prefix list in a specified transit gateway route table.
Arguments
prefix_list_id
: The ID of the prefix list that is used for destination matches.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Blackhole"
: Indicates whether to drop traffic that matches this route."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TransitGatewayAttachmentId"
: The ID of the attachment to which traffic is routed.
Main.Ec2.create_transit_gateway_route
— Methodcreate_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
create_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Creates a static route for the specified transit gateway route table.
Arguments
destination_cidr_block
: The CIDR range used for destination matches. Routing decisions are based on the most specific match.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Blackhole"
: Indicates whether to drop traffic that matches this route."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TransitGatewayAttachmentId"
: The ID of the attachment.
Main.Ec2.create_transit_gateway_route_table
— Methodcreate_transit_gateway_route_table(transit_gateway_id)
create_transit_gateway_route_table(transit_gateway_id, params::Dict{String,<:Any})
Creates a route table for the specified transit gateway.
Arguments
transit_gateway_id
: The ID of the transit gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TagSpecifications"
: The tags to apply to the transit gateway route table.
Main.Ec2.create_transit_gateway_vpc_attachment
— Methodcreate_transit_gateway_vpc_attachment(transit_gateway_id, vpc_id, item)
create_transit_gateway_vpc_attachment(transit_gateway_id, vpc_id, item, params::Dict{String,<:Any})
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.
Arguments
transit_gateway_id
: The ID of the transit gateway.vpc_id
: The ID of the VPC.item
: The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Options"
: The VPC attachment options."SubnetIds"
: The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet."TagSpecifications"
: The tags to apply to the VPC attachment.
Main.Ec2.create_volume
— Methodcreate_volume(availability_zone)
create_volume(availability_zone, params::Dict{String,<:Any})
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 AWS 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 Elastic Compute Cloud User Guide. You can tag your volumes during creation. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information, see Creating an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
Arguments
availability_zone
: The Availability Zone in which to create the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Iops"
: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: gp3: 3,000-16,000 IOPS io1: 100-64,000 IOPS io2: 100-64,000 IOPS For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes."KmsKeyId"
: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true. You can specify the CMK using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails."MultiAttachEnabled"
: Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide."OutpostArn"
: The Amazon Resource Name (ARN) of the Outpost."Size"
: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: gp2 and gp3: 1-16,384 io1 and io2: 4-16,384 st1 and sc1: 125-16,384 standard: 1-1,024"SnapshotId"
: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size."TagSpecification"
: The tags to apply to the volume during creation."Throughput"
: The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000."VolumeType"
: The volume type. This parameter can be one of the following values: General Purpose SSD: gp2 | gp3 Provisioned IOPS SSD: io1 | io2 Throughput Optimized HDD: st1 Cold HDD: sc1 Magnetic: standard For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: gp2"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."encrypted"
: Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
Main.Ec2.create_vpc
— Methodcreate_vpc(cidr_block)
create_vpc(cidr_block, params::Dict{String,<:Any})
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide. You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). By default, each instance 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 Options Sets in the Amazon Virtual Private Cloud User Guide. You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
Arguments
cidr_block
: The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Ipv6CidrBlock"
: The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request. To let Amazon choose the IPv6 CIDR block for you, omit this parameter."Ipv6CidrBlockNetworkBorderGroup"
: The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location. You must set AmazonProvidedIpv6CidrBlock to true to use this parameter."Ipv6Pool"
: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block."TagSpecification"
: The tags to assign to the VPC."amazonProvidedIpv6CidrBlock"
: Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."instanceTenancy"
: The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC. Important: The host value cannot be used with this parameter. Use the default or dedicated values only. Default: default
Main.Ec2.create_vpc_endpoint
— Methodcreate_vpc_endpoint(service_name, vpc_id)
create_vpc_endpoint(service_name, vpc_id, params::Dict{String,<:Any})
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide. A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint, which will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface. A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service. Use DescribeVpcEndpointServices to get a list of supported services.
Arguments
service_name
: The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.vpc_id
: The ID of the VPC in which the endpoint will be used.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PolicyDocument"
: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service."PrivateDnsEnabled"
: (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes. Default: true"RouteTableId"
: (Gateway endpoint) One or more route table IDs."SecurityGroupId"
: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface."SubnetId"
: (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only."TagSpecification"
: The tags to associate with the endpoint."VpcEndpointType"
: The type of endpoint. Default: Gateway
Main.Ec2.create_vpc_endpoint_connection_notification
— Methodcreate_vpc_endpoint_connection_notification(connection_notification_arn, item)
create_vpc_endpoint_connection_notification(connection_notification_arn, item, params::Dict{String,<:Any})
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 Create a Topic in the Amazon Simple Notification Service Developer Guide. You can create a connection notification for interface endpoints only.
Arguments
connection_notification_arn
: The ARN of the SNS topic for the notifications.item
: One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."ConnectionEvents"
: One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ServiceId"
: The ID of the endpoint service."VpcEndpointId"
: The ID of the endpoint.
Main.Ec2.create_vpc_endpoint_service_configuration
— Methodcreate_vpc_endpoint_service_configuration()
create_vpc_endpoint_service_configuration(params::Dict{String,<:Any})
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. To create an endpoint service configuration, you must first 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. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide. If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AcceptanceRequired"
: Indicates whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections."ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GatewayLoadBalancerArn"
: The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers."NetworkLoadBalancerArn"
: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service."PrivateDnsName"
: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service."TagSpecification"
: The tags to associate with the service.
Main.Ec2.create_vpc_peering_connection
— Methodcreate_vpc_peering_connection()
create_vpc_peering_connection(params::Dict{String,<:Any})
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 AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide. 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"PeerRegion"
: The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. Default: The Region in which you make the request."TagSpecification"
: The tags to assign to the peering connection."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."peerOwnerId"
: The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID"peerVpcId"
: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request."vpcId"
: The ID of the requester VPC. You must specify this parameter in the request.
Main.Ec2.create_vpn_connection
— Methodcreate_vpn_connection(customer_gateway_id, type)
create_vpn_connection(customer_gateway_id, type, params::Dict{String,<:Any})
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Arguments
customer_gateway_id
: The ID of the customer gateway.type
: The type of VPN connection (ipsec.1).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to apply to the VPN connection."TransitGatewayId"
: The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway."VpnGatewayId"
: The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."options"
: The options for the VPN connection.
Main.Ec2.create_vpn_connection_route
— Methodcreate_vpn_connection_route(destination_cidr_block, vpn_connection_id)
create_vpn_connection_route(destination_cidr_block, vpn_connection_id, params::Dict{String,<:Any})
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Arguments
destination_cidr_block
: The CIDR block associated with the local subnet of the customer network.vpn_connection_id
: The ID of the VPN connection.
Main.Ec2.create_vpn_gateway
— Methodcreate_vpn_gateway(type)
create_vpn_gateway(type, params::Dict{String,<:Any})
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Arguments
type
: The type of VPN connection this virtual private gateway supports.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AmazonSideAsn"
: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. Default: 64512"AvailabilityZone"
: The Availability Zone for the virtual private gateway."TagSpecification"
: The tags to apply to the virtual private gateway."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_carrier_gateway
— Methoddelete_carrier_gateway(carrier_gateway_id)
delete_carrier_gateway(carrier_gateway_id, params::Dict{String,<:Any})
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.
Arguments
carrier_gateway_id
: The ID of the carrier gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_client_vpn_endpoint
— Methoddelete_client_vpn_endpoint(client_vpn_endpoint_id)
delete_client_vpn_endpoint(client_vpn_endpoint_id, params::Dict{String,<:Any})
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN to be deleted.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_client_vpn_route
— Methoddelete_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block)
delete_client_vpn_route(client_vpn_endpoint_id, destination_cidr_block, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint from which the route is to be deleted.destination_cidr_block
: The IPv4 address range, in CIDR notation, of the route to be deleted.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TargetVpcSubnetId"
: The ID of the target subnet used by the route.
Main.Ec2.delete_customer_gateway
— Methoddelete_customer_gateway(customer_gateway_id)
delete_customer_gateway(customer_gateway_id, params::Dict{String,<:Any})
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
Arguments
customer_gateway_id
: The ID of the customer gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_dhcp_options
— Methoddelete_dhcp_options(dhcp_options_id)
delete_dhcp_options(dhcp_options_id, params::Dict{String,<:Any})
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.
Arguments
dhcp_options_id
: The ID of the DHCP options set.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_egress_only_internet_gateway
— Methoddelete_egress_only_internet_gateway(egress_only_internet_gateway_id)
delete_egress_only_internet_gateway(egress_only_internet_gateway_id, params::Dict{String,<:Any})
Deletes an egress-only internet gateway.
Arguments
egress_only_internet_gateway_id
: The ID of the egress-only internet gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_fleets
— Methoddelete_fleets(fleet_id, terminate_instances)
delete_fleets(fleet_id, terminate_instances, params::Dict{String,<:Any})
Deletes the specified EC2 Fleet. After you delete an EC2 Fleet, it launches no new instances. You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deletedterminating state. Otherwise, the EC2 Fleet enters the deletedrunning state, and the instances continue to run until they are interrupted or you terminate them manually. For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported. Restrictions You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request. Up to 1000 instances can be terminated in a single request to delete instant fleets. For more information, see Deleting an EC2 Fleet in the Amazon EC2 User Guide.
Arguments
fleet_id
: The IDs of the EC2 Fleets.terminate_instances
: Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances. To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request. For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_flow_logs
— Methoddelete_flow_logs(flow_log_id)
delete_flow_logs(flow_log_id, params::Dict{String,<:Any})
Deletes one or more flow logs.
Arguments
flow_log_id
: One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_fpga_image
— Methoddelete_fpga_image(fpga_image_id)
delete_fpga_image(fpga_image_id, params::Dict{String,<:Any})
Deletes the specified Amazon FPGA Image (AFI).
Arguments
fpga_image_id
: The ID of the AFI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_internet_gateway
— Methoddelete_internet_gateway(internet_gateway_id)
delete_internet_gateway(internet_gateway_id, params::Dict{String,<:Any})
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
Arguments
internet_gateway_id
: The ID of the internet gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_key_pair
— Methoddelete_key_pair()
delete_key_pair(params::Dict{String,<:Any})
Deletes the specified key pair, by removing the public key from Amazon EC2.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"KeyName"
: The name of the key pair."KeyPairId"
: The ID of the key pair."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_launch_template
— Methoddelete_launch_template()
delete_launch_template(params::Dict{String,<:Any})
Deletes a launch template. Deleting a launch template deletes all of its versions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LaunchTemplateId"
: The ID of the launch template. You must specify either the launch template ID or launch template name in the request."LaunchTemplateName"
: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
Main.Ec2.delete_launch_template_versions
— Methoddelete_launch_template_versions(launch_template_version)
delete_launch_template_versions(launch_template_version, params::Dict{String,<:Any})
Deletes one or more versions of a launch template. You cannot 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.
Arguments
launch_template_version
: The version numbers of one or more launch template versions to delete.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LaunchTemplateId"
: The ID of the launch template. You must specify either the launch template ID or launch template name in the request."LaunchTemplateName"
: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
Main.Ec2.delete_local_gateway_route
— Methoddelete_local_gateway_route(destination_cidr_block, local_gateway_route_table_id)
delete_local_gateway_route(destination_cidr_block, local_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified local gateway route table.
Arguments
destination_cidr_block
: The CIDR range for the route. This must match the CIDR for the route exactly.local_gateway_route_table_id
: The ID of the local gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_local_gateway_route_table_vpc_association
— Methoddelete_local_gateway_route_table_vpc_association(local_gateway_route_table_vpc_association_id)
delete_local_gateway_route_table_vpc_association(local_gateway_route_table_vpc_association_id, params::Dict{String,<:Any})
Deletes the specified association between a VPC and local gateway route table.
Arguments
local_gateway_route_table_vpc_association_id
: The ID of the association.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_managed_prefix_list
— Methoddelete_managed_prefix_list(prefix_list_id)
delete_managed_prefix_list(prefix_list_id, params::Dict{String,<:Any})
Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
Arguments
prefix_list_id
: The ID of the prefix list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_nat_gateway
— Methoddelete_nat_gateway(nat_gateway_id)
delete_nat_gateway(nat_gateway_id, params::Dict{String,<:Any})
Deletes the specified NAT gateway. Deleting a 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.
Arguments
nat_gateway_id
: The ID of the NAT gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_acl
— Methoddelete_network_acl(network_acl_id)
delete_network_acl(network_acl_id, params::Dict{String,<:Any})
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.
Arguments
network_acl_id
: The ID of the network ACL.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_acl_entry
— Methoddelete_network_acl_entry(egress, network_acl_id, rule_number)
delete_network_acl_entry(egress, network_acl_id, rule_number, params::Dict{String,<:Any})
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
Arguments
egress
: Indicates whether the rule is an egress rule.network_acl_id
: The ID of the network ACL.rule_number
: The rule number of the entry to delete.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_insights_analysis
— Methoddelete_network_insights_analysis(network_insights_analysis_id)
delete_network_insights_analysis(network_insights_analysis_id, params::Dict{String,<:Any})
Deletes the specified network insights analysis.
Arguments
network_insights_analysis_id
: The ID of the network insights analysis.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_insights_path
— Methoddelete_network_insights_path(network_insights_path_id)
delete_network_insights_path(network_insights_path_id, params::Dict{String,<:Any})
Deletes the specified path.
Arguments
network_insights_path_id
: The ID of the path.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_interface
— Methoddelete_network_interface(network_interface_id)
delete_network_interface(network_interface_id, params::Dict{String,<:Any})
Deletes the specified network interface. You must detach the network interface before you can delete it.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_network_interface_permission
— Methoddelete_network_interface_permission(network_interface_permission_id)
delete_network_interface_permission(network_interface_permission_id, params::Dict{String,<:Any})
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.
Arguments
network_interface_permission_id
: The ID of the network interface permission.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Force"
: Specify true to remove the permission even if the network interface is attached to an instance.
Main.Ec2.delete_placement_group
— Methoddelete_placement_group(group_name)
delete_placement_group(group_name, params::Dict{String,<:Any})
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.
Arguments
group_name
: The name of the placement group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_queued_reserved_instances
— Methoddelete_queued_reserved_instances(reserved_instances_id)
delete_queued_reserved_instances(reserved_instances_id, params::Dict{String,<:Any})
Deletes the queued purchases for the specified Reserved Instances.
Arguments
reserved_instances_id
: The IDs of the Reserved Instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_route
— Methoddelete_route(route_table_id)
delete_route(route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified route table.
Arguments
route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DestinationPrefixListId"
: The ID of the prefix list for the route."destinationCidrBlock"
: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly."destinationIpv6CidrBlock"
: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_route_table
— Methoddelete_route_table(route_table_id)
delete_route_table(route_table_id, params::Dict{String,<:Any})
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.
Arguments
route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_security_group
— Methoddelete_security_group()
delete_security_group(params::Dict{String,<:Any})
Deletes a security group. If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"GroupId"
: The ID of the security group. Required for a nondefault VPC."GroupName"
: [EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_snapshot
— Methoddelete_snapshot(snapshot_id)
delete_snapshot(snapshot_id, params::Dict{String,<:Any})
Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. For more information, see Deleting an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
Arguments
snapshot_id
: The ID of the EBS snapshot.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_spot_datafeed_subscription
— Methoddelete_spot_datafeed_subscription()
delete_spot_datafeed_subscription(params::Dict{String,<:Any})
Deletes the data feed for Spot Instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_subnet
— Methoddelete_subnet(subnet_id)
delete_subnet(subnet_id, params::Dict{String,<:Any})
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
Arguments
subnet_id
: The ID of the subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_tags
— Methoddelete_tags(resource_id)
delete_tags(resource_id, params::Dict{String,<:Any})
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 Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
Arguments
resource_id
: The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."tag"
: The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string. If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).
Main.Ec2.delete_traffic_mirror_filter
— Methoddelete_traffic_mirror_filter(traffic_mirror_filter_id)
delete_traffic_mirror_filter(traffic_mirror_filter_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
Arguments
traffic_mirror_filter_id
: The ID of the Traffic Mirror filter.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_traffic_mirror_filter_rule
— Methoddelete_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id)
delete_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror rule.
Arguments
traffic_mirror_filter_rule_id
: The ID of the Traffic Mirror rule.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_traffic_mirror_session
— Methoddelete_traffic_mirror_session(traffic_mirror_session_id)
delete_traffic_mirror_session(traffic_mirror_session_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror session.
Arguments
traffic_mirror_session_id
: The ID of the Traffic Mirror session.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_traffic_mirror_target
— Methoddelete_traffic_mirror_target(traffic_mirror_target_id)
delete_traffic_mirror_target(traffic_mirror_target_id, params::Dict{String,<:Any})
Deletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
Arguments
traffic_mirror_target_id
: The ID of the Traffic Mirror target.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway
— Methoddelete_transit_gateway(transit_gateway_id)
delete_transit_gateway(transit_gateway_id, params::Dict{String,<:Any})
Deletes the specified transit gateway.
Arguments
transit_gateway_id
: The ID of the transit gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_connect
— Methoddelete_transit_gateway_connect(transit_gateway_attachment_id)
delete_transit_gateway_connect(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
Arguments
transit_gateway_attachment_id
: The ID of the Connect attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_connect_peer
— Methoddelete_transit_gateway_connect_peer(transit_gateway_connect_peer_id)
delete_transit_gateway_connect_peer(transit_gateway_connect_peer_id, params::Dict{String,<:Any})
Deletes the specified Connect peer.
Arguments
transit_gateway_connect_peer_id
: The ID of the Connect peer.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_multicast_domain
— Methoddelete_transit_gateway_multicast_domain(transit_gateway_multicast_domain_id)
delete_transit_gateway_multicast_domain(transit_gateway_multicast_domain_id, params::Dict{String,<:Any})
Deletes the specified transit gateway multicast domain.
Arguments
transit_gateway_multicast_domain_id
: The ID of the transit gateway multicast domain.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_peering_attachment
— Methoddelete_transit_gateway_peering_attachment(transit_gateway_attachment_id)
delete_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes a transit gateway peering attachment.
Arguments
transit_gateway_attachment_id
: The ID of the transit gateway peering attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_prefix_list_reference
— Methoddelete_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
delete_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
Arguments
prefix_list_id
: The ID of the prefix list.transit_gateway_route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_route
— Methoddelete_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
delete_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified route from the specified transit gateway route table.
Arguments
destination_cidr_block
: The CIDR range for the route. This must match the CIDR for the route exactly.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_route_table
— Methoddelete_transit_gateway_route_table(transit_gateway_route_table_id)
delete_transit_gateway_route_table(transit_gateway_route_table_id, params::Dict{String,<:Any})
Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
Arguments
transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_transit_gateway_vpc_attachment
— Methoddelete_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
delete_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Deletes the specified VPC attachment.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_volume
— Methoddelete_volume(volume_id)
delete_volume(volume_id, params::Dict{String,<:Any})
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 Deleting an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
Arguments
volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpc
— Methoddelete_vpc(vpc_id)
delete_vpc(vpc_id, params::Dict{String,<:Any})
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.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpc_endpoint_connection_notifications
— Methoddelete_vpc_endpoint_connection_notifications(connection_notification_id)
delete_vpc_endpoint_connection_notifications(connection_notification_id, params::Dict{String,<:Any})
Deletes one or more VPC endpoint connection notifications.
Arguments
connection_notification_id
: One or more notification IDs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpc_endpoint_service_configurations
— Methoddelete_vpc_endpoint_service_configurations(service_id)
delete_vpc_endpoint_service_configurations(service_id, params::Dict{String,<:Any})
Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
Arguments
service_id
: The IDs of one or more services.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpc_endpoints
— Methoddelete_vpc_endpoints(vpc_endpoint_id)
delete_vpc_endpoints(vpc_endpoint_id, params::Dict{String,<:Any})
Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints. Gateway endpoint, Gateway Load Balancer endpoint, Interface endpoint The following rules apply when you delete a VPC endpoint: When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint. When you delete a Gateway Load Balancer endpoint, we delete the 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 the endpoint network interfaces.
Arguments
vpc_endpoint_id
: One or more VPC endpoint IDs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpc_peering_connection
— Methoddelete_vpc_peering_connection(vpc_peering_connection_id)
delete_vpc_peering_connection(vpc_peering_connection_id, params::Dict{String,<:Any})
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 state.
Arguments
vpc_peering_connection_id
: The ID of the VPC peering connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpn_connection
— Methoddelete_vpn_connection(vpn_connection_id)
delete_vpn_connection(vpn_connection_id, params::Dict{String,<:Any})
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 AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.
Arguments
vpn_connection_id
: The ID of the VPN connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.delete_vpn_connection_route
— Methoddelete_vpn_connection_route(destination_cidr_block, vpn_connection_id)
delete_vpn_connection_route(destination_cidr_block, vpn_connection_id, params::Dict{String,<:Any})
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.
Arguments
destination_cidr_block
: The CIDR block associated with the local subnet of the customer network.vpn_connection_id
: The ID of the VPN connection.
Main.Ec2.delete_vpn_gateway
— Methoddelete_vpn_gateway(vpn_gateway_id)
delete_vpn_gateway(vpn_gateway_id, params::Dict{String,<:Any})
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.
Arguments
vpn_gateway_id
: The ID of the virtual private gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.deprovision_byoip_cidr
— Methoddeprovision_byoip_cidr(cidr)
deprovision_byoip_cidr(cidr, params::Dict{String,<:Any})
Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
Arguments
cidr
: The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.deregister_image
— Methodderegister_image(image_id)
deregister_image(image_id, params::Dict{String,<:Any})
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them. When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
Arguments
image_id
: The ID of the AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.deregister_instance_event_notification_attributes
— Methodderegister_instance_event_notification_attributes()
deregister_instance_event_notification_attributes(params::Dict{String,<:Any})
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."InstanceTagAttribute"
: Information about the tag keys to deregister.
Main.Ec2.deregister_transit_gateway_multicast_group_members
— Methodderegister_transit_gateway_multicast_group_members()
deregister_transit_gateway_multicast_group_members(params::Dict{String,<:Any})
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupIpAddress"
: The IP address assigned to the transit gateway multicast group."NetworkInterfaceIds"
: The IDs of the group members' network interfaces."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.deregister_transit_gateway_multicast_group_sources
— Methodderegister_transit_gateway_multicast_group_sources()
deregister_transit_gateway_multicast_group_sources(params::Dict{String,<:Any})
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupIpAddress"
: The IP address assigned to the transit gateway multicast group."NetworkInterfaceIds"
: The IDs of the group sources' network interfaces."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.describe_account_attributes
— Methoddescribe_account_attributes()
describe_account_attributes(params::Dict{String,<:Any})
Describes attributes of your AWS account. The following are the supported account attributes: supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. default-vpc: The ID of the default VPC for your account, or none. 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. vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface. max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"attributeName"
: The account attribute names."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_addresses
— Methoddescribe_addresses()
describe_addresses(params::Dict{String,<:Any})
Describes the specified Elastic IP addresses or all of your Elastic IP addresses. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllocationId"
: [EC2-VPC] Information about the allocation IDs."Filter"
: One or more filters. Filter names and values are case-sensitive. allocation-id - [EC2-VPC] The allocation ID for the address. association-id - [EC2-VPC] The association ID for the address. domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc). instance-id - The ID of the instance the address is associated with, if any. network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where AWS advertises IP addresses. network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any. network-interface-owner-id - The AWS account ID of the owner. private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address. public-ip - The Elastic IP address, or the carrier IP address. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."PublicIp"
: One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_addresses_attribute
— Methoddescribe_addresses_attribute()
describe_addresses_attribute(params::Dict{String,<:Any})
Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllocationId"
: [EC2-VPC] The allocation IDs."Attribute"
: The attribute of the IP address."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_aggregate_id_format
— Methoddescribe_aggregate_id_format()
describe_aggregate_id_format(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_availability_zones
— Methoddescribe_availability_zones()
describe_availability_zones(params::Dict{String,<:Any})
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone. For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions, Zones and Outposts in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllAvailabilityZones"
: Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status. If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in."Filter"
: The filters. group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). message - The Zone message. opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required). parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. region-name - The name of the Region for the Zone (for example, us-east-1). state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | information | impaired | unavailable). zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). zone-type - The type of zone, for example, local-zone. zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1). zone-type - The type of zone, for example, local-zone."ZoneId"
: The IDs of the Availability Zones, Local Zones, and Wavelength Zones."ZoneName"
: The names of the Availability Zones, Local Zones, and Wavelength Zones."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_bundle_tasks
— Methoddescribe_bundle_tasks()
describe_bundle_tasks(params::Dict{String,<:Any})
Describes the specified bundle tasks or all of your bundle tasks. Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"BundleId"
: The bundle task IDs. Default: Describes all your bundle tasks."Filter"
: The filters. bundle-id - The ID of the bundle task. error-code - If the task failed, the error code returned. error-message - If the task failed, the error message returned. instance-id - The ID of the instance. progress - The level of task completion, as a percentage (for example, 20%). s3-bucket - The Amazon S3 bucket to store the AMI. s3-prefix - The beginning of the AMI name. start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z). state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed). update-time - The time of the most recent update for the task."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_byoip_cidrs
— Methoddescribe_byoip_cidrs(max_results)
describe_byoip_cidrs(max_results, params::Dict{String,<:Any})
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr. To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
Arguments
max_results
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."NextToken"
: The token for the next page of results.
Main.Ec2.describe_capacity_reservations
— Methoddescribe_capacity_reservations()
describe_capacity_reservations(params::Dict{String,<:Any})
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CapacityReservationId"
: The ID of the Capacity Reservation."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. instance-type - The type of instance for which the Capacity Reservation reserves capacity. owner-id - The ID of the AWS account that owns the Capacity Reservation. availability-zone-id - The Availability Zone ID of the Capacity Reservation. instance-platform - The type of operating system for which the Capacity Reservation reserves capacity. availability-zone - The Availability Zone ID of the Capacity Reservation. tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: default - The Capacity Reservation is created on hardware that is shared with other AWS accounts. dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: active- The Capacity Reservation is active and the capacity is available for your use. expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use. cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use. pending - The Capacity Reservation request was successful but the capacity provisioning is still pending. failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes. start-date - The date and time at which the Capacity Reservation was started. end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. limited - The Capacity Reservation expires automatically at a specified date and time. instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include: open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters. targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error."NextToken"
: The token to use to retrieve the next page of results.
Main.Ec2.describe_carrier_gateways
— Methoddescribe_carrier_gateways()
describe_carrier_gateways(params::Dict{String,<:Any})
Describes one or more of your carrier gateways.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CarrierGatewayId"
: One or more carrier gateway IDs."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. carrier-gateway-id - The ID of the carrier gateway. state - The state of the carrier gateway (pending | failed | available | deleting | deleted). owner-id - The AWS account ID of the owner of the carrier gateway. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC associated with the carrier gateway."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_classic_link_instances
— Methoddescribe_classic_link_instances()
describe_classic_link_instances(params::Dict{String,<:Any})
Describes one or more of 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. group-id - The ID of a VPC security group that's associated with the instance. instance-id - The ID of the instance. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC to which the instance is linked. vpc-id - The ID of the VPC that the instance is linked to."InstanceId"
: One or more instance IDs. Must be instances linked to a VPC through ClassicLink."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. Constraint: If the value is greater than 1000, we return only 1000 items."nextToken"
: The token for the next page of results.
Main.Ec2.describe_client_vpn_authorization_rules
— Methoddescribe_client_vpn_authorization_rules(client_vpn_endpoint_id)
describe_client_vpn_authorization_rules(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the authorization rules for a specified Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. description - The description of the authorization rule. destination-cidr - The CIDR of the network to which the authorization rule applies. group-id - The ID of the Active Directory group to which the authorization rule grants access."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_client_vpn_connections
— Methoddescribe_client_vpn_connections(client_vpn_endpoint_id)
describe_client_vpn_connections(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. connection-id - The ID of the connection. username - For Active Directory client authentication, the user name of the client who established the client connection."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_client_vpn_endpoints
— Methoddescribe_client_vpn_endpoints()
describe_client_vpn_endpoints(params::Dict{String,<:Any})
Describes one or more Client VPN endpoints in the account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientVpnEndpointId"
: The ID of the Client VPN endpoint."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. endpoint-id - The ID of the Client VPN endpoint. transport-protocol - The transport protocol (tcp | udp)."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_client_vpn_routes
— Methoddescribe_client_vpn_routes(client_vpn_endpoint_id)
describe_client_vpn_routes(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the routes for the specified Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. destination-cidr - The CIDR of the route destination. origin - How the route was associated with the Client VPN endpoint (associate | add-route). target-subnet - The ID of the subnet through which traffic is routed."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_client_vpn_target_networks
— Methoddescribe_client_vpn_target_networks(client_vpn_endpoint_id)
describe_client_vpn_target_networks(client_vpn_endpoint_id, params::Dict{String,<:Any})
Describes the target networks associated with the specified Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AssociationIds"
: The IDs of the target network associations."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. association-id - The ID of the association. target-network-id - The ID of the subnet specified as the target network. vpc-id - The ID of the VPC in which the target network is located."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_coip_pools
— Methoddescribe_coip_pools()
describe_coip_pools(params::Dict{String,<:Any})
Describes the specified customer-owned address pools or all of your customer-owned address pools.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. The following are the possible values: coip-pool.pool-id coip-pool.local-gateway-route-table-id"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."PoolId"
: The IDs of the address pools.
Main.Ec2.describe_conversion_tasks
— Methoddescribe_conversion_tasks()
describe_conversion_tasks(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"conversionTaskId"
: The conversion task IDs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_customer_gateways
— Methoddescribe_customer_gateways()
describe_customer_gateways(params::Dict{String,<:Any})
Describes one or more of your VPN customer gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CustomerGatewayId"
: One or more customer gateway IDs. Default: Describes all your customer gateways."Filter"
: One or more filters. bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). customer-gateway-id - The ID of the customer gateway. ip-address - The IP address of the customer gateway's Internet-routable external interface. state - The state of the customer gateway (pending | available | deleting | deleted). type - The type of customer gateway. Currently, the only supported type is ipsec.1. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_dhcp_options
— Methoddescribe_dhcp_options()
describe_dhcp_options(params::Dict{String,<:Any})
Describes one or more of your DHCP options sets. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DhcpOptionsId"
: The IDs of one or more DHCP options sets. Default: Describes all your DHCP options sets."Filter"
: One or more filters. dhcp-options-id - The ID of a DHCP options set. key - The key for one of the options (for example, domain-name). value - The value for one of the options. owner-id - The ID of the AWS account that owns the DHCP options set. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_egress_only_internet_gateways
— Methoddescribe_egress_only_internet_gateways()
describe_egress_only_internet_gateways(params::Dict{String,<:Any})
Describes one or more of your egress-only internet gateways.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."EgressOnlyInternetGatewayId"
: One or more egress-only internet gateway IDs."Filter"
: One or more filters. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_elastic_gpus
— Methoddescribe_elastic_gpus()
describe_elastic_gpus(params::Dict{String,<:Any})
Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ElasticGpuId"
: The Elastic Graphics accelerator IDs."Filter"
: The filters. availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides. elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED). elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED). elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium. instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_export_image_tasks
— Methoddescribe_export_image_tasks()
describe_export_image_tasks(params::Dict{String,<:Any})
Describes the specified export image tasks or all of your export image tasks.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ExportImageTaskId"
: The IDs of the export image tasks."Filter"
: Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted."MaxResults"
: The maximum number of results to return in a single call."NextToken"
: A token that indicates the next page of results.
Main.Ec2.describe_export_tasks
— Methoddescribe_export_tasks()
describe_export_tasks(params::Dict{String,<:Any})
Describes the specified export instance tasks or all of your export instance tasks.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: the filters for the export tasks."exportTaskId"
: The export task IDs.
Main.Ec2.describe_fast_snapshot_restores
— Methoddescribe_fast_snapshot_restores()
describe_fast_snapshot_restores(params::Dict{String,<:Any})
Describes the state of fast snapshot restores for your snapshots.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. The possible values are: availability-zone: The Availability Zone of the snapshot. owner-id: The ID of the AWS account that enabled fast snapshot restore on the snapshot. snapshot-id: The ID of the snapshot. state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled)."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_fleet_history
— Methoddescribe_fleet_history(fleet_id, start_time)
describe_fleet_history(fleet_id, start_time, params::Dict{String,<:Any})
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 Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
Arguments
fleet_id
: The ID of the EC2 Fleet.start_time
: The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."EventType"
: The type of events to describe. By default, all events are described."MaxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token for the next set of results.
Main.Ec2.describe_fleet_instances
— Methoddescribe_fleet_instances(fleet_id)
describe_fleet_instances(fleet_id, params::Dict{String,<:Any})
Describes the running instances for the specified EC2 Fleet. For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
Arguments
fleet_id
: The ID of the EC2 Fleet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. instance-type - The instance type."MaxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token for the next set of results.
Main.Ec2.describe_fleets
— Methoddescribe_fleets()
describe_fleets(params::Dict{String,<:Any})
Describes the specified EC2 Fleets or all of your EC2 Fleets. For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled). excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false). fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying). replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false). type - The type of request (instant | request | maintain)."FleetId"
: The ID of the EC2 Fleets."MaxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token for the next set of results.
Main.Ec2.describe_flow_logs
— Methoddescribe_flow_logs()
describe_flow_logs(params::Dict{String,<:Any})
Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. deliver-log-status - The status of the logs delivery (SUCCESS | FAILED). log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3. flow-log-id- The ID of the flow log. log-group-name - The name of the log group. resource-id -
"FlowLogId"
: One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_fpga_image_attribute
— Methoddescribe_fpga_image_attribute(attribute, fpga_image_id)
describe_fpga_image_attribute(attribute, fpga_image_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
Arguments
attribute
: The AFI attribute.fpga_image_id
: The ID of the AFI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_fpga_images
— Methoddescribe_fpga_images()
describe_fpga_images(params::Dict{String,<:Any})
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. create-time - The creation time of the AFI. fpga-image-id- The FPGA image identifier (AFI ID). fpga-image-global-id - The global FPGA image
"FpgaImageId"
: The AFI IDs."MaxResults"
: The maximum number of results to return in a single call."NextToken"
: The token to retrieve the next page of results."Owner"
: Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).
Main.Ec2.describe_host_reservation_offerings
— Methoddescribe_host_reservation_offerings()
describe_host_reservation_offerings(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. instance-family - The instance family of the offering (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront)."MaxDuration"
: This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error."MinDuration"
: This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year."NextToken"
: The token to use to retrieve the next page of results."OfferingId"
: The ID of the reservation offering.
Main.Ec2.describe_host_reservations
— Methoddescribe_host_reservations()
describe_host_reservations(params::Dict{String,<:Any})
Describes reservations that are associated with Dedicated Hosts in your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. instance-family - The instance family (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront). state - The state of the reservation (payment-pending | payment-failed | active | retired). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."HostReservationIdSet"
: The host reservation IDs."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error."NextToken"
: The token to use to retrieve the next page of results.
Main.Ec2.describe_hosts
— Methoddescribe_hosts()
describe_hosts(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"filter"
: The filters. auto-placement - Whether auto-placement is enabled or disabled (on | off). availability-zone - The Availability Zone of the host. client-token - The idempotency token that you provided when you allocated the host. host-reservation-id - The ID of the reservation assigned to this host. instance-type - The instance type size that the Dedicated Host is configured to support. state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure). tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."hostId"
: The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches."maxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. You cannot specify this parameter and the host IDs parameter in the same request."nextToken"
: The token to use to retrieve the next page of results.
Main.Ec2.describe_iam_instance_profile_associations
— Methoddescribe_iam_instance_profile_associations()
describe_iam_instance_profile_associations(params::Dict{String,<:Any})
Describes your IAM instance profile associations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AssociationId"
: The IAM instance profile associations."Filter"
: The filters. instance-id - The ID of the instance. state - The state of the association (associating | associated | disassociating)."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_id_format
— Methoddescribe_id_format()
describe_id_format(params::Dict{String,<:Any})
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 AWS 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Resource"
: The type of resource: 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
Main.Ec2.describe_identity_id_format
— Methoddescribe_identity_id_format(principal_arn)
describe_identity_id_format(principal_arn, params::Dict{String,<:Any})
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.
Arguments
principal_arn
: The ARN of the principal, which can be an IAM role, IAM user, or the root user.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"resource"
: The type of resource: 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
Main.Ec2.describe_image_attribute
— Methoddescribe_image_attribute(attribute, image_id)
describe_image_attribute(attribute, image_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
Arguments
attribute
: The AMI attribute. Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.image_id
: The ID of the AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_images
— Methoddescribe_images()
describe_images(params::Dict{String,<:Any})
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 AWS 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 results in an error indicating that the AMI ID cannot be found.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ExecutableBy"
: Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs)."Filter"
: The filters. architecture - The image architecture (i386 | x86_64 | arm64). block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume. block-device-mapping.volume-size - The volume size of the EBS volume, in GiB. block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | io2 | st1 | sc1 | standard). block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted. description - The description of the image (provided during image creation). ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. hypervisor - The hypervisor type (ovm | xen). image-id - The ID of the image. image-type - The image type (machine | kernel | ramdisk). is-public - A Boolean that indicates whether the image is public. kernel-id - The kernel ID. manifest-location - The location of the image manifest. name - The name of the AMI (provided during image creation). owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter. owner-id - The AWS account ID of the owner. We recommend that you use the Owner request parameter instead of this filter. platform - The platform. To only list Windows-based AMIs, use windows. product-code - The product code. product-code.type - The type of the product code (devpay | marketplace). ramdisk-id - The RAM disk ID. root-device-name - The device name of the root device volume (for example, /dev/sda1). root-device-type - The type of the root device volume (ebs | instance-store). state - The state of the image (available | pending | failed). state-reason-code - The reason code for the state change. state-reason-message - The message for the state change. sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. virtualization-type - The virtualization type (paravirtual | hvm)."ImageId"
: The image IDs. Default: Describes all images available to you."Owner"
: Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_import_image_tasks
— Methoddescribe_import_image_tasks()
describe_import_image_tasks(params::Dict{String,<:Any})
Displays details about an import virtual machine or import snapshot tasks that are already created.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filters"
: Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted."ImportTaskId"
: The IDs of the import image tasks."MaxResults"
: The maximum number of results to return in a single call."NextToken"
: A token that indicates the next page of results.
Main.Ec2.describe_import_snapshot_tasks
— Methoddescribe_import_snapshot_tasks()
describe_import_snapshot_tasks(params::Dict{String,<:Any})
Describes your import snapshot tasks.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filters"
: The filters."ImportTaskId"
: A list of import snapshot task IDs."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: A token that indicates the next page of results.
Main.Ec2.describe_instance_attribute
— Methoddescribe_instance_attribute(attribute, instance_id)
describe_instance_attribute(attribute, instance_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
Arguments
attribute
: The instance attribute. Note: The enaSupport attribute is not supported at this time.instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_instance_credit_specifications
— Methoddescribe_instance_credit_specifications()
describe_instance_credit_specifications(params::Dict{String,<:Any})
Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited. If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. instance-id - The ID of the instance."InstanceId"
: The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_instance_event_notification_attributes
— Methoddescribe_instance_event_notification_attributes()
describe_instance_event_notification_attributes(params::Dict{String,<:Any})
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_instance_status
— Methoddescribe_instance_status()
describe_instance_status(params::Dict{String,<:Any})
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 Troubleshooting instances with failed status checks in the Amazon EC2 User Guide. Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide. Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. availability-zone - The Availability Zone of the instance. event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop). event.description - A description of the event. event.instance-event-id - The ID of the event whose date and time you are modifying. event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z). event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z). instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data). instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable). system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data). system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable)."InstanceId"
: The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call."NextToken"
: The token to retrieve the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."includeAllInstances"
: When true, includes the health status for all instances. When false, includes the health status for running instances only. Default: false
Main.Ec2.describe_instance_type_offerings
— Methoddescribe_instance_type_offerings()
describe_instance_type_offerings(params::Dict{String,<:Any})
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. location- This depends on the location type. For example, if the location type is region (default),
"LocationType"
: The location type."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_instance_types
— Methoddescribe_instance_types()
describe_instance_types(params::Dict{String,<:Any})
Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. Filter names and values are case-sensitive. auto-recovery-supported - Indicates whether auto recovery is supported (true | false). bare-metal - Indicates whether it is a bare metal instance type (true | false). burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false). current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false). ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-support- Indicates whether the instance type is EBS-optimized (supported | unsupported | default). ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported |
- The maximum number of private IPv4 addresses per network interface.
- The CPU architecture (arm64 | i386 | x86_64).
"InstanceType"
: The instance types. For more information, see Instance types in the Amazon EC2 User Guide."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_instances
— Methoddescribe_instances()
describe_instances(params::Dict{String,<:Any})
Describes the specified instances or all instances. If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. affinity - The affinity setting for an instance running on a Dedicated Host (default | host). architecture - The instance architecture (i386 | x86_64 | arm64). availability-zone - The Availability Zone of the instance. block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z. block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination. block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh). block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached). block-device-mapping.volume-id - The volume ID of the EBS volume. client-token - The idempotency token you provided when you launched the instance. dns-name - The public DNS name of the instance. group-id - The ID of the security group for the instance. EC2-Classic only. group-name - The name of the security group for the instance. EC2-Classic only. hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation. host-id - The ID of the Dedicated Host on which the instance is running, if applicable. hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors. iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN. image-id - The ID of the image used to launch the instance. instance-id - The ID of the instance. instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled). instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped). instance-type - The type of instance (for example, t2.micro). instance.group-id - The ID of the security group for the instance. instance.group-name - The name of the security group for the instance. ip-address - The public IPv4 address of the instance. kernel-id - The kernel ID. key-name - The name of the key pair used when the instance was launched. launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). launch-time - The time when the instance was launched. metadata-options.http-tokens - The metadata request authorization state (optional | required) metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64) metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled) monitoring-state- Indicates whether detailed monitoring is enabled (disabled | enabled).
- The time that the network interface was attached to an instance.
- The platform. To list only Windows instances, use windows. private-dns-name - The
"InstanceId"
: The instance IDs. Default: Describes all your instances."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call."nextToken"
: The token to request the next page of results.
Main.Ec2.describe_internet_gateways
— Methoddescribe_internet_gateways()
describe_internet_gateways(params::Dict{String,<:Any})
Describes one or more of your internet gateways.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached. attachment.vpc-id - The ID of an attached VPC. internet-gateway-id - The ID of the Internet gateway. owner-id - The ID of the AWS account that owns the internet gateway. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."internetGatewayId"
: One or more internet gateway IDs. Default: Describes all your internet gateways.
Main.Ec2.describe_ipv6_pools
— Methoddescribe_ipv6_pools()
describe_ipv6_pools(params::Dict{String,<:Any})
Describes your IPv6 address pools.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."PoolId"
: The IDs of the IPv6 address pools.
Main.Ec2.describe_key_pairs
— Methoddescribe_key_pairs()
describe_key_pairs(params::Dict{String,<:Any})
Describes the specified key pairs or all of your key pairs. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. key-pair-id - The ID of the key pair. fingerprint - The fingerprint of the key pair. key-name - The name of the key pair. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value."KeyName"
: The key pair names. Default: Describes all your key pairs."KeyPairId"
: The IDs of the key pairs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_launch_template_versions
— Methoddescribe_launch_template_versions()
describe_launch_template_versions(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. create-time - The time the launch template version was created. ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O. iam-instance-profile - The ARN of the IAM instance profile. image-id - The ID of the AMI. instance-type - The instance type. is-default-version - A boolean that indicates whether the launch template version is the default version. kernel-id - The kernel ID. ram-disk-id - The RAM disk ID."LaunchTemplateId"
: The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter."LaunchTemplateName"
: The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter."LaunchTemplateVersion"
: One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account. To describe one or more versions of a specified launch template, valid values are Latest, Default, and numbers. To describe all launch templates in your account that are defined as the latest version, the valid value is Latest. To describe all launch templates in your account that are defined as the default version, the valid value is Default. You can specify Latest and Default in the same call. You cannot specify numbers."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200."MaxVersion"
: The version number up to which to describe launch template versions."MinVersion"
: The version number after which to describe launch template versions."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_launch_templates
— Methoddescribe_launch_templates()
describe_launch_templates(params::Dict{String,<:Any})
Describes one or more launch templates.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. create-time - The time the launch template was created. launch-template-name - The name of the launch template. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."LaunchTemplateId"
: One or more launch template IDs."LaunchTemplateName"
: One or more launch template names."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_local_gateway_route_table_virtual_interface_group_associations
— Methoddescribe_local_gateway_route_table_virtual_interface_group_associations()
describe_local_gateway_route_table_virtual_interface_group_associations(params::Dict{String,<:Any})
Describes the associations between virtual interface groups and local gateway route tables.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-virtual-interface-group-association-id - The ID of the association. local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group. state - The state of the association."LocalGatewayRouteTableVirtualInterfaceGroupAssociationId"
: The IDs of the associations."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_local_gateway_route_table_vpc_associations
— Methoddescribe_local_gateway_route_table_vpc_associations()
describe_local_gateway_route_table_vpc_associations(params::Dict{String,<:Any})
Describes the specified associations between VPCs and local gateway route tables.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-vpc-association-id - The ID of the association. state - The state of the association. vpc-id - The ID of the VPC."LocalGatewayRouteTableVpcAssociationId"
: The IDs of the associations."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_local_gateway_route_tables
— Methoddescribe_local_gateway_route_tables()
describe_local_gateway_route_tables(params::Dict{String,<:Any})
Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-id - The ID of a local gateway route table. outpost-arn - The Amazon Resource Name (ARN) of the Outpost. state - The state of the local gateway route table."LocalGatewayRouteTableId"
: The IDs of the local gateway route tables."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_local_gateway_virtual_interface_groups
— Methoddescribe_local_gateway_virtual_interface_groups()
describe_local_gateway_virtual_interface_groups(params::Dict{String,<:Any})
Describes the specified local gateway virtual interface groups.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-virtual-interface-id - The ID of the virtual interface. local-gateway-virtual-interface-group-id - The ID of the virtual interface group."LocalGatewayVirtualInterfaceGroupId"
: The IDs of the virtual interface groups."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_local_gateway_virtual_interfaces
— Methoddescribe_local_gateway_virtual_interfaces()
describe_local_gateway_virtual_interfaces(params::Dict{String,<:Any})
Describes the specified local gateway virtual interfaces.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters."LocalGatewayVirtualInterfaceId"
: The IDs of the virtual interfaces."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_local_gateways
— Methoddescribe_local_gateways()
describe_local_gateways(params::Dict{String,<:Any})
Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters."LocalGatewayId"
: One or more filters. local-gateway-id - The ID of a local gateway. local-gateway-route-table-id - The ID of the local gateway route table. local-gateway-route-table-virtual-interface-group-association-id - The ID of the association. local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group. outpost-arn - The Amazon Resource Name (ARN) of the Outpost. state - The state of the association."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.describe_managed_prefix_lists
— Methoddescribe_managed_prefix_lists()
describe_managed_prefix_lists(params::Dict{String,<:Any})
Describes your managed prefix lists and any AWS-managed prefix lists. To view the entries for your prefix list, use GetManagedPrefixListEntries.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. owner-id - The ID of the prefix list owner. prefix-list-id - The ID of the prefix list. prefix-list-name - The name of the prefix list."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."PrefixListId"
: One or more prefix list IDs.
Main.Ec2.describe_moving_addresses
— Methoddescribe_moving_addresses()
describe_moving_addresses(params::Dict{String,<:Any})
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."filter"
: One or more filters. moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic)."maxResults"
: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned. Default: If no value is provided, the default is 1000."nextToken"
: The token for the next page of results."publicIp"
: One or more Elastic IP addresses.
Main.Ec2.describe_nat_gateways
— Methoddescribe_nat_gateways()
describe_nat_gateways(params::Dict{String,<:Any})
Describes one or more of your NAT gateways.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. nat-gateway-id - The ID of the NAT gateway. state- The state of the NAT gateway (pending | failed | available | deleting | deleted).
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NatGatewayId"
: One or more NAT gateway IDs."NextToken"
: The token for the next page of results.
Main.Ec2.describe_network_acls
— Methoddescribe_network_acls()
describe_network_acls(params::Dict{String,<:Any})
Describes one or more of your network ACLs. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. association.association-id - The ID of an association ID for the ACL. association.network-acl-id - The ID of the network ACL involved in the association. association.subnet-id - The ID of the subnet involved in the association. default - Indicates whether the ACL is the default network ACL for the VPC. entry.cidr- The IPv4 CIDR range specified in the entry. entry.icmp.code - The ICMP code specified
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NetworkAclId"
: One or more network ACL IDs. Default: Describes all your network ACLs."NextToken"
: The token for the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_network_insights_analyses
— Methoddescribe_network_insights_analyses()
describe_network_insights_analyses(params::Dict{String,<:Any})
Describes one or more of your network insights analyses.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AnalysisEndTime"
: The time when the network insights analyses ended."AnalysisStartTime"
: The time when the network insights analyses started."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. The following are possible values: PathFound - A Boolean value that indicates whether a feasible path is found. Status - The status of the analysis (running | succeeded | failed)."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NetworkInsightsAnalysisId"
: The ID of the network insights analyses. You must specify either analysis IDs or a path ID."NetworkInsightsPathId"
: The ID of the path. You must specify either a path ID or analysis IDs."NextToken"
: The token for the next page of results.
Main.Ec2.describe_network_insights_paths
— Methoddescribe_network_insights_paths()
describe_network_insights_paths(params::Dict{String,<:Any})
Describes one or more of your paths.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. The following are possible values: Destination - The ID of the resource. DestinationPort - The destination port. Name - The path name. Protocol - The protocol. Source - The ID of the resource."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NetworkInsightsPathId"
: The IDs of the paths."NextToken"
: The token for the next page of results.
Main.Ec2.describe_network_interface_attribute
— Methoddescribe_network_interface_attribute(network_interface_id)
describe_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
Describes a network interface attribute. You can specify only one attribute at a time.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"attribute"
: The attribute of the network interface. This parameter is required."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_network_interface_permissions
— Methoddescribe_network_interface_permissions()
describe_network_interface_permissions(params::Dict{String,<:Any})
Describes the permissions for your network interfaces.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. network-interface-permission.network-interface-permission-id - The ID of the permission. network-interface-permission.network-interface-id - The ID of the network interface. network-interface-permission.aws-account-id - The AWS account ID. network-interface-permission.aws-service - The AWS service. network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE)."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default."NetworkInterfacePermissionId"
: One or more network interface permission IDs."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_network_interfaces
— Methoddescribe_network_interfaces()
describe_network_interfaces(params::Dict{String,<:Any})
Describes one or more of your network interfaces.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request."NetworkInterfaceId"
: One or more network interface IDs. Default: Describes all your network interfaces."NextToken"
: The token to retrieve the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."filter"
: One or more filters. addresses.private-ip-address - The private IPv4 addresses associated with the network interface. addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface. addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4). addresses.association.owner-id - The owner ID of the addresses associated with the network interface. association.association-id - The association ID returned when the network interface was associated with an IPv4 address. association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface. association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface. association.public-dns-name - The public DNS name for the network interface (IPv4). attachment.attachment-id - The ID of the interface attachment. attachment.attach-time - The time that the network interface was attached to an instance. attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated. attachment.device-index - The device index to which the network interface is attached. attachment.instance-id - The ID of the instance to which the network interface is attached. attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached. attachment.status - The status of the attachment (attaching | attached | detaching | detached). availability-zone - The Availability Zone of the network interface. description - The description of the network interface. group-id - The ID of a security group associated with the network interface. group-name - The name of a security group associated with the network interface. ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface. mac-address - The MAC address of the network interface. network-interface-id - The ID of the network interface. owner-id - The AWS account ID of the network interface owner. private-ip-address - The private IPv4 address or addresses of the network interface. private-dns-name - The private DNS name of the network interface (IPv4). requester-id - The alias or AWS account ID of the principal or service that created the network interface. requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on). source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC. status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use. subnet-id - The ID of the subnet for the network interface. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the network interface.
Main.Ec2.describe_placement_groups
— Methoddescribe_placement_groups()
describe_placement_groups(params::Dict{String,<:Any})
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. group-name - The name of the placement group. state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value."GroupId"
: The IDs of the placement groups."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."groupName"
: The names of the placement groups. Default: Describes all your placement groups, or only those otherwise specified.
Main.Ec2.describe_prefix_lists
— Methoddescribe_prefix_lists()
describe_prefix_lists(params::Dict{String,<:Any})
Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. We recommend that you use DescribeManagedPrefixLists instead.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. prefix-list-id: The ID of a prefix list. prefix-list-name: The name of a prefix list."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."PrefixListId"
: One or more prefix list IDs.
Main.Ec2.describe_principal_id_format
— Methoddescribe_principal_id_format()
describe_principal_id_format(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token to request the next page of results."Resource"
: The type of resource: 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
Main.Ec2.describe_public_ipv4_pools
— Methoddescribe_public_ipv4_pools()
describe_public_ipv4_pools(params::Dict{String,<:Any})
Describes the specified IPv4 address pools.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."PoolId"
: The IDs of the address pools.
Main.Ec2.describe_regions
— Methoddescribe_regions()
describe_regions(params::Dict{String,<:Any})
Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see Regions and Endpoints. For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllRegions"
: Indicates whether to display all Regions, including Regions that are disabled for your account."Filter"
: The filters. endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com). opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in). region-name - The name of the Region (for example, us-east-1)."RegionName"
: The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_replace_root_volume_tasks
— Methoddescribe_replace_root_volume_tasks()
describe_replace_root_volume_tasks(params::Dict{String,<:Any})
Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: Filter to use: instance-id - The ID of the instance for which the root volume replacement task was created."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."ReplaceRootVolumeTaskId"
: The ID of the root volume replacement task to view.
Main.Ec2.describe_reserved_instances
— Methoddescribe_reserved_instances()
describe_reserved_instances(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000). end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type that is covered by the reservation. scope - The scope of the Reserved Instance (Region or Availability Zone). product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)). reserved-instances-id - The ID of the Reserved Instance. start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84)."OfferingClass"
: Describes whether the Reserved Instance is Standard or Convertible."ReservedInstancesId"
: One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."offeringType"
: The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
Main.Ec2.describe_reserved_instances_listings
— Methoddescribe_reserved_instances_listings()
describe_reserved_instances_listings(params::Dict{String,<:Any})
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 Reserved Instance Marketplace in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing. status - The status of the Reserved Instance listing (pending | active | cancelled | closed). status-message - The reason for the status."reservedInstancesId"
: One or more Reserved Instance IDs."reservedInstancesListingId"
: One or more Reserved Instance listing IDs.
Main.Ec2.describe_reserved_instances_modifications
— Methoddescribe_reserved_instances_modifications()
describe_reserved_instances_modifications(params::Dict{String,<:Any})
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 Modifying Reserved Instances in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. client-token - The idempotency token for the modification request. create-date - The time when the modification request was created. effective-date - The time when the modification becomes effective. modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled. modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances. modification-result.target-configuration.instance-count - The number of new Reserved Instances. modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances. modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC). reserved-instances-id - The ID of the Reserved Instances modified. reserved-instances-modification-id - The ID of the modification request. status - The status of the Reserved Instances modification request (processing | fulfilled | failed). status-message - The reason for the status. update-date - The time when the modification request was last updated."ReservedInstancesModificationId"
: IDs for the submitted modification request."nextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_reserved_instances_offerings
— Methoddescribe_reserved_instances_offerings()
describe_reserved_instances_offerings(params::Dict{String,<:Any})
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 Reserved Instance Marketplace in the Amazon EC2 User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AvailabilityZone"
: The Availability Zone in which the Reserved Instance can be used."Filter"
: One or more filters. availability-zone - The Availability Zone where the Reserved Instance can be used. duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000). fixed-price - The purchase price of the Reserved Instance (for example, 9800.0). instance-type - The instance type that is covered by the reservation. marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed. product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)) reserved-instances-offering-id - The Reserved Instances offering ID. scope - The scope of the Reserved Instance (Availability Zone or Region). usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84)."IncludeMarketplace"
: Include Reserved Instance Marketplace offerings in the response."InstanceType"
: The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide."MaxDuration"
: The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years)"MaxInstanceCount"
: The maximum number of instances to filter when searching for offerings. Default: 20"MinDuration"
: The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month)"OfferingClass"
: The offering class of the Reserved Instance. Can be standard or convertible."ProductDescription"
: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC."ReservedInstancesOfferingId"
: One or more Reserved Instances offering IDs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."instanceTenancy"
: The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances). Important: The host value cannot be used with this parameter. Use the default or dedicated values only. Default: default"maxResults"
: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100. Default: 100"nextToken"
: The token to retrieve the next page of results."offeringType"
: The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
Main.Ec2.describe_route_tables
— Methoddescribe_route_tables()
describe_route_tables(params::Dict{String,<:Any})
Describes one or more of your route tables. 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 Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. association.route-table-association-id - The ID of an association ID for the route table. association.route-table-id - The ID of the route table involved in the association. association.subnet-id - The ID of the subnet involved in the association. association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response. owner-id - The ID of the AWS account that owns the route table. route-table-id - The ID of the route table. route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table. route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table. route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table. route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table. route.gateway-id - The ID of a gateway specified in a route in the table. route.instance-id - The ID of an instance specified in a route in the table. route.nat-gateway-id - The ID of a NAT gateway. route.transit-gateway-id - The ID of a transit gateway. route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation. route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the route table."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."RouteTableId"
: One or more route table IDs. Default: Describes all your route tables."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_scheduled_instance_availability
— Methoddescribe_scheduled_instance_availability(first_slot_start_time_range, recurrence)
describe_scheduled_instance_availability(first_slot_start_time_range, recurrence, params::Dict{String,<:Any})
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.
Arguments
first_slot_start_time_range
: The time period for the first schedule to start.recurrence
: The schedule recurrence.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. availability-zone - The Availability Zone (for example, us-west-2a). instance-type - The instance type (for example, c4.large). network-platform - The network platform (EC2-Classic or EC2-VPC). platform - The platform (Linux/UNIX or Windows)."MaxResults"
: The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value."MaxSlotDurationInHours"
: The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720."MinSlotDurationInHours"
: The minimum available duration, in hours. The minimum required duration is 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."NextToken"
: The token for the next set of results.
Main.Ec2.describe_scheduled_instances
— Methoddescribe_scheduled_instances()
describe_scheduled_instances(params::Dict{String,<:Any})
Describes the specified Scheduled Instances or all your Scheduled Instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. availability-zone - The Availability Zone (for example, us-west-2a). instance-type - The instance type (for example, c4.large). network-platform - The network platform (EC2-Classic or EC2-VPC). platform - The platform (Linux/UNIX or Windows)."MaxResults"
: The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token for the next set of results."ScheduledInstanceId"
: The Scheduled Instance IDs."SlotStartTimeRange"
: The time period for the first schedule to start.
Main.Ec2.describe_security_group_references
— Methoddescribe_security_group_references(item)
describe_security_group_references(item, params::Dict{String,<:Any})
[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
Arguments
item
: The IDs of the security groups in your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupId"
: The IDs of the security groups in your account.
Main.Ec2.describe_security_groups
— Methoddescribe_security_groups()
describe_security_groups(params::Dict{String,<:Any})
Describes the specified security groups or all of your security groups. A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters. description - The description of the security group. egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule. egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule. egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule. egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule. egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access. egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols). egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule. group-id - The ID of the security group. group-name - The name of the security group. ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule. ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule. ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule. ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule. ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access. ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols). ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule. owner-id - The AWS account ID of the owner of the security group. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC specified when the security group was created."GroupId"
: The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all your security groups."GroupName"
: [EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name. Default: Describes all your security groups."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned."NextToken"
: The token to request the next page of results."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_snapshot_attribute
— Methoddescribe_snapshot_attribute(attribute, snapshot_id)
describe_snapshot_attribute(attribute, snapshot_id, params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide.
Arguments
attribute
: The snapshot attribute you would like to view.snapshot_id
: The ID of the EBS snapshot.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_snapshots
— Methoddescribe_snapshots()
describe_snapshots(params::Dict{String,<:Any})
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 AWS accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots. explicit: The owner of the snapshot granted create volume permissions to a specific AWS account. implicit: An AWS 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 AWS 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 AWS 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 AWS 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. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results. To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores. For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. description - A description of the snapshot. encrypted - Indicates whether the snapshot is encrypted (true | false) owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter. progress - The progress of the snapshot, as a percentage (for example, 80%). snapshot-id - The snapshot ID. start-time - The time stamp when the snapshot was initiated. status - The status of the snapshot (pending | completed | error). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The ID of the volume the snapshot is for. volume-size - The size of the volume, in GiB."MaxResults"
: The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request."NextToken"
: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return."Owner"
: Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon."RestorableBy"
: The IDs of the AWS accounts that can create volumes from the snapshot."SnapshotId"
: The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_spot_datafeed_subscription
— Methoddescribe_spot_datafeed_subscription()
describe_spot_datafeed_subscription(params::Dict{String,<:Any})
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_spot_fleet_instances
— Methoddescribe_spot_fleet_instances(spot_fleet_request_id)
describe_spot_fleet_instances(spot_fleet_request_id, params::Dict{String,<:Any})
Describes the running instances for the specified Spot Fleet.
Arguments
spot_fleet_request_id
: The ID of the Spot Fleet request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."nextToken"
: The token for the next set of results.
Main.Ec2.describe_spot_fleet_request_history
— Methoddescribe_spot_fleet_request_history(spot_fleet_request_id, start_time)
describe_spot_fleet_request_history(spot_fleet_request_id, start_time, params::Dict{String,<:Any})
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.
Arguments
spot_fleet_request_id
: The ID of the Spot Fleet request.start_time
: The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."eventType"
: The type of events to describe. By default, all events are described."maxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."nextToken"
: The token for the next set of results.
Main.Ec2.describe_spot_fleet_requests
— Methoddescribe_spot_fleet_requests()
describe_spot_fleet_requests(params::Dict{String,<:Any})
Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."nextToken"
: The token for the next set of results."spotFleetRequestId"
: The IDs of the Spot Fleet requests.
Main.Ec2.describe_spot_instance_requests
— Methoddescribe_spot_instance_requests()
describe_spot_instance_requests(params::Dict{String,<:Any})
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 results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results. Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. availability-zone-group - The Availability Zone group. create-time - The time stamp when the Spot Instance request was created. fault-code - The fault code related to the request. fault-message - The fault message related to the request. instance-id - The ID of the instance that fulfilled the request. launch-group - The Spot Instance launch group. launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination. launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh). launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume. launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB. launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic. launch.group-id - The ID of the security group for the instance. launch.group-name - The name of the security group for the instance. launch.image-id - The ID of the AMI. launch.instance-type - The type of instance (for example, m3.medium). launch.kernel-id - The kernel ID. launch.key-name - The name of the key pair the instance launched with. launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance. launch.ramdisk-id - The RAM disk ID. launched-availability-zone - The Availability Zone in which the request is launched. network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address. network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated. network-interface.description - A description of the network interface. network-interface.device-index - The index of the device for the network interface attachment on the instance. network-interface.group-id - The ID of the security group associated with the network interface. network-interface.network-interface-id - The ID of the network interface. network-interface.private-ip-address - The primary private IP address of the network interface. network-interface.subnet-id - The ID of the subnet for the instance. product-description - The product description associated with the instance (Linux/UNIX | Windows). spot-instance-request-id - The Spot Instance request ID. spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request. state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances. status-code - The short code describing the most recent evaluation of your Spot Instance request. status-message - The message explaining the status of the Spot Instance request. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of Spot Instance request (one-time | persistent). valid-from - The start date of the request. valid-until - The end date of the request."MaxResults"
: The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value."NextToken"
: The token to request the next set of results. This value is null when there are no more results to return."SpotInstanceRequestId"
: One or more Spot Instance request IDs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_spot_price_history
— Methoddescribe_spot_price_history()
describe_spot_price_history(params::Dict{String,<:Any})
Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances. 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. availability-zone - The Availability Zone for which prices should be returned. instance-type - The type of instance (for example, m3.medium). product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)). spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported). timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported."InstanceType"
: Filters the results by the specified instance types."ProductDescription"
: Filters the results by the specified basic product descriptions."availabilityZone"
: Filters the results by the specified Availability Zone."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."endTime"
: The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)."maxResults"
: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value."nextToken"
: The token for the next set of results."startTime"
: The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
Main.Ec2.describe_stale_security_groups
— Methoddescribe_stale_security_groups(vpc_id)
describe_stale_security_groups(vpc_id, params::Dict{String,<:Any})
[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results."NextToken"
: The token for the next set of items to return. (You received this token from a prior call.)
Main.Ec2.describe_store_image_tasks
— Methoddescribe_store_image_tasks()
describe_store_image_tasks(params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide. For more information, see Store and restore an AMI using S3 in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. task-state - Returns tasks in a certain state (InProgress | Completed | Failed) bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name."ImageId"
: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call."NextToken"
: The token for the next page of results.
Main.Ec2.describe_subnets
— Methoddescribe_subnets()
describe_subnets(params::Dict{String,<:Any})
Describes one or more of your subnets. For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name. availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name. available-ip-address-count - The number of IPv4 addresses in the subnet that are available. cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names. default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name. ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet. outpost-arn - The Amazon Resource Name (ARN) of the Outpost. owner-id - The ID of the AWS account that owns the subnet. state - The state of the subnet (pending | available). subnet-arn - The Amazon Resource Name (ARN) of the subnet. subnet-id - The ID of the subnet. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the subnet."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."SubnetId"
: One or more subnet IDs. Default: Describes all your subnets."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_tags
— Methoddescribe_tags()
describe_tags(params::Dict{String,<:Any})
Describes the specified tags for your EC2 resources. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. key - The tag key. resource-id - The ID of the resource. resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway). tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". value - The tag value."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value."nextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_traffic_mirror_filters
— Methoddescribe_traffic_mirror_filters()
describe_traffic_mirror_filters(params::Dict{String,<:Any})
Describes one or more Traffic Mirror filters.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: description: The Traffic Mirror filter description. traffic-mirror-filter-id: The ID of the Traffic Mirror filter."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TrafficMirrorFilterId"
: The ID of the Traffic Mirror filter.
Main.Ec2.describe_traffic_mirror_sessions
— Methoddescribe_traffic_mirror_sessions()
describe_traffic_mirror_sessions(params::Dict{String,<:Any})
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: description: The Traffic Mirror session description. network-interface-id: The ID of the Traffic Mirror session network interface. owner-id: The ID of the account that owns the Traffic Mirror session. packet-length: The assigned number of packets to mirror. session-number: The assigned session number. traffic-mirror-filter-id: The ID of the Traffic Mirror filter. traffic-mirror-session-id: The ID of the Traffic Mirror session. traffic-mirror-target-id: The ID of the Traffic Mirror target. virtual-network-id: The virtual network ID of the Traffic Mirror session."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TrafficMirrorSessionId"
: The ID of the Traffic Mirror session.
Main.Ec2.describe_traffic_mirror_targets
— Methoddescribe_traffic_mirror_targets()
describe_traffic_mirror_targets(params::Dict{String,<:Any})
Information about one or more Traffic Mirror targets.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: description: The Traffic Mirror target description. network-interface-id: The ID of the Traffic Mirror session network interface. network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session. owner-id: The ID of the account that owns the Traffic Mirror session. traffic-mirror-target-id: The ID of the Traffic Mirror target."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TrafficMirrorTargetId"
: The ID of the Traffic Mirror targets.
Main.Ec2.describe_transit_gateway_attachments
— Methoddescribe_transit_gateway_attachments()
describe_transit_gateway_attachments(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: association.state - The state of the association (associating | associated | disassociating). association.transit-gateway-route-table-id - The ID of the route table for the transit gateway. resource-id - The ID of the resource. resource-owner-id - The ID of the AWS account that owns the resource. resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect. state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting. transit-gateway-attachment-id - The ID of the attachment. transit-gateway-id - The ID of the transit gateway. transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayAttachmentIds"
: The IDs of the attachments.
Main.Ec2.describe_transit_gateway_connect_peers
— Methoddescribe_transit_gateway_connect_peers()
describe_transit_gateway_connect_peers(params::Dict{String,<:Any})
Describes one or more Connect peers.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: state - The state of the Connect peer (pending | available | deleting | deleted). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-connect-peer-id - The ID of the Connect peer."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayConnectPeerIds"
: The IDs of the Connect peers.
Main.Ec2.describe_transit_gateway_connects
— Methoddescribe_transit_gateway_connects()
describe_transit_gateway_connects(params::Dict{String,<:Any})
Describes one or more Connect attachments.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: options.protocol - The tunnel protocol (gre). state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing). transit-gateway-attachment-id - The ID of the Connect attachment. transit-gateway-id - The ID of the transit gateway. transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayAttachmentIds"
: The IDs of the attachments.
Main.Ec2.describe_transit_gateway_multicast_domains
— Methoddescribe_transit_gateway_multicast_domains()
describe_transit_gateway_multicast_domains(params::Dict{String,<:Any})
Describes one or more transit gateway multicast domains.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted. transit-gateway-id - The ID of the transit gateway. transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayMulticastDomainIds"
: The ID of the transit gateway multicast domain.
Main.Ec2.describe_transit_gateway_peering_attachments
— Methoddescribe_transit_gateway_peering_attachments()
describe_transit_gateway_peering_attachments(params::Dict{String,<:Any})
Describes your transit gateway peering attachments.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: transit-gateway-attachment-id - The ID of the transit gateway attachment. local-owner-id- The ID of your AWS account. remote-owner-id - The ID of the AWS account in the remote
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayAttachmentIds"
: One or more IDs of the transit gateway peering attachments.
Main.Ec2.describe_transit_gateway_route_tables
— Methoddescribe_transit_gateway_route_tables()
describe_transit_gateway_route_tables(params::Dict{String,<:Any})
Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false). default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false). state - The state of the route table (available | deleting | deleted | pending). transit-gateway-id - The ID of the transit gateway. transit-gateway-route-table-id - The ID of the transit gateway route table."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayRouteTableIds"
: The IDs of the transit gateway route tables.
Main.Ec2.describe_transit_gateway_vpc_attachments
— Methoddescribe_transit_gateway_vpc_attachments()
describe_transit_gateway_vpc_attachments(params::Dict{String,<:Any})
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting. transit-gateway-attachment-id - The ID of the attachment. transit-gateway-id - The ID of the transit gateway. vpc-id - The ID of the VPC."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayAttachmentIds"
: The IDs of the attachments.
Main.Ec2.describe_transit_gateways
— Methoddescribe_transit_gateways()
describe_transit_gateways(params::Dict{String,<:Any})
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: options.propagation-default-route-table-id - The ID of the default propagation route table. options.amazon-side-asn - The private ASN for the Amazon side of a BGP session. options.association-default-route-table-id - The ID of the default association route table. options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable). options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable). options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable). options.dns-support - Indicates whether DNS support is enabled (enable | disable). options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable). owner-id - The ID of the AWS account that owns the transit gateway. state - The state of the transit gateway (available | deleted | deleting | modifying | pending). transit-gateway-id - The ID of the transit gateway."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayIds"
: The IDs of the transit gateways.
Main.Ec2.describe_volume_attribute
— Methoddescribe_volume_attribute(attribute, volume_id)
describe_volume_attribute(attribute, volume_id, params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide.
Arguments
attribute
: The attribute of the volume. This parameter is required.volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_volume_status
— Methoddescribe_volume_status()
describe_volume_status(params::Dict{String,<:Any})
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 Monitoring the status of your volumes in the Amazon Elastic Compute Cloud User Guide. Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data. Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency. Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. action.code - The action code for the event (for example, enable-volume-io). action.description - A description of the action. action.event-id- The event ID associated with the action. availability-zone - The Availability Zone of
"MaxResults"
: The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request."NextToken"
: The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return."VolumeId"
: The IDs of the volumes. Default: Describes all your volumes."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_volumes
— Methoddescribe_volumes()
describe_volumes(params::Dict{String,<:Any})
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. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results. For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: The filters. attachment.attach-time - The time stamp when the attachment initiated. attachment.delete-on-termination - Whether the volume is deleted on instance termination. attachment.device - The device name specified in the block device mapping (for example, /dev/sda1). attachment.instance-id - The ID of the instance the volume is attached to. attachment.status - The attachment state (attaching | attached | detaching). availability-zone - The Availability Zone in which the volume was created. create-time - The time stamp when the volume was created. encrypted - Indicates whether the volume is encrypted (true | false) multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false) fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false). size - The size of the volume, in GiB. snapshot-id - The snapshot from which the volume was created. status - The state of the volume (creating | available | in-use | deleting | deleted | error). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. volume-id - The volume ID. volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)"VolumeId"
: The volume IDs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."maxResults"
: The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request."nextToken"
: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
Main.Ec2.describe_volumes_modifications
— Methoddescribe_volumes_modifications()
describe_volumes_modifications(params::Dict{String,<:Any})
Describes the most recent volume modification request for the specified EBS volumes. If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request. You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring volume modifications in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. modification-state - The current modification state (modifying | optimizing | completed | failed). original-iops - The original IOPS rate of the volume. original-size - The original size of the volume, in GiB. original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false). start-time - The modification start time. target-iops - The target IOPS rate of the volume. target-size - The target size of the volume, in GiB. target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1). targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false). volume-id - The ID of the volume."MaxResults"
: The maximum number of results (up to a limit of 500) to be returned in a paginated request."NextToken"
: The nextToken value returned by a previous paginated request."VolumeId"
: The IDs of the volumes.
Main.Ec2.describe_vpc_attribute
— Methoddescribe_vpc_attribute(attribute, vpc_id)
describe_vpc_attribute(attribute, vpc_id, params::Dict{String,<:Any})
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
Arguments
attribute
: The VPC attribute.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_vpc_classic_link
— Methoddescribe_vpc_classic_link()
describe_vpc_classic_link(params::Dict{String,<:Any})
Describes the ClassicLink status of one or more VPCs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."VpcId"
: One or more VPCs for which you want to describe the ClassicLink status."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_vpc_classic_link_dns_support
— Methoddescribe_vpc_classic_link_dns_support()
describe_vpc_classic_link_dns_support(params::Dict{String,<:Any})
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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"VpcIds"
: One or more VPC IDs."maxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."nextToken"
: The token for the next page of results.
Main.Ec2.describe_vpc_endpoint_connection_notifications
— Methoddescribe_vpc_endpoint_connection_notifications()
describe_vpc_endpoint_connection_notifications(params::Dict{String,<:Any})
Describes the connection notifications for VPC endpoints and VPC endpoint services.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ConnectionNotificationId"
: The ID of the notification."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. connection-notification-arn - The ARN of the SNS topic for the notification. connection-notification-id - The ID of the notification. connection-notification-state - The state of the notification (Enabled | Disabled). connection-notification-type - The type of notification (Topic). service-id - The ID of the endpoint service. vpc-endpoint-id - The ID of the VPC endpoint."MaxResults"
: The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value."NextToken"
: The token to request the next page of results.
Main.Ec2.describe_vpc_endpoint_connections
— Methoddescribe_vpc_endpoint_connections()
describe_vpc_endpoint_connections(params::Dict{String,<:Any})
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. service-id - The ID of the service. vpc-endpoint-owner - The AWS account number of the owner of the endpoint. vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed). vpc-endpoint-id - The ID of the endpoint."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_vpc_endpoint_service_configurations
— Methoddescribe_vpc_endpoint_service_configurations()
describe_vpc_endpoint_service_configurations(params::Dict{String,<:Any})
Describes the VPC endpoint service configurations in your account (your services).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. service-name - The name of the service. service-id- The ID of the service. service-state - The state of the service (Pending | Available |
"MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned."NextToken"
: The token to retrieve the next page of results."ServiceId"
: The IDs of one or more services.
Main.Ec2.describe_vpc_endpoint_service_permissions
— Methoddescribe_vpc_endpoint_service_permissions(service_id)
describe_vpc_endpoint_service_permissions(service_id, params::Dict{String,<:Any})
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
Arguments
service_id
: The ID of the service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. principal - The ARN of the principal. principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role)."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned."NextToken"
: The token to retrieve the next page of results.
Main.Ec2.describe_vpc_endpoint_services
— Methoddescribe_vpc_endpoint_services()
describe_vpc_endpoint_services(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. service-name - The name of the service. service-type - The type of service (Interface | Gateway). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1,000, we return only 1,000 items."NextToken"
: The token for the next set of items to return. (You received this token from a prior call.)"ServiceName"
: One or more service names.
Main.Ec2.describe_vpc_endpoints
— Methoddescribe_vpc_endpoints()
describe_vpc_endpoints(params::Dict{String,<:Any})
Describes one or more of your VPC endpoints.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. service-name - The name of the service. vpc-id - The ID of the VPC in which the endpoint resides. vpc-endpoint-id - The ID of the endpoint. vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed). vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value."MaxResults"
: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1,000, we return only 1,000 items."NextToken"
: The token for the next set of items to return. (You received this token from a prior call.)"VpcEndpointId"
: One or more endpoint IDs.
Main.Ec2.describe_vpc_peering_connections
— Methoddescribe_vpc_peering_connections()
describe_vpc_peering_connections(params::Dict{String,<:Any})
Describes one or more of your VPC peering connections.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC. accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC. accepter-vpc-info.vpc-id - The ID of the accepter VPC. expiration-time- The expiration date and time for the VPC peering connection.
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."VpcPeeringConnectionId"
: One or more VPC peering connection IDs. Default: Describes all your VPC peering connections."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_vpcs
— Methoddescribe_vpcs()
describe_vpcs(params::Dict{String,<:Any})
Describes one or more of your VPCs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28). cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC. cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC. cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC. dhcp-options-id - The ID of a set of DHCP options. ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC. ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC. ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC. isDefault - Indicates whether the VPC is the default VPC. owner-id - The ID of the AWS account that owns the VPC. state - The state of the VPC (pending | available). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."VpcId"
: One or more VPC IDs. Default: Describes all your VPCs."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_vpn_connections
— Methoddescribe_vpn_connections()
describe_vpn_connections(params::Dict{String,<:Any})
Describes one or more of your VPN connections. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. state - The state of the VPN connection (pending | available | deleting | deleted). option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center. bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device. tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type- The type of VPN connection. Currently the only supported type is ipsec.1.
"VpnConnectionId"
: One or more VPN connection IDs. Default: Describes your VPN connections."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.describe_vpn_gateways
— Methoddescribe_vpn_gateways()
describe_vpn_gateways(params::Dict{String,<:Any})
Describes one or more of your virtual private gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Filter"
: One or more filters. amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway. attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached). attachment.vpc-id - The ID of an attached VPC. availability-zone - The Availability Zone for the virtual private gateway (if applicable). state - The state of the virtual private gateway (pending | available | deleting | deleted). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. type - The type of virtual private gateway. Currently the only supported type is ipsec.1. vpn-gateway-id - The ID of the virtual private gateway."VpnGatewayId"
: One or more virtual private gateway IDs. Default: Describes all your virtual private gateways."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.detach_classic_link_vpc
— Methoddetach_classic_link_vpc(instance_id, vpc_id)
detach_classic_link_vpc(instance_id, vpc_id, params::Dict{String,<:Any})
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.
Arguments
instance_id
: The ID of the instance to unlink from the VPC.vpc_id
: The ID of the VPC to which the instance is linked.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.detach_internet_gateway
— Methoddetach_internet_gateway(internet_gateway_id, vpc_id)
detach_internet_gateway(internet_gateway_id, vpc_id, params::Dict{String,<:Any})
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.
Arguments
internet_gateway_id
: The ID of the internet gateway.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.detach_network_interface
— Methoddetach_network_interface(attachment_id)
detach_network_interface(attachment_id, params::Dict{String,<:Any})
Detaches a network interface from an instance.
Arguments
attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."force"
: Specifies whether to force a detachment. Use the Force parameter only as a last resort to detach a network interface from a failed instance. If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance. If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
Main.Ec2.detach_volume
— Methoddetach_volume(volume_id)
detach_volume(volume_id, params::Dict{String,<:Any})
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 AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. For more information, see Detaching an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
Arguments
volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Device"
: The device name."Force"
: Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures."InstanceId"
: The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.detach_vpn_gateway
— Methoddetach_vpn_gateway(vpc_id, vpn_gateway_id)
detach_vpn_gateway(vpc_id, vpn_gateway_id, params::Dict{String,<:Any})
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.
Arguments
vpc_id
: The ID of the VPC.vpn_gateway_id
: The ID of the virtual private gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_ebs_encryption_by_default
— Methoddisable_ebs_encryption_by_default()
disable_ebs_encryption_by_default(params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_fast_snapshot_restores
— Methoddisable_fast_snapshot_restores(availability_zone, source_snapshot_id)
disable_fast_snapshot_restores(availability_zone, source_snapshot_id, params::Dict{String,<:Any})
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
Arguments
availability_zone
: One or more Availability Zones. For example, us-east-2a.source_snapshot_id
: The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_serial_console_access
— Methoddisable_serial_console_access()
disable_serial_console_access(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_transit_gateway_route_table_propagation
— Methoddisable_transit_gateway_route_table_propagation(transit_gateway_attachment_id, transit_gateway_route_table_id)
disable_transit_gateway_route_table_propagation(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Disables the specified resource attachment from propagating routes to the specified propagation route table.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.transit_gateway_route_table_id
: The ID of the propagation route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_vgw_route_propagation
— Methoddisable_vgw_route_propagation(gateway_id, route_table_id)
disable_vgw_route_propagation(gateway_id, route_table_id, params::Dict{String,<:Any})
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
Arguments
gateway_id
: The ID of the virtual private gateway.route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_vpc_classic_link
— Methoddisable_vpc_classic_link(vpc_id)
disable_vpc_classic_link(vpc_id, params::Dict{String,<:Any})
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disable_vpc_classic_link_dns_support
— Methoddisable_vpc_classic_link_dns_support()
disable_vpc_classic_link_dns_support(params::Dict{String,<:Any})
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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"VpcId"
: The ID of the VPC.
Main.Ec2.disassociate_address
— Methoddisassociate_address()
disassociate_address(params::Dict{String,<:Any})
Disassociates an Elastic IP address from the instance or network interface it's associated with. An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AssociationId"
: [EC2-VPC] The association ID. Required for EC2-VPC."PublicIp"
: [EC2-Classic] The Elastic IP address. Required for EC2-Classic."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disassociate_client_vpn_target_network
— Methoddisassociate_client_vpn_target_network(association_id, client_vpn_endpoint_id)
disassociate_client_vpn_target_network(association_id, client_vpn_endpoint_id, params::Dict{String,<:Any})
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
Arguments
association_id
: The ID of the target network association.client_vpn_endpoint_id
: The ID of the Client VPN endpoint from which to disassociate the target network.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disassociate_enclave_certificate_iam_role
— Methoddisassociate_enclave_certificate_iam_role()
disassociate_enclave_certificate_iam_role(params::Dict{String,<:Any})
Disassociates an IAM role from an AWS 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 AWS Key Management Service (KMS) customer master key (CMK) used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CertificateArn"
: The ARN of the ACM certificate from which to disassociate the IAM role."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RoleArn"
: The ARN of the IAM role to disassociate.
Main.Ec2.disassociate_iam_instance_profile
— Methoddisassociate_iam_instance_profile(association_id)
disassociate_iam_instance_profile(association_id, params::Dict{String,<:Any})
Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.
Arguments
association_id
: The ID of the IAM instance profile association.
Main.Ec2.disassociate_route_table
— Methoddisassociate_route_table(association_id)
disassociate_route_table(association_id, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide.
Arguments
association_id
: The association ID representing the current association between the route table and subnet or gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disassociate_subnet_cidr_block
— Methoddisassociate_subnet_cidr_block(association_id)
disassociate_subnet_cidr_block(association_id, params::Dict{String,<:Any})
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.
Arguments
association_id
: The association ID for the CIDR block.
Main.Ec2.disassociate_transit_gateway_multicast_domain
— Methoddisassociate_transit_gateway_multicast_domain()
disassociate_transit_gateway_multicast_domain(params::Dict{String,<:Any})
Disassociates the specified subnets from the transit gateway multicast domain.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SubnetIds"
: The IDs of the subnets;"TransitGatewayAttachmentId"
: The ID of the attachment."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.disassociate_transit_gateway_route_table
— Methoddisassociate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id)
disassociate_transit_gateway_route_table(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Disassociates a resource attachment from a transit gateway route table.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.disassociate_vpc_cidr_block
— Methoddisassociate_vpc_cidr_block(association_id)
disassociate_vpc_cidr_block(association_id, params::Dict{String,<:Any})
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).
Arguments
association_id
: The association ID for the CIDR block.
Main.Ec2.enable_ebs_encryption_by_default
— Methodenable_ebs_encryption_by_default()
enable_ebs_encryption_by_default(params::Dict{String,<:Any})
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 CMK or the CMK that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide. You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. Enabling encryption by default has no effect on the encryption status of your existing volumes. After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_fast_snapshot_restores
— Methodenable_fast_snapshot_restores(availability_zone, source_snapshot_id)
enable_fast_snapshot_restores(availability_zone, source_snapshot_id, params::Dict{String,<:Any})
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones. You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores. For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.
Arguments
availability_zone
: One or more Availability Zones. For example, us-east-2a.source_snapshot_id
: The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another AWS account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_serial_console_access
— Methodenable_serial_console_access()
enable_serial_console_access(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_transit_gateway_route_table_propagation
— Methodenable_transit_gateway_route_table_propagation(transit_gateway_attachment_id, transit_gateway_route_table_id)
enable_transit_gateway_route_table_propagation(transit_gateway_attachment_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Enables the specified attachment to propagate routes to the specified propagation route table.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.transit_gateway_route_table_id
: The ID of the propagation route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_vgw_route_propagation
— Methodenable_vgw_route_propagation(gateway_id, route_table_id)
enable_vgw_route_propagation(gateway_id, route_table_id, params::Dict{String,<:Any})
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
Arguments
gateway_id
: The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.route_table_id
: The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_volume_io
— Methodenable_volume_io(volume_id)
enable_volume_io(volume_id, params::Dict{String,<:Any})
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
Arguments
volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_vpc_classic_link
— Methodenable_vpc_classic_link(vpc_id)
enable_vpc_classic_link(vpc_id, params::Dict{String,<:Any})
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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.enable_vpc_classic_link_dns_support
— Methodenable_vpc_classic_link_dns_support()
enable_vpc_classic_link_dns_support(params::Dict{String,<:Any})
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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide. You must specify a VPC ID in the request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"VpcId"
: The ID of the VPC.
Main.Ec2.export_client_vpn_client_certificate_revocation_list
— Methodexport_client_vpn_client_certificate_revocation_list(client_vpn_endpoint_id)
export_client_vpn_client_certificate_revocation_list(client_vpn_endpoint_id, params::Dict{String,<:Any})
Downloads the client certificate revocation list for the specified Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.export_client_vpn_client_configuration
— Methodexport_client_vpn_client_configuration(client_vpn_endpoint_id)
export_client_vpn_client_configuration(client_vpn_endpoint_id, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.export_image
— Methodexport_image(disk_image_format, image_id, s3_export_location)
export_image(disk_image_format, image_id, s3_export_location, params::Dict{String,<:Any})
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.
Arguments
disk_image_format
: The disk image format.image_id
: The ID of the image.s3_export_location
: Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Token to enable idempotency for export image requests."Description"
: A description of the image being exported. The maximum length is 255 characters."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RoleName"
: The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'."TagSpecification"
: The tags to apply to the export image task during creation.
Main.Ec2.export_transit_gateway_routes
— Methodexport_transit_gateway_routes(s3_bucket, transit_gateway_route_table_id)
export_transit_gateway_routes(s3_bucket, transit_gateway_route_table_id, params::Dict{String,<:Any})
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 Transit Gateways.
Arguments
s3_bucket
: The name of the S3 bucket.transit_gateway_route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: attachment.transit-gateway-attachment-id - The id of the transit gateway attachment. attachment.resource-id - The resource id of the transit gateway attachment. route-search.exact-match - The exact match of the specified filter. route-search.longest-prefix-match - The longest prefix that matches the route. route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state- The state of the route (active | blackhole).
Main.Ec2.get_associated_enclave_certificate_iam_roles
— Methodget_associated_enclave_certificate_iam_roles()
get_associated_enclave_certificate_iam_roles(params::Dict{String,<:Any})
Returns the IAM roles that are associated with the specified AWS Certificate Manager (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 AWS Key Management Service (KMS) customer master key (CMK) that's used to encrypt the private key.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CertificateArn"
: The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_associated_ipv6_pool_cidrs
— Methodget_associated_ipv6_pool_cidrs(pool_id)
get_associated_ipv6_pool_cidrs(pool_id, params::Dict{String,<:Any})
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
Arguments
pool_id
: The ID of the IPv6 address pool.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_capacity_reservation_usage
— Methodget_capacity_reservation_usage(capacity_reservation_id)
get_capacity_reservation_usage(capacity_reservation_id, params::Dict{String,<:Any})
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
Arguments
capacity_reservation_id
: The ID of the Capacity Reservation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error. Valid range: Minimum value of 1. Maximum value of 1000."NextToken"
: The token to use to retrieve the next page of results.
Main.Ec2.get_coip_pool_usage
— Methodget_coip_pool_usage(pool_id)
get_coip_pool_usage(pool_id, params::Dict{String,<:Any})
Describes the allocations from the specified customer-owned address pool.
Arguments
pool_id
: The ID of the address pool.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: The filters. The following are the possible values: coip-address-usage.allocation-id coip-address-usage.aws-account-id coip-address-usage.aws-service coip-address-usage.co-ip"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_console_output
— Methodget_console_output(instance_id)
get_console_output(instance_id, params::Dict{String,<:Any})
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available. You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor. For more information, see Instance console output in the Amazon EC2 User Guide.
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Latest"
: When enabled, retrieves the latest console output for the instance. Default: disabled (false)"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_console_screenshot
— Methodget_console_screenshot(instance_id)
get_console_screenshot(instance_id, params::Dict{String,<:Any})
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."WakeUp"
: When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.
Main.Ec2.get_default_credit_specification
— Methodget_default_credit_specification(instance_family)
get_default_credit_specification(instance_family, params::Dict{String,<:Any})
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.
Arguments
instance_family
: The instance family.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_ebs_default_kms_key_id
— Methodget_ebs_default_kms_key_id()
get_ebs_default_kms_key_id(params::Dict{String,<:Any})
Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region. You can change the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_ebs_encryption_by_default
— Methodget_ebs_encryption_by_default()
get_ebs_encryption_by_default(params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_flow_logs_integration_template
— Methodget_flow_logs_integration_template(config_delivery_s3_destination_arn, flow_log_id, integrate_service)
get_flow_logs_integration_template(config_delivery_s3_destination_arn, flow_log_id, integrate_service, params::Dict{String,<:Any})
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
Arguments
config_delivery_s3_destination_arn
: To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.flow_log_id
: The ID of the flow log.integrate_service
: Information about the service integration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_groups_for_capacity_reservation
— Methodget_groups_for_capacity_reservation(capacity_reservation_id)
get_groups_for_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Lists the resource groups to which a Capacity Reservation has been added.
Arguments
capacity_reservation_id
: The ID of the Capacity Reservation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error."NextToken"
: The token to use to retrieve the next page of results.
Main.Ec2.get_host_reservation_purchase_preview
— Methodget_host_reservation_purchase_preview(offering_id, item)
get_host_reservation_purchase_preview(offering_id, item, params::Dict{String,<:Any})
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.
Arguments
offering_id
: The offering ID of the reservation.item
: The IDs of the Dedicated Hosts with which the reservation is associated.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"HostIdSet"
: The IDs of the Dedicated Hosts with which the reservation is associated.
Main.Ec2.get_launch_template_data
— Methodget_launch_template_data(instance_id)
get_launch_template_data(instance_id, params::Dict{String,<:Any})
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, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_managed_prefix_list_associations
— Methodget_managed_prefix_list_associations(prefix_list_id)
get_managed_prefix_list_associations(prefix_list_id, params::Dict{String,<:Any})
Gets information about the resources that are associated with the specified managed prefix list.
Arguments
prefix_list_id
: The ID of the prefix list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_managed_prefix_list_entries
— Methodget_managed_prefix_list_entries(prefix_list_id)
get_managed_prefix_list_entries(prefix_list_id, params::Dict{String,<:Any})
Gets information about the entries for a specified managed prefix list.
Arguments
prefix_list_id
: The ID of the prefix list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TargetVersion"
: The version of the prefix list for which to return the entries. The default is the current version.
Main.Ec2.get_password_data
— Methodget_password_data(instance_id)
get_password_data(instance_id, params::Dict{String,<:Any})
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.
Arguments
instance_id
: The ID of the Windows instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_reserved_instances_exchange_quote
— Methodget_reserved_instances_exchange_quote(reserved_instance_id)
get_reserved_instances_exchange_quote(reserved_instance_id, params::Dict{String,<:Any})
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.
Arguments
reserved_instance_id
: The IDs of the Convertible Reserved Instances to exchange.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TargetConfiguration"
: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
Main.Ec2.get_serial_console_access_status
— Methodget_serial_console_access_status()
get_serial_console_access_status(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.get_transit_gateway_attachment_propagations
— Methodget_transit_gateway_attachment_propagations(transit_gateway_attachment_id)
get_transit_gateway_attachment_propagations(transit_gateway_attachment_id, params::Dict{String,<:Any})
Lists the route tables to which the specified resource attachment propagates routes.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: transit-gateway-route-table-id - The ID of the transit gateway route table."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_transit_gateway_multicast_domain_associations
— Methodget_transit_gateway_multicast_domain_associations()
get_transit_gateway_multicast_domain_associations(params::Dict{String,<:Any})
Gets information about the associations for the transit gateway multicast domain.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The type of resource. The valid value is: vpc. state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating. subnet-id - The ID of the subnet. transit-gateway-attachment-id - The id of the transit gateway attachment."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.get_transit_gateway_prefix_list_references
— Methodget_transit_gateway_prefix_list_references(transit_gateway_route_table_id)
get_transit_gateway_prefix_list_references(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the prefix list references in a specified transit gateway route table.
Arguments
transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: attachment.resource-id - The ID of the resource for the attachment. attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering. attachment.transit-gateway-attachment-id - The ID of the attachment. is-blackhole - Whether traffic matching the route is blocked (true | false). prefix-list-id - The ID of the prefix list. prefix-list-owner-id - The ID of the owner of the prefix list. state- The state of the prefix list reference (pending | available | modifying | deleting).
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_transit_gateway_route_table_associations
— Methodget_transit_gateway_route_table_associations(transit_gateway_route_table_id)
get_transit_gateway_route_table_associations(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the associations for the specified transit gateway route table.
Arguments
transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect. transit-gateway-attachment-id - The ID of the attachment."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.get_transit_gateway_route_table_propagations
— Methodget_transit_gateway_route_table_propagations(transit_gateway_route_table_id)
get_transit_gateway_route_table_propagations(transit_gateway_route_table_id, params::Dict{String,<:Any})
Gets information about the route table propagations for the specified transit gateway route table.
Arguments
transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: resource-id - The ID of the resource. resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect. transit-gateway-attachment-id - The ID of the attachment."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.import_client_vpn_client_certificate_revocation_list
— Methodimport_client_vpn_client_certificate_revocation_list(certificate_revocation_list, client_vpn_endpoint_id)
import_client_vpn_client_certificate_revocation_list(certificate_revocation_list, client_vpn_endpoint_id, params::Dict{String,<:Any})
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.
Arguments
certificate_revocation_list
: The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide.client_vpn_endpoint_id
: The ID of the Client VPN endpoint to which the client certificate revocation list applies.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.import_image
— Methodimport_image()
import_image(params::Dict{String,<:Any})
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Architecture"
: The architecture of the virtual machine. Valid values: i386 | x86_64 | arm64"ClientData"
: The client-specific data."ClientToken"
: The token to enable idempotency for VM import requests."Description"
: A description string for the import image task."DiskContainer"
: Information about the disk containers."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Encrypted"
: Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide."Hypervisor"
: The target hypervisor platform. Valid values: xen"KmsKeyId"
: An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the Region that the AMI is being copied to. Amazon EBS does not support asymmetric CMKs."LicenseSpecifications"
: The ARNs of the license configurations."LicenseType"
: The license type to be used for the Amazon Machine Image (AMI) after importing. By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate. To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide."Platform"
: The operating system of the virtual machine. Valid values: Windows | Linux"RoleName"
: The name of the role to use when not using the default role, 'vmimport'."TagSpecification"
: The tags to apply to the import image task during creation.
Main.Ec2.import_instance
— Methodimport_instance(platform)
import_instance(platform, params::Dict{String,<:Any})
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. This API action is not supported by the AWS Command Line Interface (AWS CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file. For information about the import manifest referenced by this API action, see VM Import Manifest.
Arguments
platform
: The instance operating system.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description for the instance being imported."diskImage"
: The disk image."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."launchSpecification"
: The launch specification.
Main.Ec2.import_key_pair
— Methodimport_key_pair(key_name, public_key_material)
import_key_pair(key_name, public_key_material, params::Dict{String,<:Any})
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
Arguments
key_name
: A unique name for the key pair.public_key_material
: The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"TagSpecification"
: The tags to apply to the imported key pair."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.import_snapshot
— Methodimport_snapshot()
import_snapshot(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientData"
: The client-specific data."ClientToken"
: Token to enable idempotency for VM import requests."Description"
: The description string for the import snapshot task."DiskContainer"
: Information about the disk container."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Encrypted"
: Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide."KmsKeyId"
: An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set. The CMK identifier may be provided in any of the following formats: Key ID Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified CMK must exist in the Region that the snapshot is being copied to. Amazon EBS does not support asymmetric CMKs."RoleName"
: The name of the role to use when not using the default role, 'vmimport'."TagSpecification"
: The tags to apply to the import snapshot task during creation.
Main.Ec2.import_volume
— Methodimport_volume(availability_zone, image, volume)
import_volume(availability_zone, image, volume, params::Dict{String,<:Any})
Creates an import volume task using metadata from the specified disk image. This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead. This API action is not supported by the AWS Command Line Interface (AWS CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file. For information about the import manifest referenced by this API action, see VM Import Manifest.
Arguments
availability_zone
: The Availability Zone for the resulting EBS volume.image
: The disk image.volume
: The volume size.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: A description of the volume."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_address_attribute
— Methodmodify_address_attribute(allocation_id)
modify_address_attribute(allocation_id, params::Dict{String,<:Any})
Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.
Arguments
allocation_id
: [EC2-VPC] The allocation ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DomainName"
: The domain name to modify for the IP address."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_availability_zone_group
— Methodmodify_availability_zone_group(group_name, opt_in_status)
modify_availability_zone_group(group_name, opt_in_status, params::Dict{String,<:Any})
Changes the opt-in status of the Local Zone and Wavelength Zone group for your account. Use DescribeAvailabilityZones to view the value for GroupName.
Arguments
group_name
: The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.opt_in_status
: Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is opted-in. You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_capacity_reservation
— Methodmodify_capacity_reservation(capacity_reservation_id)
modify_capacity_reservation(capacity_reservation_id, params::Dict{String,<:Any})
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.
Arguments
capacity_reservation_id
: The ID of the Capacity Reservation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Accept"
: Reserved. Capacity Reservations you have created are accepted by default."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."EndDate"
: The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited."EndDateType"
: Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited. limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited."InstanceCount"
: The number of instances for which to reserve capacity.
Main.Ec2.modify_client_vpn_endpoint
— Methodmodify_client_vpn_endpoint(client_vpn_endpoint_id)
modify_client_vpn_endpoint(client_vpn_endpoint_id, params::Dict{String,<:Any})
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint to modify.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientConnectOptions"
: The options for managing connection authorization for new client connections."ConnectionLogOptions"
: Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: Client connection requests Client connection results (successful and unsuccessful) Reasons for unsuccessful client connection requests Client connection termination time"Description"
: A brief description of the Client VPN endpoint."DnsServers"
: Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SecurityGroupId"
: The IDs of one or more security groups to apply to the target network."SelfServicePortal"
: Specify whether to enable the self-service portal for the Client VPN endpoint."ServerCertificateArn"
: The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM)."SplitTunnel"
: Indicates whether the VPN is split-tunnel. For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide."VpcId"
: The ID of the VPC to associate with the Client VPN endpoint."VpnPort"
: The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443
Main.Ec2.modify_default_credit_specification
— Methodmodify_default_credit_specification(cpu_credits, instance_family)
modify_default_credit_specification(cpu_credits, instance_family, params::Dict{String,<:Any})
Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS 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 AWS 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.
Arguments
cpu_credits
: The credit option for CPU usage of the instance family. Valid Values: standard | unlimitedinstance_family
: The instance family.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_ebs_default_kms_key_id
— Methodmodify_ebs_default_kms_key_id(kms_key_id)
modify_ebs_default_kms_key_id(kms_key_id, params::Dict{String,<:Any})
Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region. AWS creates a unique AWS managed CMK in each Region for use with encryption by default. If you change the default CMK to a symmetric customer managed CMK, it is used instead of the AWS managed CMK. To reset the default CMK to the AWS managed CMK for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric CMKs. If you delete or disable the customer managed CMK 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 Elastic Compute Cloud User Guide.
Arguments
kms_key_id
: The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true. You can specify the CMK using any of the following: Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Key alias. For example, alias/ExampleAlias. Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. Amazon EBS does not support asymmetric CMKs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_fleet
— Methodmodify_fleet(fleet_id)
modify_fleet(fleet_id, params::Dict{String,<:Any})
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.
Arguments
fleet_id
: The ID of the EC2 Fleet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ExcessCapacityTerminationPolicy"
: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet."LaunchTemplateConfig"
: The launch template and overrides."TargetCapacitySpecification"
: The size of the EC2 Fleet.
Main.Ec2.modify_fpga_image_attribute
— Methodmodify_fpga_image_attribute(fpga_image_id)
modify_fpga_image_attribute(fpga_image_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
Arguments
fpga_image_id
: The ID of the AFI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Attribute"
: The name of the attribute."Description"
: A description for the AFI."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LoadPermission"
: The load permission for the AFI."Name"
: A name for the AFI."OperationType"
: The operation type."ProductCode"
: The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute."UserGroup"
: The user groups. This parameter is valid only when modifying the loadPermission attribute."UserId"
: The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
Main.Ec2.modify_hosts
— Methodmodify_hosts(host_id)
modify_hosts(host_id, params::Dict{String,<:Any})
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.
Arguments
host_id
: The IDs of the Dedicated Hosts to modify.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"HostRecovery"
: Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide."InstanceFamily"
: Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family. If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request."InstanceType"
: Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type. If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request."autoPlacement"
: Specify whether to enable or disable auto-placement.
Main.Ec2.modify_id_format
— Methodmodify_id_format(resource, use_long_ids)
modify_id_format(resource, use_long_ids, params::Dict{String,<:Any})
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 AWS 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.
Arguments
resource
: The type of resource: 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. Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.use_long_ids
: Indicate whether the resource should use longer IDs (17-character IDs).
Main.Ec2.modify_identity_id_format
— Methodmodify_identity_id_format(principal_arn, resource, use_long_ids)
modify_identity_id_format(principal_arn, resource, use_long_ids, params::Dict{String,<:Any})
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.
Arguments
principal_arn
: The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.resource
: The type of resource: 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. Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.use_long_ids
: Indicates whether the resource should use longer IDs (17-character IDs)
Main.Ec2.modify_image_attribute
— Methodmodify_image_attribute(image_id)
modify_image_attribute(image_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode. AWS Marketplace product codes cannot be modified. Images with an AWS 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.
Arguments
image_id
: The ID of the AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Attribute"
: The name of the attribute to modify. The valid values are description, launchPermission, and productCodes."Description"
: A new description for the AMI."LaunchPermission"
: A new launch permission for the AMI."OperationType"
: The operation type. This parameter can be used only when the Attribute parameter is launchPermission."ProductCode"
: The DevPay product codes. After you add a product code to an AMI, it can't be removed."UserGroup"
: The user groups. This parameter can be used only when the Attribute parameter is launchPermission."UserId"
: The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission."Value"
: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_instance_attribute
— Methodmodify_instance_attribute(instance_id)
modify_instance_attribute(instance_id, params::Dict{String,<:Any})
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 in a VPC 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 Modifying attributes of a stopped instance in the Amazon EC2 User Guide.
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"GroupId"
: [EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name."SourceDestCheck"
: Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls."attribute"
: The name of the attribute."blockDeviceMapping"
: Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide."disableApiTermination"
: If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ebsOptimized"
: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance."enaSupport"
: Set to true to enable enhanced networking with ENA for the instance. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable."instanceInitiatedShutdownBehavior"
: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)."instanceType"
: Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue."kernel"
: Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB."ramdisk"
: Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB."sriovNetSupport"
: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance. There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable."userData"
: Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text."value"
: A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
Main.Ec2.modify_instance_capacity_reservation_attributes
— Methodmodify_instance_capacity_reservation_attributes(capacity_reservation_specification, instance_id)
modify_instance_capacity_reservation_attributes(capacity_reservation_specification, instance_id, params::Dict{String,<:Any})
Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
Arguments
capacity_reservation_specification
: Information about the Capacity Reservation targeting option.instance_id
: The ID of the instance to be modified.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_instance_credit_specification
— Methodmodify_instance_credit_specification(instance_credit_specification)
modify_instance_credit_specification(instance_credit_specification, params::Dict{String,<:Any})
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.
Arguments
instance_credit_specification
: Information about the credit option for CPU usage.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_instance_event_start_time
— Methodmodify_instance_event_start_time(instance_event_id, instance_id, not_before)
modify_instance_event_start_time(instance_event_id, instance_id, not_before, params::Dict{String,<:Any})
Modifies the start time for a scheduled Amazon EC2 instance event.
Arguments
instance_event_id
: The ID of the event whose date and time you are modifying.instance_id
: The ID of the instance with the scheduled event.not_before
: The new date and time when the event will take place.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_instance_metadata_options
— Methodmodify_instance_metadata_options(instance_id)
modify_instance_metadata_options(instance_id, params::Dict{String,<:Any})
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.
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."HttpEndpoint"
: This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the existing state is maintained. If you specify a value of disabled, you will not be able to access your instance metadata."HttpPutResponseHopLimit"
: The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained. Possible values: Integers from 1 to 64"HttpTokens"
: The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional. If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.
Main.Ec2.modify_instance_placement
— Methodmodify_instance_placement(instance_id)
modify_instance_placement(instance_id, params::Dict{String,<:Any})
Modifies the placement attributes for a specified instance. You can do the following: Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, 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 from host to dedicated, or from dedicated to host. 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.
Arguments
instance_id
: The ID of the instance that you are modifying.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"GroupName"
: The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated. To remove an instance from a placement group, specify an empty string ("")."HostResourceGroupArn"
: The ARN of the host resource group in which to place the instance."PartitionNumber"
: Reserved for future use."affinity"
: The affinity setting for the instance."hostId"
: The ID of the Dedicated Host with which to associate the instance."tenancy"
: The tenancy for the instance.
Main.Ec2.modify_launch_template
— Methodmodify_launch_template()
modify_launch_template(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. Constraint: Maximum 128 ASCII characters."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LaunchTemplateId"
: The ID of the launch template. You must specify either the launch template ID or launch template name in the request."LaunchTemplateName"
: The name of the launch template. You must specify either the launch template ID or launch template name in the request."SetDefaultVersion"
: The version number of the launch template to set as the default version.
Main.Ec2.modify_managed_prefix_list
— Methodmodify_managed_prefix_list(prefix_list_id)
modify_managed_prefix_list(prefix_list_id, params::Dict{String,<:Any})
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.
Arguments
prefix_list_id
: The ID of the prefix list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AddEntry"
: One or more entries to add to the prefix list."CurrentVersion"
: The current version of the prefix list."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PrefixListName"
: A name for the prefix list."RemoveEntry"
: One or more entries to remove from the prefix list.
Main.Ec2.modify_network_interface_attribute
— Methodmodify_network_interface_attribute(network_interface_id)
modify_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
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.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"SecurityGroupId"
: Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name."attachment"
: Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment."description"
: A description for the network interface."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."sourceDestCheck"
: Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Main.Ec2.modify_reserved_instances
— Methodmodify_reserved_instances(reserved_instances_configuration_set_item_type, reserved_instances_id)
modify_reserved_instances(reserved_instances_configuration_set_item_type, reserved_instances_id, params::Dict{String,<:Any})
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
Arguments
reserved_instances_configuration_set_item_type
: The configuration settings for the Reserved Instances to modify.reserved_instances_id
: The IDs of the Reserved Instances to modify.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"clientToken"
: A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
Main.Ec2.modify_snapshot_attribute
— Methodmodify_snapshot_attribute(snapshot_id)
modify_snapshot_attribute(snapshot_id, params::Dict{String,<:Any})
Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS 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 AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts. For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide.
Arguments
snapshot_id
: The ID of the snapshot.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Attribute"
: The snapshot attribute to modify. Only volume creation permissions can be modified."CreateVolumePermission"
: A JSON representation of the snapshot attribute modification."OperationType"
: The type of operation to perform to the attribute."UserGroup"
: The group to modify for the snapshot."UserId"
: The account ID to modify for the snapshot."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_spot_fleet_request
— Methodmodify_spot_fleet_request(spot_fleet_request_id)
modify_spot_fleet_request(spot_fleet_request_id, params::Dict{String,<:Any})
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.
Arguments
spot_fleet_request_id
: The ID of the Spot Fleet request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"LaunchTemplateConfig"
: The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter."OnDemandTargetCapacity"
: The number of On-Demand Instances in the fleet."excessCapacityTerminationPolicy"
: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet."targetCapacity"
: The size of the fleet.
Main.Ec2.modify_subnet_attribute
— Methodmodify_subnet_attribute(subnet_id)
modify_subnet_attribute(subnet_id, params::Dict{String,<:Any})
Modifies a subnet attribute. You can only modify one attribute at a time.
Arguments
subnet_id
: The ID of the subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AssignIpv6AddressOnCreation"
: Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address). If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API."CustomerOwnedIpv4Pool"
: The customer-owned IPv4 address pool associated with the subnet. You must set this value when you specify true for MapCustomerOwnedIpOnLaunch."MapCustomerOwnedIpOnLaunch"
: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address. When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool."MapPublicIpOnLaunch"
: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
Main.Ec2.modify_traffic_mirror_filter_network_services
— Methodmodify_traffic_mirror_filter_network_services(traffic_mirror_filter_id)
modify_traffic_mirror_filter_network_services(traffic_mirror_filter_id, params::Dict{String,<:Any})
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. For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .
Arguments
traffic_mirror_filter_id
: The ID of the Traffic Mirror filter.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AddNetworkService"
: The network service, for example Amazon DNS, that you want to mirror."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RemoveNetworkService"
: The network service, for example Amazon DNS, that you no longer want to mirror.
Main.Ec2.modify_traffic_mirror_filter_rule
— Methodmodify_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id)
modify_traffic_mirror_filter_rule(traffic_mirror_filter_rule_id, params::Dict{String,<:Any})
Modifies the specified Traffic Mirror rule. DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
Arguments
traffic_mirror_filter_rule_id
: The ID of the Traffic Mirror rule.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: The description to assign to the Traffic Mirror rule."DestinationCidrBlock"
: The destination CIDR block to assign to the Traffic Mirror rule."DestinationPortRange"
: The destination ports that are associated with the Traffic Mirror rule."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Protocol"
: The protocol, for example TCP, to assign to the Traffic Mirror rule."RemoveField"
: The properties that you want to remove from the Traffic Mirror filter rule. When you remove a property from a Traffic Mirror filter rule, the property is set to the default."RuleAction"
: The action to assign to the rule."RuleNumber"
: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number."SourceCidrBlock"
: The source CIDR block to assign to the Traffic Mirror rule."SourcePortRange"
: The port range to assign to the Traffic Mirror rule."TrafficDirection"
: The type of traffic (ingress | egress) to assign to the rule.
Main.Ec2.modify_traffic_mirror_session
— Methodmodify_traffic_mirror_session(traffic_mirror_session_id)
modify_traffic_mirror_session(traffic_mirror_session_id, params::Dict{String,<:Any})
Modifies a Traffic Mirror session.
Arguments
traffic_mirror_session_id
: The ID of the Traffic Mirror session.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: The description to assign to the Traffic Mirror session."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PacketLength"
: The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet."RemoveField"
: The properties that you want to remove from the Traffic Mirror session. When you remove a property from a Traffic Mirror session, the property is set to the default."SessionNumber"
: The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. Valid values are 1-32766."TrafficMirrorFilterId"
: The ID of the Traffic Mirror filter."TrafficMirrorTargetId"
: The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source."VirtualNetworkId"
: The virtual network ID of the Traffic Mirror session.
Main.Ec2.modify_transit_gateway
— Methodmodify_transit_gateway(transit_gateway_id)
modify_transit_gateway(transit_gateway_id, params::Dict{String,<:Any})
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.
Arguments
transit_gateway_id
: The ID of the transit gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Description"
: The description for the transit gateway."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Options"
: The options to modify.
Main.Ec2.modify_transit_gateway_prefix_list_reference
— Methodmodify_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id)
modify_transit_gateway_prefix_list_reference(prefix_list_id, transit_gateway_route_table_id, params::Dict{String,<:Any})
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
Arguments
prefix_list_id
: The ID of the prefix list.transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Blackhole"
: Indicates whether to drop traffic that matches this route."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TransitGatewayAttachmentId"
: The ID of the attachment to which traffic is routed.
Main.Ec2.modify_transit_gateway_vpc_attachment
— Methodmodify_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
modify_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Modifies the specified VPC attachment.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AddSubnetIds"
: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Options"
: The new VPC attachment options. You cannot modify the IPv6 options."RemoveSubnetIds"
: The IDs of one or more subnets to remove.
Main.Ec2.modify_volume
— Methodmodify_volume(volume_id)
modify_volume(volume_id, params::Dict{String,<:Any})
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 an EBS volume running Linux, see Modifying the size, IOPS, or type of an EBS volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the size, IOPS, or type of an EBS volume on Windows. 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 information about extending a Linux file system, see Extending a Linux file system. For information about extending a Windows file system, see Extending a Windows file system. You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitoring volume modifications. With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Amazon EBS Elastic Volumes (Linux) or Amazon EBS Elastic Volumes (Windows). If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.
Arguments
volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Iops"
: The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes. The following are the supported values for each volume type: gp3: 3,000-16,000 IOPS io1: 100-64,000 IOPS io2: 100-64,000 IOPS Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values."MultiAttachEnabled"
: Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide."Size"
: The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume. The following are the supported volumes sizes for each volume type: gp2 and gp3: 1-16,384 io1 and io2: 4-16,384 st1 and sc1: 125-16,384 standard: 1-1,024 Default: If no size is specified, the existing size is retained."Throughput"
: The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000. Default: If no throughput value is specified, the existing value is retained. Valid Range: Minimum value of 125. Maximum value of 1000."VolumeType"
: The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. Default: If no type is specified, the existing type is retained.
Main.Ec2.modify_volume_attribute
— Methodmodify_volume_attribute(volume_id)
modify_volume_attribute(volume_id, params::Dict{String,<:Any})
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.
Arguments
volume_id
: The ID of the volume.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AutoEnableIO"
: Indicates whether the volume should be auto-enabled for I/O operations."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_vpc_attribute
— Methodmodify_vpc_attribute(vpc_id)
modify_vpc_attribute(vpc_id, params::Dict{String,<:Any})
Modifies the specified attribute of the specified VPC.
Arguments
vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"EnableDnsHostnames"
: Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support."EnableDnsSupport"
: Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
Main.Ec2.modify_vpc_endpoint
— Methodmodify_vpc_endpoint(vpc_endpoint_id)
modify_vpc_endpoint(vpc_endpoint_id, params::Dict{String,<:Any})
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 VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
Arguments
vpc_endpoint_id
: The ID of the endpoint.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AddRouteTableId"
: (Gateway endpoint) One or more route tables IDs to associate with the endpoint."AddSecurityGroupId"
: (Interface endpoint) One or more security group IDs to associate with the network interface."AddSubnetId"
: (Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PolicyDocument"
: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format."PrivateDnsEnabled"
: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC."RemoveRouteTableId"
: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint."RemoveSecurityGroupId"
: (Interface endpoint) One or more security group IDs to disassociate from the network interface."RemoveSubnetId"
: (Interface endpoint) One or more subnets IDs in which to remove the endpoint."ResetPolicy"
: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
Main.Ec2.modify_vpc_endpoint_connection_notification
— Methodmodify_vpc_endpoint_connection_notification(connection_notification_id)
modify_vpc_endpoint_connection_notification(connection_notification_id, params::Dict{String,<:Any})
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.
Arguments
connection_notification_id
: The ID of the notification.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ConnectionEvents"
: One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject."ConnectionNotificationArn"
: The ARN for the SNS topic for the notification."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_vpc_endpoint_service_configuration
— Methodmodify_vpc_endpoint_service_configuration(service_id)
modify_vpc_endpoint_service_configuration(service_id, params::Dict{String,<:Any})
Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint. If you set or modify the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
Arguments
service_id
: The ID of the service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AcceptanceRequired"
: Indicates whether requests to create an endpoint to your service must be accepted."AddGatewayLoadBalancerArn"
: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration."AddNetworkLoadBalancerArn"
: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PrivateDnsName"
: (Interface endpoint configuration) The private DNS name to assign to the endpoint service."RemoveGatewayLoadBalancerArn"
: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration."RemoveNetworkLoadBalancerArn"
: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration."RemovePrivateDnsName"
: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
Main.Ec2.modify_vpc_endpoint_service_permissions
— Methodmodify_vpc_endpoint_service_permissions(service_id)
modify_vpc_endpoint_service_permissions(service_id, params::Dict{String,<:Any})
Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.
Arguments
service_id
: The ID of the service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AddAllowedPrincipals"
: The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*)."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RemoveAllowedPrincipals"
: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
Main.Ec2.modify_vpc_peering_connection_options
— Methodmodify_vpc_peering_connection_options(vpc_peering_connection_id)
modify_vpc_peering_connection_options(vpc_peering_connection_id, params::Dict{String,<:Any})
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following: Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC. Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC. Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. If the peered VPCs are in the same AWS 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 AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS 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.
Arguments
vpc_peering_connection_id
: The ID of the VPC peering connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccepterPeeringConnectionOptions"
: The VPC peering connection options for the accepter VPC."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RequesterPeeringConnectionOptions"
: The VPC peering connection options for the requester VPC.
Main.Ec2.modify_vpc_tenancy
— Methodmodify_vpc_tenancy(instance_tenancy, vpc_id)
modify_vpc_tenancy(instance_tenancy, vpc_id, params::Dict{String,<:Any})
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 Elastic Compute Cloud User Guide.
Arguments
instance_tenancy
: The instance tenancy attribute for the VPC.vpc_id
: The ID of the VPC.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_vpn_connection
— Methodmodify_vpn_connection(vpn_connection_id)
modify_vpn_connection(vpn_connection_id, params::Dict{String,<:Any})
Modifies the customer gateway or the target gateway of an AWS 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 VPN Gateway Target Modification Required VPC Route Table Updates in the AWS 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 AWS 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 AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.
Arguments
vpn_connection_id
: The ID of the VPN connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CustomerGatewayId"
: The ID of the customer gateway at your end of the VPN connection."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TransitGatewayId"
: The ID of the transit gateway."VpnGatewayId"
: The ID of the virtual private gateway at the AWS side of the VPN connection.
Main.Ec2.modify_vpn_connection_options
— Methodmodify_vpn_connection_options(vpn_connection_id)
modify_vpn_connection_options(vpn_connection_id, params::Dict{String,<:Any})
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 AWS 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.
Arguments
vpn_connection_id
: The ID of the Site-to-Site VPN connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."LocalIpv4NetworkCidr"
: The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: 0.0.0.0/0"LocalIpv6NetworkCidr"
: The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: ::/0"RemoteIpv4NetworkCidr"
: The IPv4 CIDR on the AWS side of the VPN connection. Default: 0.0.0.0/0"RemoteIpv6NetworkCidr"
: The IPv6 CIDR on the AWS side of the VPN connection. Default: ::/0
Main.Ec2.modify_vpn_tunnel_certificate
— Methodmodify_vpn_tunnel_certificate(vpn_connection_id, vpn_tunnel_outside_ip_address)
modify_vpn_tunnel_certificate(vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Modifies the VPN tunnel endpoint certificate.
Arguments
vpn_connection_id
: The ID of the AWS Site-to-Site VPN connection.vpn_tunnel_outside_ip_address
: The external IP address of the VPN tunnel.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.modify_vpn_tunnel_options
— Methodmodify_vpn_tunnel_options(tunnel_options, vpn_connection_id, vpn_tunnel_outside_ip_address)
modify_vpn_tunnel_options(tunnel_options, vpn_connection_id, vpn_tunnel_outside_ip_address, params::Dict{String,<:Any})
Modifies the options for a VPN tunnel in an AWS 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 AWS Site-to-Site VPN User Guide.
Arguments
tunnel_options
: The tunnel options to modify.vpn_connection_id
: The ID of the AWS Site-to-Site VPN connection.vpn_tunnel_outside_ip_address
: The external IP address of the VPN tunnel.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.monitor_instances
— Methodmonitor_instances(instance_id)
monitor_instances(instance_id, params::Dict{String,<:Any})
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide. To disable detailed monitoring, see .
Arguments
instance_id
: The IDs of the instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.move_address_to_vpc
— Methodmove_address_to_vpc(public_ip)
move_address_to_vpc(public_ip, params::Dict{String,<:Any})
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
Arguments
public_ip
: The Elastic IP address.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.provision_byoip_cidr
— Methodprovision_byoip_cidr(cidr)
provision_byoip_cidr(cidr, params::Dict{String,<:Any})
Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr. AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
Arguments
cidr
: The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've brought to this or another Region.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CidrAuthorizationContext"
: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP."Description"
: A description for the address range and the address pool."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."PoolTagSpecification"
: The tags to apply to the address pool."PubliclyAdvertisable"
: (IPv6 only) Indicate whether the address range will be publicly advertised to the internet. Default: true
Main.Ec2.purchase_host_reservation
— Methodpurchase_host_reservation(offering_id, item)
purchase_host_reservation(offering_id, item, params::Dict{String,<:Any})
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.
Arguments
offering_id
: The ID of the offering.item
: The IDs of the Dedicated Hosts with which the reservation will be associated.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency."CurrencyCode"
: The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD."HostIdSet"
: The IDs of the Dedicated Hosts with which the reservation will be associated."LimitPrice"
: The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00."TagSpecification"
: The tags to apply to the Dedicated Host Reservation during purchase.
Main.Ec2.purchase_reserved_instances_offering
— Methodpurchase_reserved_instances_offering(instance_count, reserved_instances_offering_id)
purchase_reserved_instances_offering(instance_count, reserved_instances_offering_id, params::Dict{String,<:Any})
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 Reserved Instance Marketplace in the Amazon EC2 User Guide.
Arguments
instance_count
: The number of Reserved Instances to purchase.reserved_instances_offering_id
: The ID of the Reserved Instance offering to purchase.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"PurchaseTime"
: The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."limitPrice"
: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
Main.Ec2.purchase_scheduled_instances
— Methodpurchase_scheduled_instances(purchase_request)
purchase_scheduled_instances(purchase_request, params::Dict{String,<:Any})
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.
Arguments
purchase_request
: The purchase requests.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reboot_instances
— Methodreboot_instances(instance_id)
reboot_instances(instance_id, params::Dict{String,<:Any})
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 Getting console output and rebooting instances in the Amazon EC2 User Guide.
Arguments
instance_id
: The instance IDs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.register_image
— Methodregister_image(name)
register_image(name, params::Dict{String,<:Any})
Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide. For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. Register a snapshot of a root device volume You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted. For more information, see Create a Linux AMI from a snapshot and Use encryption with EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide. AWS Marketplace product codes If any snapshots have AWS Marketplace product codes, they are copied to the new AMI. Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association: Launch an instance from an existing AMI with that billing product code. Customize the instance. Create an AMI from the instance using CreateImage. If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Obtaining billing information in the Amazon Elastic Compute Cloud User Guide.
Arguments
name
: A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"BillingProduct"
: The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI."BlockDeviceMapping"
: The block device mapping entries. If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume. If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide."BootMode"
: The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide."ImageLocation"
: The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide."architecture"
: The architecture of the AMI. Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file."description"
: A description for your AMI."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."enaSupport"
: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable."kernelId"
: The ID of the kernel."ramdiskId"
: The ID of the RAM disk."rootDeviceName"
: The device name of the root device volume (for example, /dev/sda1)."sriovNetSupport"
: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no way to disable sriovNetSupport at this time. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable."virtualizationType"
: The type of virtualization (hvm | paravirtual). Default: paravirtual
Main.Ec2.register_instance_event_notification_attributes
— Methodregister_instance_event_notification_attributes()
register_instance_event_notification_attributes(params::Dict{String,<:Any})
Registers a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use .
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."InstanceTagAttribute"
: Information about the tag keys to register.
Main.Ec2.register_transit_gateway_multicast_group_members
— Methodregister_transit_gateway_multicast_group_members()
register_transit_gateway_multicast_group_members(params::Dict{String,<:Any})
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 information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways. After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupIpAddress"
: The IP address assigned to the transit gateway multicast group."NetworkInterfaceIds"
: The group members' network interface IDs to register with the transit gateway multicast group."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.register_transit_gateway_multicast_group_sources
— Methodregister_transit_gateway_multicast_group_sources()
register_transit_gateway_multicast_group_sources(params::Dict{String,<:Any})
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 information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways. After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupIpAddress"
: The IP address assigned to the transit gateway multicast group."NetworkInterfaceIds"
: The group sources' network interface IDs to register with the transit gateway multicast group."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.reject_transit_gateway_multicast_domain_associations
— Methodreject_transit_gateway_multicast_domain_associations()
reject_transit_gateway_multicast_domain_associations(params::Dict{String,<:Any})
Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."SubnetIds"
: The IDs of the subnets to associate with the transit gateway multicast domain."TransitGatewayAttachmentId"
: The ID of the transit gateway attachment."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.reject_transit_gateway_peering_attachment
— Methodreject_transit_gateway_peering_attachment(transit_gateway_attachment_id)
reject_transit_gateway_peering_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
Rejects a transit gateway peering attachment request.
Arguments
transit_gateway_attachment_id
: The ID of the transit gateway peering attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reject_transit_gateway_vpc_attachment
— Methodreject_transit_gateway_vpc_attachment(transit_gateway_attachment_id)
reject_transit_gateway_vpc_attachment(transit_gateway_attachment_id, params::Dict{String,<:Any})
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.
Arguments
transit_gateway_attachment_id
: The ID of the attachment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reject_vpc_endpoint_connections
— Methodreject_vpc_endpoint_connections(service_id, vpc_endpoint_id)
reject_vpc_endpoint_connections(service_id, vpc_endpoint_id, params::Dict{String,<:Any})
Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
Arguments
service_id
: The ID of the service.vpc_endpoint_id
: The IDs of one or more VPC endpoints.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reject_vpc_peering_connection
— Methodreject_vpc_peering_connection(vpc_peering_connection_id)
reject_vpc_peering_connection(vpc_peering_connection_id, params::Dict{String,<:Any})
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.
Arguments
vpc_peering_connection_id
: The ID of the VPC peering connection.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.release_address
— Methodrelease_address()
release_address(params::Dict{String,<:Any})
Releases the specified Elastic IP address. [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress. [Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account. [EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AllocationId"
: [EC2-VPC] The allocation ID. Required for EC2-VPC."NetworkBorderGroup"
: The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error. For more information, see Error Codes. You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes."PublicIp"
: [EC2-Classic] The Elastic IP address. Required for EC2-Classic."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.release_hosts
— Methodrelease_hosts(host_id)
release_hosts(host_id, params::Dict{String,<:Any})
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.
Arguments
host_id
: The IDs of the Dedicated Hosts to release.
Main.Ec2.replace_iam_instance_profile_association
— Methodreplace_iam_instance_profile_association(association_id, iam_instance_profile)
replace_iam_instance_profile_association(association_id, iam_instance_profile, params::Dict{String,<:Any})
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.
Arguments
association_id
: The ID of the existing IAM instance profile association.iam_instance_profile
: The IAM instance profile.
Main.Ec2.replace_network_acl_association
— Methodreplace_network_acl_association(association_id, network_acl_id)
replace_network_acl_association(association_id, network_acl_id, params::Dict{String,<:Any})
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 Virtual Private Cloud User Guide. This is an idempotent operation.
Arguments
association_id
: The ID of the current association between the original network ACL and the subnet.network_acl_id
: The ID of the new network ACL to associate with the subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.replace_network_acl_entry
— Methodreplace_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number)
replace_network_acl_entry(egress, network_acl_id, protocol, rule_action, rule_number, params::Dict{String,<:Any})
Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
Arguments
egress
: Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule.network_acl_id
: The ID of the ACL.protocol
: The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.rule_action
: Indicates whether to allow or deny the traffic that matches the rule.rule_number
: The rule number of the entry to replace.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Icmp"
: ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block."cidrBlock"
: The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24)."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ipv6CidrBlock"
: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64)."portRange"
: TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
Main.Ec2.replace_route
— Methodreplace_route(route_table_id)
replace_route(route_table_id, params::Dict{String,<:Any})
Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway. For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
Arguments
route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CarrierGatewayId"
: [IPv4 traffic only] The ID of a carrier gateway."DestinationPrefixListId"
: The ID of the prefix list for the route."LocalGatewayId"
: The ID of the local gateway."LocalTarget"
: Specifies whether to reset the local route to its default target (local)."TransitGatewayId"
: The ID of a transit gateway."VpcEndpointId"
: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only."destinationCidrBlock"
: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table."destinationIpv6CidrBlock"
: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."egressOnlyInternetGatewayId"
: [IPv6 traffic only] The ID of an egress-only internet gateway."gatewayId"
: The ID of an internet gateway or virtual private gateway."instanceId"
: The ID of a NAT instance in your VPC."natGatewayId"
: [IPv4 traffic only] The ID of a NAT gateway."networkInterfaceId"
: The ID of a network interface."vpcPeeringConnectionId"
: The ID of a VPC peering connection.
Main.Ec2.replace_route_table_association
— Methodreplace_route_table_association(association_id, route_table_id)
replace_route_table_association(association_id, route_table_id, params::Dict{String,<:Any})
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 Virtual Private Cloud 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.
Arguments
association_id
: The association ID.route_table_id
: The ID of the new route table to associate with the subnet.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.replace_transit_gateway_route
— Methodreplace_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id)
replace_transit_gateway_route(destination_cidr_block, transit_gateway_route_table_id, params::Dict{String,<:Any})
Replaces the specified route in the specified transit gateway route table.
Arguments
destination_cidr_block
: The CIDR range used for the destination match. Routing decisions are based on the most specific match.transit_gateway_route_table_id
: The ID of the route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Blackhole"
: Indicates whether traffic matching this route is to be dropped."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."TransitGatewayAttachmentId"
: The ID of the attachment.
Main.Ec2.report_instance_status
— Methodreport_instance_status(instance_id, reason_code, status)
report_instance_status(instance_id, reason_code, status, params::Dict{String,<:Any})
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.
Arguments
instance_id
: The instances.reason_code
: The reason codes that describe the health state of your instance. instance-stuck-in-state: My instance is stuck in a state. unresponsive: My instance is unresponsive. not-accepting-credentials: My instance is not accepting my credentials. password-not-available: A password is not available for my instance. performance-network: My instance is experiencing performance problems that I believe are network related. performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores. performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume. performance-other: My instance is experiencing performance problems. other: [explain using the description parameter]status
: The status of all instances listed.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"description"
: Descriptive text about the health state of your instance."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."endTime"
: The time at which the reported instance health state ended."startTime"
: The time at which the reported instance health state began.
Main.Ec2.request_spot_fleet
— Methodrequest_spot_fleet(spot_fleet_request_config)
request_spot_fleet(spot_fleet_request_config, params::Dict{String,<:Any})
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 for Linux Instances.
Arguments
spot_fleet_request_config
: The configuration for the Spot Fleet request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.request_spot_instances
— Methodrequest_spot_instances()
request_spot_instances(params::Dict{String,<:Any})
Creates a Spot Instance request. For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"InstanceInterruptionBehavior"
: The behavior when a Spot Instance is interrupted. The default is terminate."LaunchSpecification"
: The launch specification."TagSpecification"
: The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags."availabilityZoneGroup"
: The user-specified name for a logical grouping of requests. When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active. If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group. Default: Instances are launched in any available Availability Zone."blockDurationMinutes"
: The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. You can't specify an Availability Zone group or a launch group if you specify a duration. New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks)."clientToken"
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."instanceCount"
: The maximum number of Spot Instances to launch. Default: 1"launchGroup"
: The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually"spotPrice"
: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price."type"
: The Spot Instance request type. Default: one-time"validFrom"
: The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled. The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time."validUntil"
: The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it. For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
Main.Ec2.reset_address_attribute
— Methodreset_address_attribute(allocation_id, attribute)
reset_address_attribute(allocation_id, attribute, params::Dict{String,<:Any})
Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.
Arguments
allocation_id
: [EC2-VPC] The allocation ID.attribute
: The attribute of the IP address.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reset_ebs_default_kms_key_id
— Methodreset_ebs_default_kms_key_id()
reset_ebs_default_kms_key_id(params::Dict{String,<:Any})
Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS. After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reset_fpga_image_attribute
— Methodreset_fpga_image_attribute(fpga_image_id)
reset_fpga_image_attribute(fpga_image_id, params::Dict{String,<:Any})
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
Arguments
fpga_image_id
: The ID of the AFI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Attribute"
: The attribute."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reset_image_attribute
— Methodreset_image_attribute(attribute, image_id)
reset_image_attribute(attribute, image_id, params::Dict{String,<:Any})
Resets an attribute of an AMI to its default value. The productCodes attribute can't be reset.
Arguments
attribute
: The attribute to reset (currently you can only reset the launch permission attribute).image_id
: The ID of the AMI.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reset_instance_attribute
— Methodreset_instance_attribute(attribute, instance_id)
reset_instance_attribute(attribute, instance_id, params::Dict{String,<:Any})
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.
Arguments
attribute
: The attribute to reset. You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.reset_network_interface_attribute
— Methodreset_network_interface_attribute(network_interface_id)
reset_network_interface_attribute(network_interface_id, params::Dict{String,<:Any})
Resets a network interface attribute. You can specify only one attribute at a time.
Arguments
network_interface_id
: The ID of the network interface.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."sourceDestCheck"
: The source/destination checking attribute. Resets the value to true.
Main.Ec2.reset_snapshot_attribute
— Methodreset_snapshot_attribute(attribute, snapshot_id)
reset_snapshot_attribute(attribute, snapshot_id, params::Dict{String,<:Any})
Resets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide.
Arguments
attribute
: The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.snapshot_id
: The ID of the snapshot.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.restore_address_to_classic
— Methodrestore_address_to_classic(public_ip)
restore_address_to_classic(public_ip, params::Dict{String,<:Any})
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.
Arguments
public_ip
: The Elastic IP address.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.restore_managed_prefix_list_version
— Methodrestore_managed_prefix_list_version(current_version, prefix_list_id, previous_version)
restore_managed_prefix_list_version(current_version, prefix_list_id, previous_version, params::Dict{String,<:Any})
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
Arguments
current_version
: The current version number for the prefix list.prefix_list_id
: The ID of the prefix list.previous_version
: The version to restore.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.revoke_client_vpn_ingress
— Methodrevoke_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr)
revoke_client_vpn_ingress(client_vpn_endpoint_id, target_network_cidr, params::Dict{String,<:Any})
Removes an ingress authorization rule from a Client VPN endpoint.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint with which the authorization rule is associated.target_network_cidr
: The IPv4 address range, in CIDR notation, of the network for which access is being removed.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"AccessGroupId"
: The ID of the Active Directory group for which to revoke access."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."RevokeAllGroups"
: Indicates whether access should be revoked for all clients.
Main.Ec2.revoke_security_group_egress
— Methodrevoke_security_group_egress(group_id)
revoke_security_group_egress(group_id, params::Dict{String,<:Any})
[VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. [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. AWS recommends that you use DescribeSecurityGroups to verify that the rule has been removed. Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. 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 have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
Arguments
group_id
: The ID of the security group.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"cidrIp"
: Not supported. Use a set of IP permissions to specify the CIDR."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."fromPort"
: Not supported. Use a set of IP permissions to specify the port."ipPermissions"
: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions."ipProtocol"
: Not supported. Use a set of IP permissions to specify the protocol name or number."sourceSecurityGroupName"
: Not supported. Use a set of IP permissions to specify a destination security group."sourceSecurityGroupOwnerId"
: Not supported. Use a set of IP permissions to specify a destination security group."toPort"
: Not supported. Use a set of IP permissions to specify the port.
Main.Ec2.revoke_security_group_ingress
— Methodrevoke_security_group_ingress()
revoke_security_group_ingress(params::Dict{String,<:Any})
Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly. [EC2-Classic , 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. AWS recommends that you use DescribeSecurityGroups to verify that the rule has been removed. Each rule consists of the protocol and the CIDR range or source security group. 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 have to specify the description to revoke the rule. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"CidrIp"
: The CIDR IP address range. You can't specify this parameter when specifying a source security group."FromPort"
: The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types."GroupId"
: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID."GroupName"
: [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request."IpPermissions"
: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions."IpProtocol"
: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all."SourceSecurityGroupName"
: [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."SourceSecurityGroupOwnerId"
: [EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."ToPort"
: The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.run_instances
— Methodrun_instances(max_count, min_count)
run_instances(max_count, min_count, params::Dict{String,<:Any})
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: [EC2-VPC] 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. [EC2-Classic] If don't specify an Availability Zone, we choose one for you. Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC. [EC2-VPC] 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 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. 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.
Arguments
max_count
: The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.min_count
: The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"BlockDeviceMapping"
: The block device mapping entries."CapacityReservationSpecification"
: Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone)."CpuOptions"
: The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide."CreditSpecification"
: The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide. Default: standard (T2 instances) or unlimited (T3/T3a instances)"ElasticGpuSpecification"
: An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide."ElasticInferenceAccelerator"
: An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads. You cannot specify accelerators from different generations in the same request."EnclaveOptions"
: Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide. You can't enable AWS Nitro Enclaves and hibernation on the same instance."HibernationOptions"
: Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide. You can't enable hibernation and AWS Nitro Enclaves on the same instance."ImageId"
: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template."InstanceMarketOptions"
: The market (purchasing) option for the instances. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop."InstanceType"
: The instance type. For more information, see Instance types in the Amazon EC2 User Guide. Default: m1.small"Ipv6Address"
: [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request."Ipv6AddressCount"
: [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. You cannot specify this option and the network interfaces option in the same request."KernelId"
: The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide."KeyName"
: The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair. If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in."LaunchTemplate"
: The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both."LicenseSpecification"
: The license configurations."MetadataOptions"
: The metadata options for the instance. For more information, see Instance metadata and user data."Monitoring"
: Specifies whether detailed monitoring is enabled for the instance."Placement"
: The placement for the instance."RamdiskId"
: The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide."SecurityGroup"
: [EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. If you specify a network interface, you must specify any security groups as part of the network interface. Default: Amazon EC2 uses the default security group."SecurityGroupId"
: The IDs of the security groups. You can create a security group using CreateSecurityGroup. If you specify a network interface, you must specify any security groups as part of the network interface."SubnetId"
: [EC2-VPC] The ID of the subnet to launch the instance into. If you specify a network interface, you must specify any subnets as part of the network interface."TagSpecification"
: The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags."UserData"
: The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB."additionalInfo"
: Reserved."clientToken"
: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring Idempotency. Constraints: Maximum 64 ASCII characters"disableApiTermination"
: If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance. Default: false"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."ebsOptimized"
: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. Default: false"iamInstanceProfile"
: The name or Amazon Resource Name (ARN) of an IAM instance profile."instanceInitiatedShutdownBehavior"
: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop"networkInterface"
: The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface."privateIpAddress"
: [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request. You cannot specify this option and the network interfaces option in the same request.
Main.Ec2.run_scheduled_instances
— Methodrun_scheduled_instances(launch_specification, scheduled_instance_id)
run_scheduled_instances(launch_specification, scheduled_instance_id, params::Dict{String,<:Any})
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. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
Arguments
launch_specification
: The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.scheduled_instance_id
: The Scheduled Instance ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ClientToken"
: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."InstanceCount"
: The number of instances. Default: 1
Main.Ec2.search_local_gateway_routes
— Methodsearch_local_gateway_routes(filter, local_gateway_route_table_id)
search_local_gateway_routes(filter, local_gateway_route_table_id, params::Dict{String,<:Any})
Searches for routes in the specified local gateway route table.
Arguments
filter
: One or more filters.local_gateway_route_table_id
: The ID of the local gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results.
Main.Ec2.search_transit_gateway_multicast_groups
— Methodsearch_transit_gateway_multicast_groups()
search_transit_gateway_multicast_groups(params::Dict{String,<:Any})
Searches one or more transit gateway multicast groups and returns the group membership information.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Filter"
: One or more filters. The possible values are: group-ip-address - The IP address of the transit gateway multicast group. is-group-member - The resource is a group member. Valid values are true | false. is-group-source - The resource is a group source. Valid values are true | false. member-type - The member type. Valid values are igmp | static. resource-id - The ID of the resource. resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering. source-type- The source type. Valid values are igmp | static. state - The state of the subnet
"MaxResults"
: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken"
: The token for the next page of results."TransitGatewayMulticastDomainId"
: The ID of the transit gateway multicast domain.
Main.Ec2.search_transit_gateway_routes
— Methodsearch_transit_gateway_routes(filter, transit_gateway_route_table_id)
search_transit_gateway_routes(filter, transit_gateway_route_table_id, params::Dict{String,<:Any})
Searches for routes in the specified transit gateway route table.
Arguments
filter
: One or more filters. The possible values are: attachment.transit-gateway-attachment-id- The id of the transit gateway attachment. attachment.resource-id - The resource id of the transit gateway attachment. attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect. prefix-list-id - The ID of the prefix list. route-search.exact-match - The exact match of the specified filter. route-search.longest-prefix-match - The longest prefix that matches the route. route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter. route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. state- The state of the route (active | blackhole). type - The type of route (propagated |
transit_gateway_route_table_id
: The ID of the transit gateway route table.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."MaxResults"
: The maximum number of routes to return.
Main.Ec2.send_diagnostic_interrupt
— Methodsend_diagnostic_interrupt(instance_id)
send_diagnostic_interrupt(instance_id, params::Dict{String,<:Any})
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 (Linux instances) or Send a Diagnostic Interrupt (Windows instances).
Arguments
instance_id
: The ID of the instance.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.start_instances
— Methodstart_instances(instance_id)
start_instances(instance_id, params::Dict{String,<:Any})
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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux 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. For more information, see Stopping instances in the Amazon EC2 User Guide.
Arguments
instance_id
: The IDs of the instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"additionalInfo"
: Reserved."dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.start_network_insights_analysis
— Methodstart_network_insights_analysis(client_token, network_insights_path_id)
start_network_insights_analysis(client_token, network_insights_path_id, params::Dict{String,<:Any})
Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
Arguments
client_token
: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.network_insights_path_id
: The ID of the path.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."FilterInArn"
: The Amazon Resource Names (ARN) of the resources that the path must traverse."TagSpecification"
: The tags to apply.
Main.Ec2.start_vpc_endpoint_service_private_dns_verification
— Methodstart_vpc_endpoint_service_private_dns_verification(service_id)
start_vpc_endpoint_service_private_dns_verification(service_id, params::Dict{String,<:Any})
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. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.
Arguments
service_id
: The ID of the endpoint service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.stop_instances
— Methodstop_instances(instance_id)
stop_instances(instance_id, params::Dict{String,<:Any})
Stops an Amazon EBS-backed instance. You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide. We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide. When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs. Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide. When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide.
Arguments
instance_id
: The IDs of the instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Hibernate"
: Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide. Default: false"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."force"
: Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Default: false
Main.Ec2.terminate_client_vpn_connections
— Methodterminate_client_vpn_connections(client_vpn_endpoint_id)
terminate_client_vpn_connections(client_vpn_endpoint_id, params::Dict{String,<:Any})
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.
Arguments
client_vpn_endpoint_id
: The ID of the Client VPN endpoint to which the client is connected.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ConnectionId"
: The ID of the client connection to be terminated."DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."Username"
: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
Main.Ec2.terminate_instances
— Methodterminate_instances(instance_id)
terminate_instances(instance_id, params::Dict{String,<:Any})
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide. For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
Arguments
instance_id
: The IDs of the instances. Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.unassign_ipv6_addresses
— Methodunassign_ipv6_addresses(ipv6_addresses, network_interface_id)
unassign_ipv6_addresses(ipv6_addresses, network_interface_id, params::Dict{String,<:Any})
Unassigns one or more IPv6 addresses from a network interface.
Arguments
ipv6_addresses
: The IPv6 addresses to unassign from the network interface.network_interface_id
: The ID of the network interface.
Main.Ec2.unassign_private_ip_addresses
— Methodunassign_private_ip_addresses(network_interface_id, private_ip_address)
unassign_private_ip_addresses(network_interface_id, private_ip_address, params::Dict{String,<:Any})
Unassigns one or more secondary private IP addresses from a network interface.
Arguments
network_interface_id
: The ID of the network interface.private_ip_address
: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
Main.Ec2.unmonitor_instances
— Methodunmonitor_instances(instance_id)
unmonitor_instances(instance_id, params::Dict{String,<:Any})
Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
Arguments
instance_id
: The IDs of the instances.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"dryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Main.Ec2.update_security_group_rule_descriptions_egress
— Methodupdate_security_group_rule_descriptions_egress(item)
update_security_group_rule_descriptions_egress(item, params::Dict{String,<:Any})
[VPC only] 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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
Arguments
item
: The IP permissions for the security group rule.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupId"
: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID."GroupName"
: [Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request."IpPermissions"
: The IP permissions for the security group rule.
Main.Ec2.update_security_group_rule_descriptions_ingress
— Methodupdate_security_group_rule_descriptions_ingress(item)
update_security_group_rule_descriptions_ingress(item, params::Dict{String,<:Any})
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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
Arguments
item
: The IP permissions for the security group rule.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation."GroupId"
: The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID."GroupName"
: [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request."IpPermissions"
: The IP permissions for the security group rule.
Main.Ec2.withdraw_byoip_cidr
— Methodwithdraw_byoip_cidr(cidr)
withdraw_byoip_cidr(cidr, params::Dict{String,<:Any})
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 AWS because of BGP propagation delays.
Arguments
cidr
: The address range, in CIDR notation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"DryRun"
: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.