EC2 *** Client ====== class EC2.Client A low-level client representing Amazon Elastic Compute Cloud (EC2) You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide. import boto3 client = boto3.client('ec2') These are the available methods: * accept_address_transfer * accept_capacity_reservation_billing_ownership * accept_reserved_instances_exchange_quote * accept_transit_gateway_multicast_domain_associations * accept_transit_gateway_peering_attachment * accept_transit_gateway_vpc_attachment * accept_vpc_endpoint_connections * accept_vpc_peering_connection * advertise_byoip_cidr * allocate_address * allocate_hosts * allocate_ipam_pool_cidr * apply_security_groups_to_client_vpn_target_network * assign_ipv6_addresses * assign_private_ip_addresses * assign_private_nat_gateway_address * associate_address * associate_capacity_reservation_billing_owner * associate_client_vpn_target_network * associate_dhcp_options * associate_enclave_certificate_iam_role * associate_iam_instance_profile * associate_instance_event_window * associate_ipam_byoasn * associate_ipam_resource_discovery * associate_nat_gateway_address * associate_route_server * associate_route_table * associate_security_group_vpc * associate_subnet_cidr_block * associate_transit_gateway_multicast_domain * associate_transit_gateway_policy_table * associate_transit_gateway_route_table * associate_trunk_interface * associate_vpc_cidr_block * attach_classic_link_vpc * attach_internet_gateway * attach_network_interface * attach_verified_access_trust_provider * attach_volume * attach_vpn_gateway * authorize_client_vpn_ingress * authorize_security_group_egress * authorize_security_group_ingress * bundle_instance * can_paginate * cancel_bundle_task * cancel_capacity_reservation * cancel_capacity_reservation_fleets * cancel_conversion_task * cancel_declarative_policies_report * cancel_export_task * cancel_image_launch_permission * cancel_import_task * cancel_reserved_instances_listing * cancel_spot_fleet_requests * cancel_spot_instance_requests * close * confirm_product_instance * copy_fpga_image * copy_image * copy_snapshot * create_capacity_reservation * create_capacity_reservation_by_splitting * create_capacity_reservation_fleet * create_carrier_gateway * create_client_vpn_endpoint * create_client_vpn_route * create_coip_cidr * create_coip_pool * create_customer_gateway * create_default_subnet * create_default_vpc * create_delegate_mac_volume_ownership_task * create_dhcp_options * create_egress_only_internet_gateway * create_fleet * create_flow_logs * create_fpga_image * create_image * create_instance_connect_endpoint * create_instance_event_window * create_instance_export_task * create_internet_gateway * create_ipam * create_ipam_external_resource_verification_token * create_ipam_pool * create_ipam_resource_discovery * create_ipam_scope * create_key_pair * create_launch_template * create_launch_template_version * create_local_gateway_route * create_local_gateway_route_table * create_local_gateway_route_table_virtual_interface_group_association * create_local_gateway_route_table_vpc_association * create_local_gateway_virtual_interface * create_local_gateway_virtual_interface_group * create_mac_system_integrity_protection_modification_task * create_managed_prefix_list * create_nat_gateway * create_network_acl * create_network_acl_entry * create_network_insights_access_scope * create_network_insights_path * create_network_interface * create_network_interface_permission * create_placement_group * create_public_ipv4_pool * create_replace_root_volume_task * create_reserved_instances_listing * create_restore_image_task * create_route * create_route_server * create_route_server_endpoint * create_route_server_peer * create_route_table * create_security_group * create_snapshot * create_snapshots * create_spot_datafeed_subscription * create_store_image_task * create_subnet * create_subnet_cidr_reservation * create_tags * create_traffic_mirror_filter * create_traffic_mirror_filter_rule * create_traffic_mirror_session * create_traffic_mirror_target * create_transit_gateway * create_transit_gateway_connect * create_transit_gateway_connect_peer * create_transit_gateway_multicast_domain * create_transit_gateway_peering_attachment * create_transit_gateway_policy_table * create_transit_gateway_prefix_list_reference * create_transit_gateway_route * create_transit_gateway_route_table * create_transit_gateway_route_table_announcement * create_transit_gateway_vpc_attachment * create_verified_access_endpoint * create_verified_access_group * create_verified_access_instance * create_verified_access_trust_provider * create_volume * create_vpc * create_vpc_block_public_access_exclusion * create_vpc_endpoint * create_vpc_endpoint_connection_notification * create_vpc_endpoint_service_configuration * create_vpc_peering_connection * create_vpn_connection * create_vpn_connection_route * create_vpn_gateway * delete_carrier_gateway * delete_client_vpn_endpoint * delete_client_vpn_route * delete_coip_cidr * delete_coip_pool * delete_customer_gateway * delete_dhcp_options * delete_egress_only_internet_gateway * delete_fleets * delete_flow_logs * delete_fpga_image * delete_instance_connect_endpoint * delete_instance_event_window * delete_internet_gateway * delete_ipam * delete_ipam_external_resource_verification_token * delete_ipam_pool * delete_ipam_resource_discovery * delete_ipam_scope * delete_key_pair * delete_launch_template * delete_launch_template_versions * delete_local_gateway_route * delete_local_gateway_route_table * delete_local_gateway_route_table_virtual_interface_group_association * delete_local_gateway_route_table_vpc_association * delete_local_gateway_virtual_interface * delete_local_gateway_virtual_interface_group * delete_managed_prefix_list * delete_nat_gateway * delete_network_acl * delete_network_acl_entry * delete_network_insights_access_scope * delete_network_insights_access_scope_analysis * delete_network_insights_analysis * delete_network_insights_path * delete_network_interface * delete_network_interface_permission * delete_placement_group * delete_public_ipv4_pool * delete_queued_reserved_instances * delete_route * delete_route_server * delete_route_server_endpoint * delete_route_server_peer * delete_route_table * delete_security_group * delete_snapshot * delete_spot_datafeed_subscription * delete_subnet * delete_subnet_cidr_reservation * delete_tags * delete_traffic_mirror_filter * delete_traffic_mirror_filter_rule * delete_traffic_mirror_session * delete_traffic_mirror_target * delete_transit_gateway * delete_transit_gateway_connect * delete_transit_gateway_connect_peer * delete_transit_gateway_multicast_domain * delete_transit_gateway_peering_attachment * delete_transit_gateway_policy_table * delete_transit_gateway_prefix_list_reference * delete_transit_gateway_route * delete_transit_gateway_route_table * delete_transit_gateway_route_table_announcement * delete_transit_gateway_vpc_attachment * delete_verified_access_endpoint * delete_verified_access_group * delete_verified_access_instance * delete_verified_access_trust_provider * delete_volume * delete_vpc * delete_vpc_block_public_access_exclusion * delete_vpc_endpoint_connection_notifications * delete_vpc_endpoint_service_configurations * delete_vpc_endpoints * delete_vpc_peering_connection * delete_vpn_connection * delete_vpn_connection_route * delete_vpn_gateway * deprovision_byoip_cidr * deprovision_ipam_byoasn * deprovision_ipam_pool_cidr * deprovision_public_ipv4_pool_cidr * deregister_image * deregister_instance_event_notification_attributes * deregister_transit_gateway_multicast_group_members * deregister_transit_gateway_multicast_group_sources * describe_account_attributes * describe_address_transfers * describe_addresses * describe_addresses_attribute * describe_aggregate_id_format * describe_availability_zones * describe_aws_network_performance_metric_subscriptions * describe_bundle_tasks * describe_byoip_cidrs * describe_capacity_block_extension_history * describe_capacity_block_extension_offerings * describe_capacity_block_offerings * describe_capacity_block_status * describe_capacity_blocks * describe_capacity_reservation_billing_requests * describe_capacity_reservation_fleets * describe_capacity_reservations * describe_carrier_gateways * describe_classic_link_instances * describe_client_vpn_authorization_rules * describe_client_vpn_connections * describe_client_vpn_endpoints * describe_client_vpn_routes * describe_client_vpn_target_networks * describe_coip_pools * describe_conversion_tasks * describe_customer_gateways * describe_declarative_policies_reports * describe_dhcp_options * describe_egress_only_internet_gateways * describe_elastic_gpus * describe_export_image_tasks * describe_export_tasks * describe_fast_launch_images * describe_fast_snapshot_restores * describe_fleet_history * describe_fleet_instances * describe_fleets * describe_flow_logs * describe_fpga_image_attribute * describe_fpga_images * describe_host_reservation_offerings * describe_host_reservations * describe_hosts * describe_iam_instance_profile_associations * describe_id_format * describe_identity_id_format * describe_image_attribute * describe_images * describe_import_image_tasks * describe_import_snapshot_tasks * describe_instance_attribute * describe_instance_connect_endpoints * describe_instance_credit_specifications * describe_instance_event_notification_attributes * describe_instance_event_windows * describe_instance_image_metadata * describe_instance_status * describe_instance_topology * describe_instance_type_offerings * describe_instance_types * describe_instances * describe_internet_gateways * describe_ipam_byoasn * describe_ipam_external_resource_verification_tokens * describe_ipam_pools * describe_ipam_resource_discoveries * describe_ipam_resource_discovery_associations * describe_ipam_scopes * describe_ipams * describe_ipv6_pools * describe_key_pairs * describe_launch_template_versions * describe_launch_templates * describe_local_gateway_route_table_virtual_interface_group_associat ions * describe_local_gateway_route_table_vpc_associations * describe_local_gateway_route_tables * describe_local_gateway_virtual_interface_groups * describe_local_gateway_virtual_interfaces * describe_local_gateways * describe_locked_snapshots * describe_mac_hosts * describe_mac_modification_tasks * describe_managed_prefix_lists * describe_moving_addresses * describe_nat_gateways * describe_network_acls * describe_network_insights_access_scope_analyses * describe_network_insights_access_scopes * describe_network_insights_analyses * describe_network_insights_paths * describe_network_interface_attribute * describe_network_interface_permissions * describe_network_interfaces * describe_outpost_lags * describe_placement_groups * describe_prefix_lists * describe_principal_id_format * describe_public_ipv4_pools * describe_regions * describe_replace_root_volume_tasks * describe_reserved_instances * describe_reserved_instances_listings * describe_reserved_instances_modifications * describe_reserved_instances_offerings * describe_route_server_endpoints * describe_route_server_peers * describe_route_servers * describe_route_tables * describe_scheduled_instance_availability * describe_scheduled_instances * describe_security_group_references * describe_security_group_rules * describe_security_group_vpc_associations * describe_security_groups * describe_service_link_virtual_interfaces * describe_snapshot_attribute * describe_snapshot_tier_status * describe_snapshots * describe_spot_datafeed_subscription * describe_spot_fleet_instances * describe_spot_fleet_request_history * describe_spot_fleet_requests * describe_spot_instance_requests * describe_spot_price_history * describe_stale_security_groups * describe_store_image_tasks * describe_subnets * describe_tags * describe_traffic_mirror_filter_rules * describe_traffic_mirror_filters * describe_traffic_mirror_sessions * describe_traffic_mirror_targets * describe_transit_gateway_attachments * describe_transit_gateway_connect_peers * describe_transit_gateway_connects * describe_transit_gateway_multicast_domains * describe_transit_gateway_peering_attachments * describe_transit_gateway_policy_tables * describe_transit_gateway_route_table_announcements * describe_transit_gateway_route_tables * describe_transit_gateway_vpc_attachments * describe_transit_gateways * describe_trunk_interface_associations * describe_verified_access_endpoints * describe_verified_access_groups * describe_verified_access_instance_logging_configurations * describe_verified_access_instances * describe_verified_access_trust_providers * describe_volume_attribute * describe_volume_status * describe_volumes * describe_volumes_modifications * describe_vpc_attribute * describe_vpc_block_public_access_exclusions * describe_vpc_block_public_access_options * describe_vpc_classic_link * describe_vpc_classic_link_dns_support * describe_vpc_endpoint_associations * describe_vpc_endpoint_connection_notifications * describe_vpc_endpoint_connections * describe_vpc_endpoint_service_configurations * describe_vpc_endpoint_service_permissions * describe_vpc_endpoint_services * describe_vpc_endpoints * describe_vpc_peering_connections * describe_vpcs * describe_vpn_connections * describe_vpn_gateways * detach_classic_link_vpc * detach_internet_gateway * detach_network_interface * detach_verified_access_trust_provider * detach_volume * detach_vpn_gateway * disable_address_transfer * disable_allowed_images_settings * disable_aws_network_performance_metric_subscription * disable_ebs_encryption_by_default * disable_fast_launch * disable_fast_snapshot_restores * disable_image * disable_image_block_public_access * disable_image_deprecation * disable_image_deregistration_protection * disable_ipam_organization_admin_account * disable_route_server_propagation * disable_serial_console_access * disable_snapshot_block_public_access * disable_transit_gateway_route_table_propagation * disable_vgw_route_propagation * disable_vpc_classic_link * disable_vpc_classic_link_dns_support * disassociate_address * disassociate_capacity_reservation_billing_owner * disassociate_client_vpn_target_network * disassociate_enclave_certificate_iam_role * disassociate_iam_instance_profile * disassociate_instance_event_window * disassociate_ipam_byoasn * disassociate_ipam_resource_discovery * disassociate_nat_gateway_address * disassociate_route_server * disassociate_route_table * disassociate_security_group_vpc * disassociate_subnet_cidr_block * disassociate_transit_gateway_multicast_domain * disassociate_transit_gateway_policy_table * disassociate_transit_gateway_route_table * disassociate_trunk_interface * disassociate_vpc_cidr_block * enable_address_transfer * enable_allowed_images_settings * enable_aws_network_performance_metric_subscription * enable_ebs_encryption_by_default * enable_fast_launch * enable_fast_snapshot_restores * enable_image * enable_image_block_public_access * enable_image_deprecation * enable_image_deregistration_protection * enable_ipam_organization_admin_account * enable_reachability_analyzer_organization_sharing * enable_route_server_propagation * enable_serial_console_access * enable_snapshot_block_public_access * enable_transit_gateway_route_table_propagation * enable_vgw_route_propagation * enable_volume_io * enable_vpc_classic_link * enable_vpc_classic_link_dns_support * export_client_vpn_client_certificate_revocation_list * export_client_vpn_client_configuration * export_image * export_transit_gateway_routes * export_verified_access_instance_client_configuration * get_active_vpn_tunnel_status * get_allowed_images_settings * get_associated_enclave_certificate_iam_roles * get_associated_ipv6_pool_cidrs * get_aws_network_performance_data * get_capacity_reservation_usage * get_coip_pool_usage * get_console_output * get_console_screenshot * get_declarative_policies_report_summary * get_default_credit_specification * get_ebs_default_kms_key_id * get_ebs_encryption_by_default * get_flow_logs_integration_template * get_groups_for_capacity_reservation * get_host_reservation_purchase_preview * get_image_block_public_access_state * get_instance_metadata_defaults * get_instance_tpm_ek_pub * get_instance_types_from_instance_requirements * get_instance_uefi_data * get_ipam_address_history * get_ipam_discovered_accounts * get_ipam_discovered_public_addresses * get_ipam_discovered_resource_cidrs * get_ipam_pool_allocations * get_ipam_pool_cidrs * get_ipam_resource_cidrs * get_launch_template_data * get_managed_prefix_list_associations * get_managed_prefix_list_entries * get_network_insights_access_scope_analysis_findings * get_network_insights_access_scope_content * get_paginator * get_password_data * get_reserved_instances_exchange_quote * get_route_server_associations * get_route_server_propagations * get_route_server_routing_database * get_security_groups_for_vpc * get_serial_console_access_status * get_snapshot_block_public_access_state * get_spot_placement_scores * get_subnet_cidr_reservations * get_transit_gateway_attachment_propagations * get_transit_gateway_multicast_domain_associations * get_transit_gateway_policy_table_associations * get_transit_gateway_policy_table_entries * get_transit_gateway_prefix_list_references * get_transit_gateway_route_table_associations * get_transit_gateway_route_table_propagations * get_verified_access_endpoint_policy * get_verified_access_endpoint_targets * get_verified_access_group_policy * get_vpn_connection_device_sample_configuration * get_vpn_connection_device_types * get_vpn_tunnel_replacement_status * get_waiter * import_client_vpn_client_certificate_revocation_list * import_image * import_instance * import_key_pair * import_snapshot * import_volume * list_images_in_recycle_bin * list_snapshots_in_recycle_bin * lock_snapshot * modify_address_attribute * modify_availability_zone_group * modify_capacity_reservation * modify_capacity_reservation_fleet * modify_client_vpn_endpoint * modify_default_credit_specification * modify_ebs_default_kms_key_id * modify_fleet * modify_fpga_image_attribute * modify_hosts * modify_id_format * modify_identity_id_format * modify_image_attribute * modify_instance_attribute * modify_instance_capacity_reservation_attributes * modify_instance_cpu_options * modify_instance_credit_specification * modify_instance_event_start_time * modify_instance_event_window * modify_instance_maintenance_options * modify_instance_metadata_defaults * modify_instance_metadata_options * modify_instance_network_performance_options * modify_instance_placement * modify_ipam * modify_ipam_pool * modify_ipam_resource_cidr * modify_ipam_resource_discovery * modify_ipam_scope * modify_launch_template * modify_local_gateway_route * modify_managed_prefix_list * modify_network_interface_attribute * modify_private_dns_name_options * modify_public_ip_dns_name_options * modify_reserved_instances * modify_route_server * modify_security_group_rules * modify_snapshot_attribute * modify_snapshot_tier * modify_spot_fleet_request * modify_subnet_attribute * modify_traffic_mirror_filter_network_services * modify_traffic_mirror_filter_rule * modify_traffic_mirror_session * modify_transit_gateway * modify_transit_gateway_prefix_list_reference * modify_transit_gateway_vpc_attachment * modify_verified_access_endpoint * modify_verified_access_endpoint_policy * modify_verified_access_group * modify_verified_access_group_policy * modify_verified_access_instance * modify_verified_access_instance_logging_configuration * modify_verified_access_trust_provider * modify_volume * modify_volume_attribute * modify_vpc_attribute * modify_vpc_block_public_access_exclusion * modify_vpc_block_public_access_options * modify_vpc_endpoint * modify_vpc_endpoint_connection_notification * modify_vpc_endpoint_service_configuration * modify_vpc_endpoint_service_payer_responsibility * modify_vpc_endpoint_service_permissions * modify_vpc_peering_connection_options * modify_vpc_tenancy * modify_vpn_connection * modify_vpn_connection_options * modify_vpn_tunnel_certificate * modify_vpn_tunnel_options * monitor_instances * move_address_to_vpc * move_byoip_cidr_to_ipam * move_capacity_reservation_instances * provision_byoip_cidr * provision_ipam_byoasn * provision_ipam_pool_cidr * provision_public_ipv4_pool_cidr * purchase_capacity_block * purchase_capacity_block_extension * purchase_host_reservation * purchase_reserved_instances_offering * purchase_scheduled_instances * reboot_instances * register_image * register_instance_event_notification_attributes * register_transit_gateway_multicast_group_members * register_transit_gateway_multicast_group_sources * reject_capacity_reservation_billing_ownership * reject_transit_gateway_multicast_domain_associations * reject_transit_gateway_peering_attachment * reject_transit_gateway_vpc_attachment * reject_vpc_endpoint_connections * reject_vpc_peering_connection * release_address * release_hosts * release_ipam_pool_allocation * replace_iam_instance_profile_association * replace_image_criteria_in_allowed_images_settings * replace_network_acl_association * replace_network_acl_entry * replace_route * replace_route_table_association * replace_transit_gateway_route * replace_vpn_tunnel * report_instance_status * request_spot_fleet * request_spot_instances * reset_address_attribute * reset_ebs_default_kms_key_id * reset_fpga_image_attribute * reset_image_attribute * reset_instance_attribute * reset_network_interface_attribute * reset_snapshot_attribute * restore_address_to_classic * restore_image_from_recycle_bin * restore_managed_prefix_list_version * restore_snapshot_from_recycle_bin * restore_snapshot_tier * revoke_client_vpn_ingress * revoke_security_group_egress * revoke_security_group_ingress * run_instances * run_scheduled_instances * search_local_gateway_routes * search_transit_gateway_multicast_groups * search_transit_gateway_routes * send_diagnostic_interrupt * start_declarative_policies_report * start_instances * start_network_insights_access_scope_analysis * start_network_insights_analysis * start_vpc_endpoint_service_private_dns_verification * stop_instances * terminate_client_vpn_connections * terminate_instances * unassign_ipv6_addresses * unassign_private_ip_addresses * unassign_private_nat_gateway_address * unlock_snapshot * unmonitor_instances * update_security_group_rule_descriptions_egress * update_security_group_rule_descriptions_ingress * withdraw_byoip_cidr Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeAddressTransfers * DescribeAddressesAttribute * DescribeAwsNetworkPerformanceMetricSubscriptions * DescribeByoipCidrs * DescribeCapacityBlockExtensionHistory * DescribeCapacityBlockExtensionOfferings * DescribeCapacityBlockOfferings * DescribeCapacityBlockStatus * DescribeCapacityBlocks * DescribeCapacityReservationBillingRequests * DescribeCapacityReservationFleets * DescribeCapacityReservations * DescribeCarrierGateways * DescribeClassicLinkInstances * DescribeClientVpnAuthorizationRules * DescribeClientVpnConnections * DescribeClientVpnEndpoints * DescribeClientVpnRoutes * DescribeClientVpnTargetNetworks * DescribeCoipPools * DescribeDhcpOptions * DescribeEgressOnlyInternetGateways * DescribeExportImageTasks * DescribeFastLaunchImages * DescribeFastSnapshotRestores * DescribeFleets * DescribeFlowLogs * DescribeFpgaImages * DescribeHostReservationOfferings * DescribeHostReservations * DescribeHosts * DescribeIamInstanceProfileAssociations * DescribeImages * DescribeImportImageTasks * DescribeImportSnapshotTasks * DescribeInstanceConnectEndpoints * DescribeInstanceCreditSpecifications * DescribeInstanceEventWindows * DescribeInstanceImageMetadata * DescribeInstanceStatus * DescribeInstanceTopology * DescribeInstanceTypeOfferings * DescribeInstanceTypes * DescribeInstances * DescribeInternetGateways * DescribeIpamPools * DescribeIpamResourceDiscoveries * DescribeIpamResourceDiscoveryAssociations * DescribeIpamScopes * DescribeIpams * DescribeIpv6Pools * DescribeLaunchTemplateVersions * DescribeLaunchTemplates * DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations * DescribeLocalGatewayRouteTableVpcAssociations * DescribeLocalGatewayRouteTables * DescribeLocalGatewayVirtualInterfaceGroups * DescribeLocalGatewayVirtualInterfaces * DescribeLocalGateways * DescribeMacHosts * DescribeMacModificationTasks * DescribeManagedPrefixLists * DescribeMovingAddresses * DescribeNatGateways * DescribeNetworkAcls * DescribeNetworkInsightsAccessScopeAnalyses * DescribeNetworkInsightsAccessScopes * DescribeNetworkInsightsAnalyses * DescribeNetworkInsightsPaths * DescribeNetworkInterfacePermissions * DescribeNetworkInterfaces * DescribePrefixLists * DescribePrincipalIdFormat * DescribePublicIpv4Pools * DescribeReplaceRootVolumeTasks * DescribeReservedInstancesModifications * DescribeReservedInstancesOfferings * DescribeRouteServerEndpoints * DescribeRouteServerPeers * DescribeRouteServers * DescribeRouteTables * DescribeScheduledInstanceAvailability * DescribeScheduledInstances * DescribeSecurityGroupRules * DescribeSecurityGroupVpcAssociations * DescribeSecurityGroups * DescribeSnapshotTierStatus * DescribeSnapshots * DescribeSpotFleetInstances * DescribeSpotFleetRequests * DescribeSpotInstanceRequests * DescribeSpotPriceHistory * DescribeStaleSecurityGroups * DescribeStoreImageTasks * DescribeSubnets * DescribeTags * DescribeTrafficMirrorFilters * DescribeTrafficMirrorSessions * DescribeTrafficMirrorTargets * DescribeTransitGatewayAttachments * DescribeTransitGatewayConnectPeers * DescribeTransitGatewayConnects * DescribeTransitGatewayMulticastDomains * DescribeTransitGatewayPeeringAttachments * DescribeTransitGatewayPolicyTables * DescribeTransitGatewayRouteTableAnnouncements * DescribeTransitGatewayRouteTables * DescribeTransitGatewayVpcAttachments * DescribeTransitGateways * DescribeTrunkInterfaceAssociations * DescribeVerifiedAccessEndpoints * DescribeVerifiedAccessGroups * DescribeVerifiedAccessInstanceLoggingConfigurations * DescribeVerifiedAccessInstances * DescribeVerifiedAccessTrustProviders * DescribeVolumeStatus * DescribeVolumes * DescribeVolumesModifications * DescribeVpcClassicLinkDnsSupport * DescribeVpcEndpointConnectionNotifications * DescribeVpcEndpointConnections * DescribeVpcEndpointServiceConfigurations * DescribeVpcEndpointServicePermissions * DescribeVpcEndpointServices * DescribeVpcEndpoints * DescribeVpcPeeringConnections * DescribeVpcs * GetAssociatedIpv6PoolCidrs * GetAwsNetworkPerformanceData * GetGroupsForCapacityReservation * GetInstanceTypesFromInstanceRequirements * GetIpamAddressHistory * GetIpamDiscoveredAccounts * GetIpamDiscoveredResourceCidrs * GetIpamPoolAllocations * GetIpamPoolCidrs * GetIpamResourceCidrs * GetManagedPrefixListAssociations * GetManagedPrefixListEntries * GetNetworkInsightsAccessScopeAnalysisFindings * GetSecurityGroupsForVpc * GetSpotPlacementScores * GetTransitGatewayAttachmentPropagations * GetTransitGatewayMulticastDomainAssociations * GetTransitGatewayPolicyTableAssociations * GetTransitGatewayPrefixListReferences * GetTransitGatewayRouteTableAssociations * GetTransitGatewayRouteTablePropagations * GetVpnConnectionDeviceTypes * ListImagesInRecycleBin * ListSnapshotsInRecycleBin * SearchLocalGatewayRoutes * SearchTransitGatewayMulticastGroups Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * BundleTaskComplete * ConversionTaskCancelled * ConversionTaskCompleted * ConversionTaskDeleted * CustomerGatewayAvailable * ExportTaskCancelled * ExportTaskCompleted * ImageAvailable * ImageExists * InstanceExists * InstanceRunning * InstanceStatusOk * InstanceStopped * InstanceTerminated * InternetGatewayExists * KeyPairExists * NatGatewayAvailable * NatGatewayDeleted * NetworkInterfaceAvailable * PasswordDataAvailable * SecurityGroupExists * SecurityGroupVpcAssociationAssociated * SecurityGroupVpcAssociationDisassociated * SnapshotCompleted * SnapshotImported * SpotInstanceRequestFulfilled * StoreImageTaskComplete * SubnetAvailable * SystemStatusOk * VolumeAvailable * VolumeDeleted * VolumeInUse * VpcAvailable * VpcExists * VpcPeeringConnectionDeleted * VpcPeeringConnectionExists * VpnConnectionAvailable * VpnConnectionDeleted Resources ========= Resources are available in boto3 via the "resource" method. For more detailed instructions and examples on the usage of resources, see the resources user guide. The available resources are: * Service Resource * ClassicAddress * DhcpOptions * Image * Instance * InternetGateway * KeyPair * KeyPairInfo * NetworkAcl * NetworkInterface * NetworkInterfaceAssociation * PlacementGroup * Route * RouteTable * RouteTableAssociation * SecurityGroup * Snapshot * Subnet * Tag * Volume * Vpc * VpcPeeringConnection * VpcAddress NetworkInterfaceAssociation / Reference / address address ******* EC2.NetworkInterfaceAssociation.address ("VpcAddress") The related address if set, otherwise "None". NetworkInterfaceAssociation / Attribute / ip_owner_id ip_owner_id *********** EC2.NetworkInterfaceAssociation.ip_owner_id * *(string) --* The ID of the owner of the Elastic IP address. NetworkInterfaceAssociation / Action / get_available_subresources get_available_subresources ************************** EC2.NetworkInterfaceAssociation.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str NetworkInterfaceAssociation / Attribute / public_ip public_ip ********* EC2.NetworkInterfaceAssociation.public_ip * *(string) --* The public IP address or Elastic IP address bound to the network interface. NetworkInterfaceAssociation / Action / load load **** EC2.NetworkInterfaceAssociation.load() Calls "EC2.Client.describe_network_interfaces()" to update the attributes of the NetworkInterfaceAssociation resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_interface_association.load() Returns: None EC2 / Resource / NetworkInterfaceAssociation NetworkInterfaceAssociation *************************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.NetworkInterfaceAssociation(id) A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkInterfaceAssociation: import boto3 ec2 = boto3.resource('ec2') network_interface_association = ec2.NetworkInterfaceAssociation('id') Parameters: **id** (*string*) -- The NetworkInterfaceAssociation's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * carrier_ip * customer_owned_ip * ip_owner_id * public_dns_name * public_ip References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * address Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * reload NetworkInterfaceAssociation / Attribute / customer_owned_ip customer_owned_ip ***************** EC2.NetworkInterfaceAssociation.customer_owned_ip * *(string) --* The customer-owned IP address associated with the network interface. NetworkInterfaceAssociation / Action / reload reload ****** EC2.NetworkInterfaceAssociation.reload() Calls "EC2.Client.describe_network_interfaces()" to update the attributes of the NetworkInterfaceAssociation resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_interface_association.reload() Returns: None NetworkInterfaceAssociation / Identifier / id id ** EC2.NetworkInterfaceAssociation.id *(string)* The NetworkInterfaceAssociation's id identifier. This **must** be set. NetworkInterfaceAssociation / Attribute / public_dns_name public_dns_name *************** EC2.NetworkInterfaceAssociation.public_dns_name * *(string) --* The public DNS name. NetworkInterfaceAssociation / Attribute / carrier_ip carrier_ip ********** EC2.NetworkInterfaceAssociation.carrier_ip * *(string) --* The carrier IP address associated with the network interface. NetworkInterfaceAssociation / Action / delete delete ****** EC2.NetworkInterfaceAssociation.delete(**kwargs) Disassociates an Elastic IP address from the instance or network interface it's associated with. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. An address cannot be disassociated if the all of the following conditions are met: * Network interface has a "publicDualStackDnsName" publicDnsName * Public IPv4 address is the primary public IPv4 address * Network interface only has one remaining public IPv4 address See also: AWS API Documentation **Request Syntax** response = network_interface_association.delete( PublicIp='string', DryRun=True|False ) Parameters: * **PublicIp** (*string*) -- Deprecated. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Snapshot / Action / describe_attribute describe_attribute ****************** EC2.Snapshot.describe_attribute(**kwargs) Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see Amazon EBS snapshots in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = snapshot.describe_attribute( Attribute='productCodes'|'createVolumePermission', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The snapshot attribute you would like to view. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'SnapshotId': 'string', 'CreateVolumePermissions': [ { 'UserId': 'string', 'Group': 'all' }, ] } **Response Structure** * *(dict) --* * **ProductCodes** *(list) --* The product codes. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **SnapshotId** *(string) --* The ID of the EBS snapshot. * **CreateVolumePermissions** *(list) --* The users and groups that have the permissions for creating volumes from the snapshot. * *(dict) --* Describes the user or group to be added or removed from the list of create volume permissions for a volume. * **UserId** *(string) --* The ID of the Amazon Web Services account to be added or removed. * **Group** *(string) --* The group to be added or removed. The possible value is "all". Snapshot / Attribute / owner_alias owner_alias *********** EC2.Snapshot.owner_alias * *(string) --* The Amazon Web Services owner alias, from an Amazon-maintained list ( "amazon"). This is not the user-configured Amazon Web Services account alias set using the IAM console. Snapshot / Attribute / sse_type sse_type ******** EC2.Snapshot.sse_type * *(string) --* Reserved for future use. Snapshot / Action / get_available_subresources get_available_subresources ************************** EC2.Snapshot.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Snapshot / Attribute / outpost_arn outpost_arn *********** EC2.Snapshot.outpost_arn * *(string) --* The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the *Amazon EBS User Guide*. Snapshot / Action / modify_attribute modify_attribute **************** EC2.Snapshot.modify_attribute(**kwargs) Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation. Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts. For more information about modifying snapshot permissions, see Share a snapshot in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = snapshot.modify_attribute( Attribute='productCodes'|'createVolumePermission', CreateVolumePermission={ 'Add': [ { 'UserId': 'string', 'Group': 'all' }, ], 'Remove': [ { 'UserId': 'string', 'Group': 'all' }, ] }, GroupNames=[ 'string', ], OperationType='add'|'remove', UserIds=[ 'string', ], DryRun=True|False ) Parameters: * **Attribute** (*string*) -- The snapshot attribute to modify. Only volume creation permissions can be modified. * **CreateVolumePermission** (*dict*) -- A JSON representation of the snapshot attribute modification. * **Add** *(list) --* Adds the specified Amazon Web Services account ID or group to the list. * *(dict) --* Describes the user or group to be added or removed from the list of create volume permissions for a volume. * **UserId** *(string) --* The ID of the Amazon Web Services account to be added or removed. * **Group** *(string) --* The group to be added or removed. The possible value is "all". * **Remove** *(list) --* Removes the specified Amazon Web Services account ID or group from the list. * *(dict) --* Describes the user or group to be added or removed from the list of create volume permissions for a volume. * **UserId** *(string) --* The ID of the Amazon Web Services account to be added or removed. * **Group** *(string) --* The group to be added or removed. The possible value is "all". * **GroupNames** (*list*) -- The group to modify for the snapshot. * *(string) --* * **OperationType** (*string*) -- The type of operation to perform to the attribute. * **UserIds** (*list*) -- The account ID to modify for the snapshot. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Snapshot / Attribute / state_message state_message ************* EC2.Snapshot.state_message * *(string) --* Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. Snapshot / Attribute / completion_time completion_time *************** EC2.Snapshot.completion_time * *(datetime) --* The time stamp when the snapshot was completed. Snapshot / Attribute / kms_key_id kms_key_id ********** EC2.Snapshot.kms_key_id * *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume. Snapshot / Attribute / progress progress ******** EC2.Snapshot.progress * *(string) --* The progress of the snapshot, as a percentage. Snapshot / Action / load load **** EC2.Snapshot.load() Calls "EC2.Client.describe_snapshots()" to update the attributes of the Snapshot resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** snapshot.load() Returns: None EC2 / Resource / Snapshot Snapshot ******** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.Snapshot(id) A resource representing an Amazon Elastic Compute Cloud (EC2) Snapshot: import boto3 ec2 = boto3.resource('ec2') snapshot = ec2.Snapshot('id') Parameters: **id** (*string*) -- The Snapshot's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * availability_zone * completion_duration_minutes * completion_time * data_encryption_key_id * description * encrypted * full_snapshot_size_in_bytes * kms_key_id * outpost_arn * owner_alias * owner_id * progress * restore_expiry_time * snapshot_id * sse_type * start_time * state * state_message * storage_tier * tags * transfer_type * volume_id * volume_size References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * volume Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * copy * create_tags * delete * describe_attribute * get_available_subresources * load * modify_attribute * reload * reset_attribute Waiters ======= Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide. These are the resource's available waiters: * wait_until_completed Snapshot / Attribute / completion_duration_minutes completion_duration_minutes *************************** EC2.Snapshot.completion_duration_minutes * *(integer) --* Note: Only for snapshot copies created with time-based snapshot copy operations. The completion duration requested for the time-based snapshot copy operation. Snapshot / Reference / volume volume ****** EC2.Snapshot.volume ("Volume") The related volume if set, otherwise "None". Snapshot / Action / create_tags create_tags *********** EC2.Snapshot.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = snapshot.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources Snapshot / Attribute / volume_id volume_id ********* EC2.Snapshot.volume_id * *(string) --* The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose. Snapshot / Action / reset_attribute reset_attribute *************** EC2.Snapshot.reset_attribute(**kwargs) Resets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Share a snapshot in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = snapshot.reset_attribute( Attribute='productCodes'|'createVolumePermission', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Snapshot / Attribute / storage_tier storage_tier ************ EC2.Snapshot.storage_tier * *(string) --* The storage tier in which the snapshot is stored. "standard" indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. "archive" indicates that the snapshot is currently archived and that it must be restored before it can be used. Snapshot / Attribute / start_time start_time ********** EC2.Snapshot.start_time * *(datetime) --* The time stamp when the snapshot was initiated. Snapshot / Attribute / full_snapshot_size_in_bytes full_snapshot_size_in_bytes *************************** EC2.Snapshot.full_snapshot_size_in_bytes * *(integer) --* The full size of the snapshot, in bytes. Warning: This is **not** the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created. Snapshot / Action / reload reload ****** EC2.Snapshot.reload() Calls "EC2.Client.describe_snapshots()" to update the attributes of the Snapshot resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** snapshot.reload() Returns: None Snapshot / Action / copy copy **** EC2.Snapshot.copy(**kwargs) Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can't copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot. Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using **KmsKeyId**. Outposts do not support unencrypted snapshots. For more information, see Amazon EBS local snapshots on Outposts in the *Amazon EBS User Guide*. Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose. For more information, see Copy an Amazon EBS snapshot in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = snapshot.copy( Description='string', DestinationOutpostArn='string', Encrypted=True|False, KmsKeyId='string', SourceRegion='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], CompletionDurationMinutes=123, DryRun=True|False ) Parameters: * **Description** (*string*) -- A description for the EBS snapshot. * **DestinationOutpostArn** (*string*) -- The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services 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 Copy snapshots from an Amazon Web Services Region to an Outpost in the *Amazon EBS User Guide*. * **DestinationRegion** (*string*) -- 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 CLI, this is specified using the "--region" parameter or the default Region in your Amazon Web Services configuration file. Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required * **Encrypted** (*boolean*) -- 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 EBS User Guide*. * **KmsKeyId** (*string*) -- The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If "KmsKeyId" is specified, the encrypted state must be "true". You can specify the KMS key 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. Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. * **PresignedUrl** (*string*) -- 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 Amazon Web Services 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 (Amazon Web Services Signature Version 4) in the *Amazon S3 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. Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required * **SourceRegion** (*string*) -- **[REQUIRED]** The ID of the Region that contains the snapshot to be copied. * **TagSpecifications** (*list*) -- The tags to apply to the new snapshot. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **CompletionDurationMinutes** (*integer*) -- Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. For more information, see Time-based copies. If you do not specify a value, the snapshot copy operation is completed on a best-effort basis. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SnapshotId': 'string' } **Response Structure** * *(dict) --* * **Tags** *(list) --* Any tags applied to the new snapshot. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SnapshotId** *(string) --* The ID of the new snapshot. Snapshot / Attribute / restore_expiry_time restore_expiry_time ******************* EC2.Snapshot.restore_expiry_time * *(datetime) --* Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. Snapshot / Attribute / availability_zone availability_zone ***************** EC2.Snapshot.availability_zone * *(string) --* The Availability Zone or Local Zone of the snapshot. For example, "us-west-1a" (Availability Zone) or "us-west-2-lax-1a" (Local Zone). Snapshot / Attribute / state state ***** EC2.Snapshot.state * *(string) --* The snapshot state. Snapshot / Attribute / data_encryption_key_id data_encryption_key_id ********************** EC2.Snapshot.data_encryption_key_id * *(string) --* The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots. Snapshot / Attribute / snapshot_id snapshot_id *********** EC2.Snapshot.snapshot_id * *(string) --* The ID of the snapshot. Each snapshot receives a unique identifier when it is created. Snapshot / Attribute / volume_size volume_size *********** EC2.Snapshot.volume_size * *(integer) --* The size of the volume, in GiB. Snapshot / Attribute / encrypted encrypted ********* EC2.Snapshot.encrypted * *(boolean) --* Indicates whether the snapshot is encrypted. Snapshot / Waiter / wait_until_completed wait_until_completed ******************** EC2.Snapshot.wait_until_completed(**kwargs) Waits until this Snapshot is completed. This method calls "EC2.Waiter.snapshot_completed.wait()" which polls "EC2.Client.describe_snapshots()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** snapshot.wait_until_completed( MaxResults=123, NextToken='string', OwnerIds=[ 'string', ], RestorableByUserIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **OwnerIds** (*list*) -- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", and "amazon". * *(string) --* * **RestorableByUserIds** (*list*) -- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. * "owner-id" - The Amazon Web Services 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"). * "storage-tier" - The storage tier of the snapshot ( "archive" | "standard"). * "transfer-type" - The type of operation used to create the snapshot ( "time-based" | "standard"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Returns: None Snapshot / Identifier / id id ** EC2.Snapshot.id *(string)* The Snapshot's id identifier. This **must** be set. Snapshot / Attribute / transfer_type transfer_type ************* EC2.Snapshot.transfer_type * *(string) --* Note: Only for snapshot copies. Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis. * "standard" - The snapshot copy was created with a standard snapshot copy operation. * "time-based" - The snapshot copy was created with a time-based snapshot copy operation. Snapshot / Attribute / owner_id owner_id ******** EC2.Snapshot.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the EBS snapshot. Snapshot / Attribute / description description *********** EC2.Snapshot.description * *(string) --* The description for the snapshot. Snapshot / Attribute / tags tags **** EC2.Snapshot.tags * *(list) --* Any tags assigned to the snapshot. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Snapshot / Action / delete delete ****** EC2.Snapshot.delete(**kwargs) Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first deregister the AMI before you can delete the snapshot. For more information, see Delete an Amazon EBS snapshot in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = snapshot.delete( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None NetworkInterface / Action / describe_attribute describe_attribute ****************** EC2.NetworkInterface.describe_attribute(**kwargs) Describes a network interface attribute. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = network_interface.describe_attribute( DryRun=True|False, Attribute='description'|'groupSet'|'sourceDestCheck'|'attachment'|'associatePublicIpAddress' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Attribute** (*string*) -- The attribute of the network interface. This parameter is required. Return type: dict Returns: **Response Syntax** { 'Attachment': { 'AttachTime': datetime(2015, 1, 1), 'AttachmentId': 'string', 'DeleteOnTermination': True|False, 'DeviceIndex': 123, 'NetworkCardIndex': 123, 'InstanceId': 'string', 'InstanceOwnerId': 'string', 'Status': 'attaching'|'attached'|'detaching'|'detached', 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'EnaQueueCount': 123 }, 'Description': { 'Value': 'string' }, 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'NetworkInterfaceId': 'string', 'SourceDestCheck': { 'Value': True|False }, 'AssociatePublicIpAddress': True|False } **Response Structure** * *(dict) --* Contains the output of DescribeNetworkInterfaceAttribute. * **Attachment** *(dict) --* The attachment (if any) of the network interface. * **AttachTime** *(datetime) --* The timestamp indicating when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The device index of the network interface attachment on the instance. * **NetworkCardIndex** *(integer) --* The index of the network card. * **InstanceId** *(string) --* The ID of the instance. * **InstanceOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the instance. * **Status** *(string) --* The attachment state. * **EnaSrdSpecification** *(dict) --* Configures ENA Express for the network interface that this action attaches to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **Description** *(dict) --* The description of the network interface. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **Groups** *(list) --* The security groups associated with the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **SourceDestCheck** *(dict) --* Indicates whether source/destination checking is enabled. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0). NetworkInterface / Attribute / requester_managed requester_managed ***************** EC2.NetworkInterface.requester_managed * *(boolean) --* Indicates whether the network interface is being managed by Amazon Web Services. NetworkInterface / Attribute / tag_set tag_set ******* EC2.NetworkInterface.tag_set * *(list) --* Any tags assigned to the network interface. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. NetworkInterface / Action / get_available_subresources get_available_subresources ************************** EC2.NetworkInterface.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str NetworkInterface / Attribute / source_dest_check source_dest_check ***************** EC2.NetworkInterface.source_dest_check * *(boolean) --* Indicates whether source/destination checking is enabled. NetworkInterface / Attribute / private_ip_addresses private_ip_addresses ******************** EC2.NetworkInterface.private_ip_addresses * *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes the private IPv4 address of a network interface. * **Association** *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address. NetworkInterface / Attribute / ipv6_addresses ipv6_addresses ************** EC2.NetworkInterface.ipv6_addresses * *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address associated with a network interface. * **Ipv6Address** *(string) --* The IPv6 address. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute. NetworkInterface / Attribute / outpost_arn outpost_arn *********** EC2.NetworkInterface.outpost_arn * *(string) --* The Amazon Resource Name (ARN) of the Outpost. NetworkInterface / Action / modify_attribute modify_attribute **************** EC2.NetworkInterface.modify_attribute(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = network_interface.modify_attribute( EnaSrdSpecification={ 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, EnablePrimaryIpv6=True|False, ConnectionTrackingSpecification={ 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, AssociatePublicIpAddress=True|False, AssociatedSubnetIds=[ 'string', ], DryRun=True|False, Description={ 'Value': 'string' }, SourceDestCheck={ 'Value': True|False }, Groups=[ 'string', ], Attachment={ 'DefaultEnaQueueCount': True|False, 'EnaQueueCount': 123, 'AttachmentId': 'string', 'DeleteOnTermination': True|False } ) Parameters: * **EnaSrdSpecification** (*dict*) -- Updates the ENA Express configuration for the network interface that’s attached to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnablePrimaryIpv6** (*boolean*) -- If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address. * **ConnectionTrackingSpecification** (*dict*) -- A connection tracking specification. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request- response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **AssociatePublicIpAddress** (*boolean*) -- Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0). * **AssociatedSubnetIds** (*list*) -- A list of subnet IDs to associate with the network interface. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Description** (*dict*) -- A description for the network interface. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **SourceDestCheck** (*dict*) -- 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. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **Groups** (*list*) -- 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. * *(string) --* * **Attachment** (*dict*) -- Information about the interface attachment. If modifying the "delete on termination" attribute, you must specify the ID of the interface attachment. * **DefaultEnaQueueCount** *(boolean) --* The default number of the ENA queues. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. Returns: None NetworkInterface / Action / unassign_private_ip_addresses unassign_private_ip_addresses ***************************** EC2.NetworkInterface.unassign_private_ip_addresses(**kwargs) Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface. See also: AWS API Documentation **Request Syntax** response = network_interface.unassign_private_ip_addresses( Ipv4Prefixes=[ 'string', ], PrivateIpAddresses=[ 'string', ] ) Parameters: * **Ipv4Prefixes** (*list*) -- The IPv4 prefixes to unassign from the network interface. * *(string) --* * **PrivateIpAddresses** (*list*) -- 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. * *(string) --* Returns: None NetworkInterface / Attribute / association_attribute association_attribute ********************* EC2.NetworkInterface.association_attribute * *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. NetworkInterface / Attribute / ipv6_address ipv6_address ************ EC2.NetworkInterface.ipv6_address * *(string) --* The IPv6 globally unique address associated with the network interface. NetworkInterface / Attribute / ipv4_prefixes ipv4_prefixes ************* EC2.NetworkInterface.ipv4_prefixes * *(list) --* The IPv4 prefixes that are assigned to the network interface. * *(dict) --* Describes an IPv4 prefix. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. NetworkInterface / Action / load load **** EC2.NetworkInterface.load() Calls "EC2.Client.describe_network_interfaces()" to update the attributes of the NetworkInterface resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_interface.load() Returns: None EC2 / Resource / NetworkInterface NetworkInterface **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.NetworkInterface(id) A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkInterface: import boto3 ec2 = boto3.resource('ec2') network_interface = ec2.NetworkInterface('id') Parameters: **id** (*string*) -- The NetworkInterface's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * associated_subnets * association_attribute * attachment * availability_zone * connection_tracking_configuration * deny_all_igw_traffic * description * groups * interface_type * ipv4_prefixes * ipv6_address * ipv6_addresses * ipv6_native * ipv6_prefixes * mac_address * network_interface_id * operator * outpost_arn * owner_id * private_dns_name * private_ip_address * private_ip_addresses * public_dns_name * public_ip_dns_name_options * requester_id * requester_managed * source_dest_check * status * subnet_id * tag_set * vpc_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * association * subnet * vpc Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * assign_private_ip_addresses * attach * create_tags * delete * describe_attribute * detach * get_available_subresources * load * modify_attribute * reload * reset_attribute * unassign_private_ip_addresses NetworkInterface / Reference / association association *********** EC2.NetworkInterface.association ("NetworkInterfaceAssociation") The related association if set, otherwise "None". NetworkInterface / Attribute / network_interface_id network_interface_id ******************** EC2.NetworkInterface.network_interface_id * *(string) --* The ID of the network interface. NetworkInterface / Action / create_tags create_tags *********** EC2.NetworkInterface.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = network_interface.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources NetworkInterface / Attribute / mac_address mac_address *********** EC2.NetworkInterface.mac_address * *(string) --* The MAC address. NetworkInterface / Action / reset_attribute reset_attribute *************** EC2.NetworkInterface.reset_attribute(**kwargs) Resets a network interface attribute. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = network_interface.reset_attribute( DryRun=True|False, SourceDestCheck='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The source/destination checking attribute. Resets the value to "true". Returns: None NetworkInterface / Attribute / attachment attachment ********** EC2.NetworkInterface.attachment * *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The timestamp indicating when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The device index of the network interface attachment on the instance. * **NetworkCardIndex** *(integer) --* The index of the network card. * **InstanceId** *(string) --* The ID of the instance. * **InstanceOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the instance. * **Status** *(string) --* The attachment state. * **EnaSrdSpecification** *(dict) --* Configures ENA Express for the network interface that this action attaches to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. NetworkInterface / Attribute / groups groups ****** EC2.NetworkInterface.groups * *(list) --* Any security groups for the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. NetworkInterface / Attribute / ipv6_native ipv6_native *********** EC2.NetworkInterface.ipv6_native * *(boolean) --* Indicates whether this is an IPv6 only network interface. NetworkInterface / Reference / subnet subnet ****** EC2.NetworkInterface.subnet ("Subnet") The related subnet if set, otherwise "None". NetworkInterface / Action / assign_private_ip_addresses assign_private_ip_addresses *************************** EC2.NetworkInterface.assign_private_ip_addresses(**kwargs) Assigns the specified secondary private IP addresses to the specified network interface. You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the *Amazon EC2 User Guide*. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check "network/interfaces/macs/mac/local-ipv4s" in the instance metadata to confirm that the remapping is complete. You must specify either the IP addresses or the IP address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = network_interface.assign_private_ip_addresses( Ipv4Prefixes=[ 'string', ], Ipv4PrefixCount=123, PrivateIpAddresses=[ 'string', ], SecondaryPrivateIpAddressCount=123, AllowReassignment=True|False ) Parameters: * **Ipv4Prefixes** (*list*) -- One or more IPv4 prefixes assigned to the network interface. You can't use this option if you use the "Ipv4PrefixCount" option. * *(string) --* * **Ipv4PrefixCount** (*integer*) -- The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You can't use this option if you use the "Ipv4 Prefixes" option. * **PrivateIpAddresses** (*list*) -- The 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. * *(string) --* * **SecondaryPrivateIpAddressCount** (*integer*) -- The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. * **AllowReassignment** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'NetworkInterfaceId': 'string', 'AssignedPrivateIpAddresses': [ { 'PrivateIpAddress': 'string' }, ], 'AssignedIpv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ] } **Response Structure** * *(dict) --* * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **AssignedPrivateIpAddresses** *(list) --* The private IP addresses assigned to the network interface. * *(dict) --* Describes the private IP addresses assigned to a network interface. * **PrivateIpAddress** *(string) --* The private IP address assigned to the network interface. * **AssignedIpv4Prefixes** *(list) --* The IPv4 prefixes that are assigned to the network interface. * *(dict) --* Describes an IPv4 prefix. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. NetworkInterface / Reference / vpc vpc *** EC2.NetworkInterface.vpc ("Vpc") The related vpc if set, otherwise "None". NetworkInterface / Attribute / ipv6_prefixes ipv6_prefixes ************* EC2.NetworkInterface.ipv6_prefixes * *(list) --* The IPv6 prefixes that are assigned to the network interface. * *(dict) --* Describes the IPv6 prefix. * **Ipv6Prefix** *(string) --* The IPv6 prefix. NetworkInterface / Action / reload reload ****** EC2.NetworkInterface.reload() Calls "EC2.Client.describe_network_interfaces()" to update the attributes of the NetworkInterface resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_interface.reload() Returns: None NetworkInterface / Attribute / private_ip_address private_ip_address ****************** EC2.NetworkInterface.private_ip_address * *(string) --* The IPv4 address of the network interface within the subnet. NetworkInterface / Attribute / connection_tracking_configuration connection_tracking_configuration ********************************* EC2.NetworkInterface.connection_tracking_configuration * *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. NetworkInterface / Attribute / subnet_id subnet_id ********* EC2.NetworkInterface.subnet_id * *(string) --* The ID of the subnet. NetworkInterface / Attribute / operator operator ******** EC2.NetworkInterface.operator * *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. NetworkInterface / Attribute / availability_zone availability_zone ***************** EC2.NetworkInterface.availability_zone * *(string) --* The Availability Zone. NetworkInterface / Attribute / vpc_id vpc_id ****** EC2.NetworkInterface.vpc_id * *(string) --* The ID of the VPC. NetworkInterface / Attribute / status status ****** EC2.NetworkInterface.status * *(string) --* The status of the network interface. NetworkInterface / Identifier / id id ** EC2.NetworkInterface.id *(string)* The NetworkInterface's id identifier. This **must** be set. NetworkInterface / Attribute / owner_id owner_id ******** EC2.NetworkInterface.owner_id * *(string) --* The Amazon Web Services account ID of the owner of the network interface. NetworkInterface / Attribute / deny_all_igw_traffic deny_all_igw_traffic ******************** EC2.NetworkInterface.deny_all_igw_traffic * *(boolean) --* Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is "true", inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks. NetworkInterface / Attribute / description description *********** EC2.NetworkInterface.description * *(string) --* A description. NetworkInterface / Action / attach attach ****** EC2.NetworkInterface.attach(**kwargs) Attaches a network interface to an instance. See also: AWS API Documentation **Request Syntax** response = network_interface.attach( NetworkCardIndex=123, EnaSrdSpecification={ 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, EnaQueueCount=123, DryRun=True|False, InstanceId='string', DeviceIndex=123 ) Parameters: * **NetworkCardIndex** (*integer*) -- 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. * **EnaSrdSpecification** (*dict*) -- Configures ENA Express for the network interface that this action attaches to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** (*integer*) -- The number of ENA queues to be created with the instance. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **DeviceIndex** (*integer*) -- **[REQUIRED]** The index of the device for the network interface attachment. Return type: dict Returns: **Response Syntax** { 'AttachmentId': 'string', 'NetworkCardIndex': 123 } **Response Structure** * *(dict) --* Contains the output of AttachNetworkInterface. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **NetworkCardIndex** *(integer) --* The index of the network card. NetworkInterface / Attribute / public_ip_dns_name_options public_ip_dns_name_options ************************** EC2.NetworkInterface.public_ip_dns_name_options * *(dict) --* Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **DnsHostnameType** *(string) --* The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicIpv4DnsName** *(string) --* An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. * **PublicDualStackDnsName** *(string) --* A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface. NetworkInterface / Attribute / private_dns_name private_dns_name **************** EC2.NetworkInterface.private_dns_name * *(string) --* The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. NetworkInterface / Attribute / public_dns_name public_dns_name *************** EC2.NetworkInterface.public_dns_name * *(string) --* A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. NetworkInterface / Attribute / associated_subnets associated_subnets ****************** EC2.NetworkInterface.associated_subnets * *(list) --* The subnets associated with this network interface. * *(string) --* NetworkInterface / Action / delete delete ****** EC2.NetworkInterface.delete(**kwargs) Deletes the specified network interface. You must detach the network interface before you can delete it. See also: AWS API Documentation **Request Syntax** response = network_interface.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None NetworkInterface / Attribute / interface_type interface_type ************** EC2.NetworkInterface.interface_type * *(string) --* The type of network interface. NetworkInterface / Action / detach detach ****** EC2.NetworkInterface.detach(**kwargs) Detaches a network interface from an instance. See also: AWS API Documentation **Request Syntax** response = network_interface.detach( DryRun=True|False, Force=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*boolean*) -- Specifies whether to force a detachment. Note: * 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. Returns: None NetworkInterface / Attribute / requester_id requester_id ************ EC2.NetworkInterface.requester_id * *(string) --* The alias or Amazon Web Services account ID of the principal or service that created the network interface. KeyPairInfo / Attribute / create_time create_time *********** EC2.KeyPairInfo.create_time * *(datetime) --* If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone. If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone. KeyPairInfo / Action / get_available_subresources get_available_subresources ************************** EC2.KeyPairInfo.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str KeyPairInfo / Attribute / key_fingerprint key_fingerprint *************** EC2.KeyPairInfo.key_fingerprint * *(string) --* If you used CreateKeyPair to create the key pair: * For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. If you used ImportKeyPair to provide Amazon Web Services the public key: * For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. KeyPairInfo / Action / load load **** EC2.KeyPairInfo.load() Calls "EC2.Client.describe_key_pairs()" to update the attributes of the KeyPairInfo resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** key_pair_info.load() Returns: None EC2 / Resource / KeyPairInfo KeyPairInfo *********** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.KeyPairInfo(name) A resource representing an Amazon Elastic Compute Cloud (EC2) KeyPairInfo: import boto3 ec2 = boto3.resource('ec2') key_pair_info = ec2.KeyPairInfo('name') Parameters: **name** (*string*) -- The KeyPairInfo's name identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * name Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * create_time * key_fingerprint * key_name * key_pair_id * key_type * public_key * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * reload KeyPairInfo / Attribute / key_name key_name ******** EC2.KeyPairInfo.key_name * *(string) --* The name of the key pair. KeyPairInfo / Attribute / key_type key_type ******** EC2.KeyPairInfo.key_type * *(string) --* The type of key pair. KeyPairInfo / Identifier / name name **** EC2.KeyPairInfo.name *(string)* The KeyPairInfo's name identifier. This **must** be set. KeyPairInfo / Attribute / public_key public_key ********** EC2.KeyPairInfo.public_key * *(string) --* The public key material. KeyPairInfo / Attribute / key_pair_id key_pair_id *********** EC2.KeyPairInfo.key_pair_id * *(string) --* The ID of the key pair. KeyPairInfo / Action / reload reload ****** EC2.KeyPairInfo.reload() Calls "EC2.Client.describe_key_pairs()" to update the attributes of the KeyPairInfo resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** key_pair_info.reload() Returns: None KeyPairInfo / Attribute / tags tags **** EC2.KeyPairInfo.tags * *(list) --* Any tags applied to the key pair. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. KeyPairInfo / Action / delete delete ****** EC2.KeyPairInfo.delete(**kwargs) Deletes the specified key pair, by removing the public key from Amazon EC2. See also: AWS API Documentation **Request Syntax** response = key_pair_info.delete( KeyPairId='string', DryRun=True|False ) Parameters: * **KeyPairId** (*string*) -- The ID of the key pair. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'KeyPairId': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Is "true" if the request succeeds, and an error otherwise. * **KeyPairId** *(string) --* The ID of the key pair. Route / Identifier / destination_cidr_block destination_cidr_block ********************** EC2.Route.destination_cidr_block *(string)* The Route's destination_cidr_block identifier. This **must** be set. Route / Attribute / egress_only_internet_gateway_id egress_only_internet_gateway_id ******************************* EC2.Route.egress_only_internet_gateway_id * *(string) --* The ID of the egress-only internet gateway. Route / Sub-Resource / RouteTable RouteTable ********** EC2.Route.RouteTable() Creates a RouteTable resource.: route_table = route.RouteTable() Return type: "EC2.RouteTable" Returns: A RouteTable resource Route / Action / get_available_subresources get_available_subresources ************************** EC2.Route.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Route / Attribute / destination_prefix_list_id destination_prefix_list_id ************************** EC2.Route.destination_prefix_list_id * *(string) --* The prefix of the Amazon Web Services service. Route / Attribute / destination_ipv6_cidr_block destination_ipv6_cidr_block *************************** EC2.Route.destination_ipv6_cidr_block * *(string) --* The IPv6 CIDR block used for the destination match. Route / Attribute / origin origin ****** EC2.Route.origin * *(string) --* Describes how the route was created. * "CreateRouteTable" - The route was automatically created when the route table was created. * "CreateRoute" - The route was manually added to the route table. * "EnableVgwRoutePropagation" - The route was propagated by route propagation. Route / Attribute / gateway_id gateway_id ********** EC2.Route.gateway_id * *(string) --* The ID of a gateway attached to your VPC. Route / Attribute / local_gateway_id local_gateway_id **************** EC2.Route.local_gateway_id * *(string) --* The ID of the local gateway. Route / Attribute / instance_id instance_id *********** EC2.Route.instance_id * *(string) --* The ID of a NAT instance in your VPC. Route / Identifier / route_table_id route_table_id ************** EC2.Route.route_table_id *(string)* The Route's route_table_id identifier. This **must** be set. EC2 / Resource / Route Route ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.Route(route_table_id, destination_cidr_block) A resource representing an Amazon Elastic Compute Cloud (EC2) Route: import boto3 ec2 = boto3.resource('ec2') route = ec2.Route('route_table_id','destination_cidr_block') Parameters: * **route_table_id** (*string*) -- The Route's route_table_id identifier. This **must** be set. * **destination_cidr_block** (*string*) -- The Route's destination_cidr_block identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * route_table_id * destination_cidr_block Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * carrier_gateway_id * core_network_arn * destination_ipv6_cidr_block * destination_prefix_list_id * egress_only_internet_gateway_id * gateway_id * instance_id * instance_owner_id * ip_address * local_gateway_id * nat_gateway_id * network_interface_id * odb_network_arn * origin * state * transit_gateway_id * vpc_peering_connection_id Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * replace Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * RouteTable Route / Attribute / vpc_peering_connection_id vpc_peering_connection_id ************************* EC2.Route.vpc_peering_connection_id * *(string) --* The ID of a VPC peering connection. Route / Attribute / nat_gateway_id nat_gateway_id ************** EC2.Route.nat_gateway_id * *(string) --* The ID of a NAT gateway. Route / Attribute / transit_gateway_id transit_gateway_id ****************** EC2.Route.transit_gateway_id * *(string) --* The ID of a transit gateway. Route / Attribute / network_interface_id network_interface_id ******************** EC2.Route.network_interface_id * *(string) --* The ID of the network interface. Route / Attribute / instance_owner_id instance_owner_id ***************** EC2.Route.instance_owner_id * *(string) --* The ID of Amazon Web Services account that owns the instance. Route / Attribute / carrier_gateway_id carrier_gateway_id ****************** EC2.Route.carrier_gateway_id * *(string) --* The ID of the carrier gateway. Route / Attribute / state state ***** EC2.Route.state * *(string) --* The state of the route. The "blackhole" state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). Route / Action / replace replace ******* EC2.Route.replace(**kwargs) Replaces an existing route within a route table in a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = route.replace( DestinationPrefixListId='string', VpcEndpointId='string', LocalTarget=True|False, TransitGatewayId='string', LocalGatewayId='string', CarrierGatewayId='string', CoreNetworkArn='string', OdbNetworkArn='string', DryRun=True|False, GatewayId='string', DestinationIpv6CidrBlock='string', EgressOnlyInternetGatewayId='string', InstanceId='string', NetworkInterfaceId='string', VpcPeeringConnectionId='string', NatGatewayId='string' ) Parameters: * **DestinationPrefixListId** (*string*) -- The ID of the prefix list for the route. * **VpcEndpointId** (*string*) -- The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. * **LocalTarget** (*boolean*) -- Specifies whether to reset the local route to its default target ( "local"). * **TransitGatewayId** (*string*) -- The ID of a transit gateway. * **LocalGatewayId** (*string*) -- The ID of the local gateway. * **CarrierGatewayId** (*string*) -- [IPv4 traffic only] The ID of a carrier gateway. * **CoreNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the core network. * **OdbNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the ODB network. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **GatewayId** (*string*) -- The ID of an internet gateway or virtual private gateway. * **DestinationIpv6CidrBlock** (*string*) -- 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. * **EgressOnlyInternetGatewayId** (*string*) -- [IPv6 traffic only] The ID of an egress-only internet gateway. * **InstanceId** (*string*) -- The ID of a NAT instance in your VPC. * **NetworkInterfaceId** (*string*) -- The ID of a network interface. * **VpcPeeringConnectionId** (*string*) -- The ID of a VPC peering connection. * **NatGatewayId** (*string*) -- [IPv4 traffic only] The ID of a NAT gateway. Returns: None Route / Attribute / odb_network_arn odb_network_arn *************** EC2.Route.odb_network_arn * *(string) --* The Amazon Resource Name (ARN) of the ODB network. Route / Attribute / core_network_arn core_network_arn **************** EC2.Route.core_network_arn * *(string) --* The Amazon Resource Name (ARN) of the core network. Route / Action / delete delete ****** EC2.Route.delete(**kwargs) Deletes the specified route from the specified route table. See also: AWS API Documentation **Request Syntax** response = route.delete( DestinationPrefixListId='string', DryRun=True|False, DestinationIpv6CidrBlock='string' ) Parameters: * **DestinationPrefixListId** (*string*) -- The ID of the prefix list for the route. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **DestinationIpv6CidrBlock** (*string*) -- The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly. Returns: None Route / Attribute / ip_address ip_address ********** EC2.Route.ip_address * *(string) --* The next hop IP address for routes propagated by VPC Route Server into VPC route tables. NetworkAcl / Action / create_entry create_entry ************ EC2.NetworkAcl.create_entry(**kwargs) Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. For more information about network ACLs, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = network_acl.create_entry( DryRun=True|False, RuleNumber=123, Protocol='string', RuleAction='allow'|'deny', Egress=True|False, CidrBlock='string', Ipv6CidrBlock='string', IcmpTypeCode={ 'Code': 123, 'Type': 123 }, PortRange={ 'From': 123, 'To': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RuleNumber** (*integer*) -- **[REQUIRED]** 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. * **Protocol** (*string*) -- **[REQUIRED]** 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. * **RuleAction** (*string*) -- **[REQUIRED]** Indicates whether to allow or deny the traffic that matches the rule. * **Egress** (*boolean*) -- **[REQUIRED]** Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). * **CidrBlock** (*string*) -- 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". * **Ipv6CidrBlock** (*string*) -- The IPv6 network range to allow or deny, in CIDR notation (for example "2001:db8:1234:1a00::/64"). * **IcmpTypeCode** (*dict*) -- ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **PortRange** (*dict*) -- TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. Returns: None NetworkAcl / Attribute / associations associations ************ EC2.NetworkAcl.associations * *(list) --* Any associations between the network ACL and your subnets * *(dict) --* Describes an association between a network ACL and a subnet. * **NetworkAclAssociationId** *(string) --* The ID of the association between a network ACL and a subnet. * **NetworkAclId** *(string) --* The ID of the network ACL. * **SubnetId** *(string) --* The ID of the subnet. NetworkAcl / Action / get_available_subresources get_available_subresources ************************** EC2.NetworkAcl.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str NetworkAcl / Attribute / is_default is_default ********** EC2.NetworkAcl.is_default * *(boolean) --* Indicates whether this is the default network ACL for the VPC. NetworkAcl / Attribute / entries entries ******* EC2.NetworkAcl.entries * *(list) --* The entries (rules) in the network ACL. * *(dict) --* Describes an entry in a network ACL. * **CidrBlock** *(string) --* The IPv4 network range to allow or deny, in CIDR notation. * **Egress** *(boolean) --* Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). * **IcmpTypeCode** *(dict) --* ICMP protocol: The ICMP type and code. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **Ipv6CidrBlock** *(string) --* The IPv6 network range to allow or deny, in CIDR notation. * **PortRange** *(dict) --* TCP or UDP protocols: The range of ports the rule applies to. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol number. A value of "-1" means all protocols. * **RuleAction** *(string) --* Indicates whether to allow or deny the traffic that matches the rule. * **RuleNumber** *(integer) --* The rule number for the entry. ACL entries are processed in ascending order by rule number. NetworkAcl / Action / load load **** EC2.NetworkAcl.load() Calls "EC2.Client.describe_network_acls()" to update the attributes of the NetworkAcl resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_acl.load() Returns: None EC2 / Resource / NetworkAcl NetworkAcl ********** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.NetworkAcl(id) A resource representing an Amazon Elastic Compute Cloud (EC2) NetworkAcl: import boto3 ec2 = boto3.resource('ec2') network_acl = ec2.NetworkAcl('id') Parameters: **id** (*string*) -- The NetworkAcl's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * associations * entries * is_default * network_acl_id * owner_id * tags * vpc_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * vpc Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_entry * create_tags * delete * delete_entry * get_available_subresources * load * reload * replace_association * replace_entry NetworkAcl / Attribute / network_acl_id network_acl_id ************** EC2.NetworkAcl.network_acl_id * *(string) --* The ID of the network ACL. NetworkAcl / Action / create_tags create_tags *********** EC2.NetworkAcl.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = network_acl.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources NetworkAcl / Action / replace_association replace_association ******************* EC2.NetworkAcl.replace_association(**kwargs) Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the *Amazon VPC User Guide*. This is an idempotent operation. See also: AWS API Documentation **Request Syntax** response = network_acl.replace_association( DryRun=True|False, AssociationId='string', ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AssociationId** (*string*) -- **[REQUIRED]** The ID of the current association between the original network ACL and the subnet. Return type: dict Returns: **Response Syntax** { 'NewAssociationId': 'string' } **Response Structure** * *(dict) --* * **NewAssociationId** *(string) --* The ID of the new association. NetworkAcl / Action / replace_entry replace_entry ************* EC2.NetworkAcl.replace_entry(**kwargs) Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = network_acl.replace_entry( DryRun=True|False, RuleNumber=123, Protocol='string', RuleAction='allow'|'deny', Egress=True|False, CidrBlock='string', Ipv6CidrBlock='string', IcmpTypeCode={ 'Code': 123, 'Type': 123 }, PortRange={ 'From': 123, 'To': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RuleNumber** (*integer*) -- **[REQUIRED]** The rule number of the entry to replace. * **Protocol** (*string*) -- **[REQUIRED]** 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. * **RuleAction** (*string*) -- **[REQUIRED]** Indicates whether to allow or deny the traffic that matches the rule. * **Egress** (*boolean*) -- **[REQUIRED]** Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule. * **CidrBlock** (*string*) -- The IPv4 network range to allow or deny, in CIDR notation (for example "172.16.0.0/24"). * **Ipv6CidrBlock** (*string*) -- The IPv6 network range to allow or deny, in CIDR notation (for example "2001:bd8:1234:1a00::/64"). * **IcmpTypeCode** (*dict*) -- ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **PortRange** (*dict*) -- TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. Returns: None NetworkAcl / Reference / vpc vpc *** EC2.NetworkAcl.vpc ("Vpc") The related vpc if set, otherwise "None". NetworkAcl / Action / reload reload ****** EC2.NetworkAcl.reload() Calls "EC2.Client.describe_network_acls()" to update the attributes of the NetworkAcl resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** network_acl.reload() Returns: None NetworkAcl / Attribute / vpc_id vpc_id ****** EC2.NetworkAcl.vpc_id * *(string) --* The ID of the VPC for the network ACL. NetworkAcl / Identifier / id id ** EC2.NetworkAcl.id *(string)* The NetworkAcl's id identifier. This **must** be set. NetworkAcl / Attribute / owner_id owner_id ******** EC2.NetworkAcl.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the network ACL. NetworkAcl / Action / delete_entry delete_entry ************ EC2.NetworkAcl.delete_entry(**kwargs) Deletes the specified ingress or egress entry (rule) from the specified network ACL. See also: AWS API Documentation **Request Syntax** response = network_acl.delete_entry( DryRun=True|False, RuleNumber=123, Egress=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RuleNumber** (*integer*) -- **[REQUIRED]** The rule number of the entry to delete. * **Egress** (*boolean*) -- **[REQUIRED]** Indicates whether the rule is an egress rule. Returns: None NetworkAcl / Attribute / tags tags **** EC2.NetworkAcl.tags * *(list) --* Any tags assigned to the network ACL. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. NetworkAcl / Action / delete delete ****** EC2.NetworkAcl.delete(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = network_acl.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None ClassicAddress / Attribute / network_interface_owner_id network_interface_owner_id ************************** EC2.ClassicAddress.network_interface_owner_id * *(string) --* The ID of the Amazon Web Services account that owns the network interface. ClassicAddress / Attribute / public_ipv4_pool public_ipv4_pool **************** EC2.ClassicAddress.public_ipv4_pool * *(string) --* The ID of an address pool. ClassicAddress / Action / get_available_subresources get_available_subresources ************************** EC2.ClassicAddress.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str ClassicAddress / Attribute / customer_owned_ipv4_pool customer_owned_ipv4_pool ************************ EC2.ClassicAddress.customer_owned_ipv4_pool * *(string) --* The ID of the customer-owned address pool. ClassicAddress / Attribute / domain domain ****** EC2.ClassicAddress.domain * *(string) --* The network ( "vpc"). ClassicAddress / Attribute / allocation_id allocation_id ************* EC2.ClassicAddress.allocation_id * *(string) --* The ID representing the allocation of the address. ClassicAddress / Identifier / public_ip public_ip ********* EC2.ClassicAddress.public_ip *(string)* The ClassicAddress's public_ip identifier. This **must** be set. ClassicAddress / Action / load load **** EC2.ClassicAddress.load() Calls "EC2.Client.describe_addresses()" to update the attributes of the ClassicAddress resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** classic_address.load() Returns: None ClassicAddress / Attribute / instance_id instance_id *********** EC2.ClassicAddress.instance_id * *(string) --* The ID of the instance that the address is associated with (if any). EC2 / Resource / ClassicAddress ClassicAddress ************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.ClassicAddress(public_ip) A resource representing an Amazon Elastic Compute Cloud (EC2) ClassicAddress: import boto3 ec2 = boto3.resource('ec2') classic_address = ec2.ClassicAddress('public_ip') Parameters: **public_ip** (*string*) -- The ClassicAddress's public_ip identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * public_ip Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * allocation_id * association_id * carrier_ip * customer_owned_ip * customer_owned_ipv4_pool * domain * instance_id * network_border_group * network_interface_id * network_interface_owner_id * private_ip_address * public_ipv4_pool * service_managed * subnet_id * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * associate * disassociate * get_available_subresources * load * release * reload ClassicAddress / Attribute / association_id association_id ************** EC2.ClassicAddress.association_id * *(string) --* The ID representing the association of the address with an instance. ClassicAddress / Attribute / customer_owned_ip customer_owned_ip ***************** EC2.ClassicAddress.customer_owned_ip * *(string) --* The customer-owned IP address. ClassicAddress / Attribute / network_interface_id network_interface_id ******************** EC2.ClassicAddress.network_interface_id * *(string) --* The ID of the network interface. ClassicAddress / Action / associate associate ********* EC2.ClassicAddress.associate(**kwargs) Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. You cannot associate an Elastic IP address with an interface in a different network border group. Warning: 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. See also: AWS API Documentation **Request Syntax** response = classic_address.associate( AllocationId='string', InstanceId='string', DryRun=True|False, NetworkInterfaceId='string', PrivateIpAddress='string', AllowReassociation=True|False ) Parameters: * **AllocationId** (*string*) -- The allocation ID. This is required. * **InstanceId** (*string*) -- The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. You can specify either the instance ID or the network interface ID, but not both. * **PrivateIpAddress** (*string*) -- 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. * **AllowReassociation** (*boolean*) -- Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. Return type: dict Returns: **Response Syntax** { 'AssociationId': 'string' } **Response Structure** * *(dict) --* * **AssociationId** *(string) --* The ID that represents the association of the Elastic IP address with an instance. ClassicAddress / Action / release release ******* EC2.ClassicAddress.release(**kwargs) Releases the specified Elastic IP address. [Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it. [Nondefault VPC] You must disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error ( "InvalidIPAddress.InUse"). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an "AuthFailure" error if the address is already allocated to another Amazon Web Services account. After you release an Elastic IP address, you might be able to recover it. For more information, see Release an Elastic IP address. See also: AWS API Documentation **Request Syntax** response = classic_address.release( AllocationId='string', NetworkBorderGroup='string', DryRun=True|False ) Parameters: * **AllocationId** (*string*) -- The allocation ID. This parameter is required. * **NetworkBorderGroup** (*string*) -- The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. If you provide an incorrect network border group, you receive an "InvalidAddress.NotFound" error. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None ClassicAddress / Attribute / network_border_group network_border_group ******************** EC2.ClassicAddress.network_border_group * *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. ClassicAddress / Action / reload reload ****** EC2.ClassicAddress.reload() Calls "EC2.Client.describe_addresses()" to update the attributes of the ClassicAddress resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** classic_address.reload() Returns: None ClassicAddress / Attribute / private_ip_address private_ip_address ****************** EC2.ClassicAddress.private_ip_address * *(string) --* The private IP address associated with the Elastic IP address. ClassicAddress / Attribute / subnet_id subnet_id ********* EC2.ClassicAddress.subnet_id * *(string) --* The ID of the subnet where the IP address is allocated. ClassicAddress / Action / disassociate disassociate ************ EC2.ClassicAddress.disassociate(**kwargs) Disassociates an Elastic IP address from the instance or network interface it's associated with. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. An address cannot be disassociated if the all of the following conditions are met: * Network interface has a "publicDualStackDnsName" publicDnsName * Public IPv4 address is the primary public IPv4 address * Network interface only has one remaining public IPv4 address See also: AWS API Documentation **Request Syntax** response = classic_address.disassociate( AssociationId='string', DryRun=True|False ) Parameters: * **AssociationId** (*string*) -- The association ID. This parameter is required. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None ClassicAddress / Attribute / service_managed service_managed *************** EC2.ClassicAddress.service_managed * *(string) --* The service that manages the elastic IP address. Note: The only option supported today is "alb". ClassicAddress / Attribute / tags tags **** EC2.ClassicAddress.tags * *(list) --* Any tags assigned to the Elastic IP address. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. ClassicAddress / Attribute / carrier_ip carrier_ip ********** EC2.ClassicAddress.carrier_ip * *(string) --* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). InternetGateway / Attribute / attachments attachments *********** EC2.InternetGateway.attachments * *(list) --* Any VPCs attached to the internet gateway. * *(dict) --* Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway. * **State** *(string) --* The current state of the attachment. For an internet gateway, the state is "available" when attached to a VPC; otherwise, this value is not returned. * **VpcId** *(string) --* The ID of the VPC. InternetGateway / Action / get_available_subresources get_available_subresources ************************** EC2.InternetGateway.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str InternetGateway / Attribute / internet_gateway_id internet_gateway_id ******************* EC2.InternetGateway.internet_gateway_id * *(string) --* The ID of the internet gateway. InternetGateway / Action / load load **** EC2.InternetGateway.load() Calls "EC2.Client.describe_internet_gateways()" to update the attributes of the InternetGateway resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** internet_gateway.load() Returns: None EC2 / Resource / InternetGateway InternetGateway *************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.InternetGateway(id) A resource representing an Amazon Elastic Compute Cloud (EC2) InternetGateway: import boto3 ec2 = boto3.resource('ec2') internet_gateway = ec2.InternetGateway('id') Parameters: **id** (*string*) -- The InternetGateway's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * attachments * internet_gateway_id * owner_id * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * attach_to_vpc * create_tags * delete * detach_from_vpc * get_available_subresources * load * reload InternetGateway / Action / detach_from_vpc detach_from_vpc *************** EC2.InternetGateway.detach_from_vpc(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = internet_gateway.detach_from_vpc( DryRun=True|False, VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Returns: None InternetGateway / Action / create_tags create_tags *********** EC2.InternetGateway.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = internet_gateway.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources InternetGateway / Action / reload reload ****** EC2.InternetGateway.reload() Calls "EC2.Client.describe_internet_gateways()" to update the attributes of the InternetGateway resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** internet_gateway.reload() Returns: None InternetGateway / Action / attach_to_vpc attach_to_vpc ************* EC2.InternetGateway.attach_to_vpc(**kwargs) Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = internet_gateway.attach_to_vpc( DryRun=True|False, VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Returns: None InternetGateway / Identifier / id id ** EC2.InternetGateway.id *(string)* The InternetGateway's id identifier. This **must** be set. InternetGateway / Attribute / owner_id owner_id ******** EC2.InternetGateway.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the internet gateway. InternetGateway / Attribute / tags tags **** EC2.InternetGateway.tags * *(list) --* Any tags assigned to the internet gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. InternetGateway / Action / delete delete ****** EC2.InternetGateway.delete(**kwargs) Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. See also: AWS API Documentation **Request Syntax** response = internet_gateway.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None VpcAddress / Attribute / network_interface_owner_id network_interface_owner_id ************************** EC2.VpcAddress.network_interface_owner_id * *(string) --* The ID of the Amazon Web Services account that owns the network interface. VpcAddress / Attribute / public_ipv4_pool public_ipv4_pool **************** EC2.VpcAddress.public_ipv4_pool * *(string) --* The ID of an address pool. VpcAddress / Action / get_available_subresources get_available_subresources ************************** EC2.VpcAddress.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str VpcAddress / Attribute / customer_owned_ipv4_pool customer_owned_ipv4_pool ************************ EC2.VpcAddress.customer_owned_ipv4_pool * *(string) --* The ID of the customer-owned address pool. VpcAddress / Attribute / domain domain ****** EC2.VpcAddress.domain * *(string) --* The network ( "vpc"). VpcAddress / Identifier / allocation_id allocation_id ************* EC2.VpcAddress.allocation_id *(string)* The VpcAddress's allocation_id identifier. This **must** be set. VpcAddress / Attribute / public_ip public_ip ********* EC2.VpcAddress.public_ip * *(string) --* The Elastic IP address. VpcAddress / Action / load load **** EC2.VpcAddress.load() Calls "EC2.Client.describe_addresses()" to update the attributes of the VpcAddress resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc_address.load() Returns: None VpcAddress / Attribute / instance_id instance_id *********** EC2.VpcAddress.instance_id * *(string) --* The ID of the instance that the address is associated with (if any). EC2 / Resource / VpcAddress VpcAddress ********** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.VpcAddress(allocation_id) A resource representing an Amazon Elastic Compute Cloud (EC2) VpcAddress: import boto3 ec2 = boto3.resource('ec2') vpc_address = ec2.VpcAddress('allocation_id') Parameters: **allocation_id** (*string*) -- The VpcAddress's allocation_id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * allocation_id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * association_id * carrier_ip * customer_owned_ip * customer_owned_ipv4_pool * domain * instance_id * network_border_group * network_interface_id * network_interface_owner_id * private_ip_address * public_ip * public_ipv4_pool * service_managed * subnet_id * tags References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * association Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * associate * get_available_subresources * load * release * reload VpcAddress / Attribute / association_id association_id ************** EC2.VpcAddress.association_id * *(string) --* The ID representing the association of the address with an instance. VpcAddress / Attribute / customer_owned_ip customer_owned_ip ***************** EC2.VpcAddress.customer_owned_ip * *(string) --* The customer-owned IP address. VpcAddress / Reference / association association *********** EC2.VpcAddress.association ("NetworkInterfaceAssociation") The related association if set, otherwise "None". VpcAddress / Attribute / network_interface_id network_interface_id ******************** EC2.VpcAddress.network_interface_id * *(string) --* The ID of the network interface. VpcAddress / Action / associate associate ********* EC2.VpcAddress.associate(**kwargs) Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. You cannot associate an Elastic IP address with an interface in a different network border group. Warning: 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. See also: AWS API Documentation **Request Syntax** response = vpc_address.associate( InstanceId='string', PublicIp='string', DryRun=True|False, NetworkInterfaceId='string', PrivateIpAddress='string', AllowReassociation=True|False ) Parameters: * **InstanceId** (*string*) -- The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. * **PublicIp** (*string*) -- Deprecated. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. You can specify either the instance ID or the network interface ID, but not both. * **PrivateIpAddress** (*string*) -- 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. * **AllowReassociation** (*boolean*) -- Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. Return type: dict Returns: **Response Syntax** { 'AssociationId': 'string' } **Response Structure** * *(dict) --* * **AssociationId** *(string) --* The ID that represents the association of the Elastic IP address with an instance. VpcAddress / Action / release release ******* EC2.VpcAddress.release(**kwargs) Releases the specified Elastic IP address. [Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it. [Nondefault VPC] You must disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error ( "InvalidIPAddress.InUse"). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an "AuthFailure" error if the address is already allocated to another Amazon Web Services account. After you release an Elastic IP address, you might be able to recover it. For more information, see Release an Elastic IP address. See also: AWS API Documentation **Request Syntax** response = vpc_address.release( PublicIp='string', NetworkBorderGroup='string', DryRun=True|False ) Parameters: * **PublicIp** (*string*) -- Deprecated. * **NetworkBorderGroup** (*string*) -- The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. If you provide an incorrect network border group, you receive an "InvalidAddress.NotFound" error. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None VpcAddress / Attribute / network_border_group network_border_group ******************** EC2.VpcAddress.network_border_group * *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. VpcAddress / Action / reload reload ****** EC2.VpcAddress.reload() Calls "EC2.Client.describe_addresses()" to update the attributes of the VpcAddress resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc_address.reload() Returns: None VpcAddress / Attribute / private_ip_address private_ip_address ****************** EC2.VpcAddress.private_ip_address * *(string) --* The private IP address associated with the Elastic IP address. VpcAddress / Attribute / subnet_id subnet_id ********* EC2.VpcAddress.subnet_id * *(string) --* The ID of the subnet where the IP address is allocated. VpcAddress / Attribute / service_managed service_managed *************** EC2.VpcAddress.service_managed * *(string) --* The service that manages the elastic IP address. Note: The only option supported today is "alb". VpcAddress / Attribute / tags tags **** EC2.VpcAddress.tags * *(list) --* Any tags assigned to the Elastic IP address. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. VpcAddress / Attribute / carrier_ip carrier_ip ********** EC2.VpcAddress.carrier_ip * *(string) --* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). RouteTableAssociation / Action / replace_subnet replace_subnet ************** EC2.RouteTableAssociation.replace_subnet(**kwargs) Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table. See also: AWS API Documentation **Request Syntax** route_table_association = route_table_association.replace_subnet( DryRun=True|False, RouteTableId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the new route table to associate with the subnet. Return type: "ec2.RouteTableAssociation" Returns: RouteTableAssociation resource RouteTableAssociation / Action / get_available_subresources get_available_subresources ************************** EC2.RouteTableAssociation.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str RouteTableAssociation / Attribute / gateway_id gateway_id ********** EC2.RouteTableAssociation.gateway_id * *(string) --* The ID of the internet gateway or virtual private gateway. RouteTableAssociation / Attribute / route_table_id route_table_id ************** EC2.RouteTableAssociation.route_table_id * *(string) --* The ID of the route table. EC2 / Resource / RouteTableAssociation RouteTableAssociation ********************* Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.RouteTableAssociation(id) A resource representing an Amazon Elastic Compute Cloud (EC2) RouteTableAssociation: import boto3 ec2 = boto3.resource('ec2') route_table_association = ec2.RouteTableAssociation('id') Parameters: **id** (*string*) -- The RouteTableAssociation's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * association_state * gateway_id * main * route_table_association_id * route_table_id * subnet_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * route_table * subnet Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * replace_subnet RouteTableAssociation / Attribute / association_state association_state ***************** EC2.RouteTableAssociation.association_state * *(dict) --* The state of the association. * **State** *(string) --* The state of the association. * **StatusMessage** *(string) --* The status message, if applicable. RouteTableAssociation / Attribute / main main **** EC2.RouteTableAssociation.main * *(boolean) --* Indicates whether this is the main route table. RouteTableAssociation / Attribute / route_table_association_id route_table_association_id ************************** EC2.RouteTableAssociation.route_table_association_id * *(string) --* The ID of the association. RouteTableAssociation / Reference / subnet subnet ****** EC2.RouteTableAssociation.subnet ("Subnet") The related subnet if set, otherwise "None". RouteTableAssociation / Attribute / subnet_id subnet_id ********* EC2.RouteTableAssociation.subnet_id * *(string) --* The ID of the subnet. A subnet ID is not returned for an implicit association. RouteTableAssociation / Identifier / id id ** EC2.RouteTableAssociation.id *(string)* The RouteTableAssociation's id identifier. This **must** be set. RouteTableAssociation / Reference / route_table route_table *********** EC2.RouteTableAssociation.route_table ("RouteTable") The related route_table if set, otherwise "None". RouteTableAssociation / Action / delete delete ****** EC2.RouteTableAssociation.delete(**kwargs) Disassociates a subnet or gateway from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = route_table_association.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None VpcPeeringConnection / Action / get_available_subresources get_available_subresources ************************** EC2.VpcPeeringConnection.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str VpcPeeringConnection / Waiter / wait_until_exists wait_until_exists ***************** EC2.VpcPeeringConnection.wait_until_exists(**kwargs) Waits until this VpcPeeringConnection is exists. This method calls "EC2.Waiter.vpc_peering_connection_exists.wait()" which polls "EC2.Client.describe_vpc_peering_connections()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** vpc_peering_connection.wait_until_exists( NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "accepter-vpc-info.cidr-block" - The IPv4 CIDR block of the accepter VPC. * "accepter-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns 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. * "requester-vpc-info.cidr-block" - The IPv4 CIDR block of the requester's VPC. * "requester-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns the requester VPC. * "requester-vpc-info.vpc-id" - The ID of the requester VPC. * "status-code" - The status of the VPC peering connection ( "pending-acceptance" | "failed" | "expired" | "provisioning" | "active" | "deleting" | "deleted" | "rejected"). * "status-message" - A message that provides more information about the status of the VPC peering connection, if applicable. * "tag" - 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-peering-connection-id" - The ID of the VPC peering connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Returns: None VpcPeeringConnection / Action / load load **** EC2.VpcPeeringConnection.load() Calls "EC2.Client.describe_vpc_peering_connections()" to update the attributes of the VpcPeeringConnection resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc_peering_connection.load() Returns: None EC2 / Resource / VpcPeeringConnection VpcPeeringConnection ******************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.VpcPeeringConnection(id) A resource representing an Amazon Elastic Compute Cloud (EC2) VpcPeeringConnection: import boto3 ec2 = boto3.resource('ec2') vpc_peering_connection = ec2.VpcPeeringConnection('id') Parameters: **id** (*string*) -- The VpcPeeringConnection's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * accepter_vpc_info * expiration_time * requester_vpc_info * status * tags * vpc_peering_connection_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * accepter_vpc * requester_vpc Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * accept * delete * get_available_subresources * load * reject * reload Waiters ======= Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide. These are the resource's available waiters: * wait_until_exists VpcPeeringConnection / Attribute / vpc_peering_connection_id vpc_peering_connection_id ************************* EC2.VpcPeeringConnection.vpc_peering_connection_id * *(string) --* The ID of the VPC peering connection. VpcPeeringConnection / Attribute / accepter_vpc_info accepter_vpc_info ***************** EC2.VpcPeeringConnection.accepter_vpc_info * *(dict) --* Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. VpcPeeringConnection / Attribute / expiration_time expiration_time *************** EC2.VpcPeeringConnection.expiration_time * *(datetime) --* The time that an unaccepted VPC peering connection will expire. VpcPeeringConnection / Reference / accepter_vpc accepter_vpc ************ EC2.VpcPeeringConnection.accepter_vpc ("Vpc") The related accepter_vpc if set, otherwise "None". VpcPeeringConnection / Action / accept accept ****** EC2.VpcPeeringConnection.accept(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = vpc_peering_connection.accept( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VpcPeeringConnection': { 'AccepterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'ExpirationTime': datetime(2015, 1, 1), 'RequesterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'Status': { 'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcPeeringConnectionId': 'string' } } **Response Structure** * *(dict) --* * **VpcPeeringConnection** *(dict) --* Information about the VPC peering connection. * **AccepterVpcInfo** *(dict) --* Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **ExpirationTime** *(datetime) --* The time that an unaccepted VPC peering connection will expire. * **RequesterVpcInfo** *(dict) --* Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **Status** *(dict) --* The status of the VPC peering connection. * **Code** *(string) --* The status of the VPC peering connection. * **Message** *(string) --* A message that provides more information about the status, if applicable. * **Tags** *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection. VpcPeeringConnection / Action / reload reload ****** EC2.VpcPeeringConnection.reload() Calls "EC2.Client.describe_vpc_peering_connections()" to update the attributes of the VpcPeeringConnection resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc_peering_connection.reload() Returns: None VpcPeeringConnection / Attribute / requester_vpc_info requester_vpc_info ****************** EC2.VpcPeeringConnection.requester_vpc_info * *(dict) --* Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. VpcPeeringConnection / Action / reject reject ****** EC2.VpcPeeringConnection.reject(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = vpc_peering_connection.reject( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. VpcPeeringConnection / Attribute / status status ****** EC2.VpcPeeringConnection.status * *(dict) --* The status of the VPC peering connection. * **Code** *(string) --* The status of the VPC peering connection. * **Message** *(string) --* A message that provides more information about the status, if applicable. VpcPeeringConnection / Identifier / id id ** EC2.VpcPeeringConnection.id *(string)* The VpcPeeringConnection's id identifier. This **must** be set. VpcPeeringConnection / Attribute / tags tags **** EC2.VpcPeeringConnection.tags * *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. VpcPeeringConnection / Action / delete delete ****** EC2.VpcPeeringConnection.delete(**kwargs) Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the "active" state. The owner of the requester VPC can delete a VPC peering connection in the "pending- acceptance" state. You cannot delete a VPC peering connection that's in the "failed" or "rejected" state. See also: AWS API Documentation **Request Syntax** response = vpc_peering_connection.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. VpcPeeringConnection / Reference / requester_vpc requester_vpc ************* EC2.VpcPeeringConnection.requester_vpc ("Vpc") The related requester_vpc if set, otherwise "None". Image / Attribute / source_image_region source_image_region ******************* EC2.Image.source_image_region * *(string) --* The Region of the source AMI. Image / Attribute / deprecation_time deprecation_time **************** EC2.Image.deprecation_time * *(string) --* The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Returns: None Image / Attribute / source_instance_id source_instance_id ****************** EC2.Image.source_instance_id * *(string) --* The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage. Image / Action / load load **** EC2.Image.load() Calls "EC2.Client.describe_images()" to update the attributes of the Image resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** image.load() Returns: None EC2 / Resource / Image Image ***** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.Image(id) A resource representing an Amazon Elastic Compute Cloud (EC2) Image: import boto3 ec2 = boto3.resource('ec2') image = ec2.Image('id') Parameters: **id** (*string*) -- The Image's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * architecture * block_device_mappings * boot_mode * creation_date * deprecation_time * deregistration_protection * description * ena_support * free_tier_eligible * hypervisor * image_allowed * image_id * image_location * image_owner_alias * image_type * imds_support * kernel_id * last_launched_time * name * owner_id * platform * platform_details * product_codes * public * ramdisk_id * root_device_name * root_device_type * source_image_id * source_image_region * source_instance_id * sriov_net_support * state * state_reason * tags * tpm_support * usage_operation * virtualization_type Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_tags * deregister * describe_attribute * get_available_subresources * load * modify_attribute * reload * reset_attribute Waiters ======= Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide. These are the resource's available waiters: * wait_until_exists Image / Attribute / creation_date creation_date ************* EC2.Image.creation_date * *(string) --* The date and time the image was created. Image / Attribute / source_image_id source_image_id *************** EC2.Image.source_image_id * *(string) --* The ID of the source AMI from which the AMI was created. Image / Attribute / platform_details platform_details **************** EC2.Image.platform_details * *(string) --* The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the *Amazon EC2 User Guide*. Image / Action / create_tags create_tags *********** EC2.Image.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = image.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources Image / Action / reset_attribute reset_attribute *************** EC2.Image.reset_attribute(**kwargs) Resets an attribute of an AMI to its default value. See also: AWS API Documentation **Request Syntax** response = image.reset_attribute( Attribute='launchPermission', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The attribute to reset (currently you can only reset the launch permission attribute). * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Image / Attribute / name name **** EC2.Image.name * *(string) --* The name of the AMI that was provided during image creation. Image / Attribute / image_id image_id ******** EC2.Image.image_id * *(string) --* The ID of the AMI. Image / Attribute / image_location image_location ************** EC2.Image.image_location * *(string) --* The location of the AMI. Image / Attribute / state_reason state_reason ************ EC2.Image.state_reason * *(dict) --* The reason for the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. Image / Attribute / usage_operation usage_operation *************** EC2.Image.usage_operation * *(string) --* The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. "usageOperation" corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the **Instances** or **AMIs** pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI. Image / Action / reload reload ****** EC2.Image.reload() Calls "EC2.Client.describe_images()" to update the attributes of the Image resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** image.reload() Returns: None Image / Attribute / architecture architecture ************ EC2.Image.architecture * *(string) --* The architecture of the image. Image / Attribute / root_device_type root_device_type **************** EC2.Image.root_device_type * *(string) --* The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume. Image / Attribute / product_codes product_codes ************* EC2.Image.product_codes * *(list) --* Any product codes associated with the AMI. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. Image / Attribute / state state ***** EC2.Image.state * *(string) --* The current state of the AMI. If the state is "available", the image is successfully registered and can be used to launch an instance. Image / Action / deregister deregister ********** EC2.Image.deregister(**kwargs) Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances. If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin in the *Amazon EBS User Guide*. When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered. Deregistering an AMI does not delete the following: * Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them. * For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs. * For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs. For more information, see Deregister an Amazon EC2 AMI in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = image.deregister( DeleteAssociatedSnapshots=True|False, DryRun=True|False ) Parameters: * **DeleteAssociatedSnapshots** (*boolean*) -- Specifies whether to delete the snapshots associated with the AMI during deregistration. Note: If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting. Default: The snapshots are not deleted. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'DeleteSnapshotResults': [ { 'SnapshotId': 'string', 'ReturnCode': 'success'|'skipped'|'missing-permissions'|'internal-error'|'client-error' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. * **DeleteSnapshotResults** *(list) --* The deletion result for each snapshot associated with the AMI, including the snapshot ID and its success or error code. * *(dict) --* The snapshot ID and its deletion result code. * **SnapshotId** *(string) --* The ID of the snapshot. * **ReturnCode** *(string) --* The result code from the snapshot deletion attempt. Possible values: * "success" - The snapshot was successfully deleted. * "skipped" - The snapshot was not deleted because it's associated with other AMIs. * "missing-permissions" - The snapshot was not deleted because the role lacks "DeleteSnapshot" permissions. For more information, see How Amazon EBS works with IAM. * "internal-error" - The snapshot was not deleted due to a server error. * "client-error" - The snapshot was not deleted due to a client configuration error. For details about an error, check the "DeleteSnapshot" event in the CloudTrail event history. For more information, see View event history in the *Amazon Web Services CloudTrail User Guide*. Image / Identifier / id id ** EC2.Image.id *(string)* The Image's id identifier. This **must** be set. Image / Attribute / hypervisor hypervisor ********** EC2.Image.hypervisor * *(string) --* The hypervisor type of the image. Only "xen" is supported. "ovm" is not supported. Image / Attribute / owner_id owner_id ******** EC2.Image.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the image. Image / Attribute / description description *********** EC2.Image.description * *(string) --* The description of the AMI that was provided during image creation. Image / Attribute / block_device_mappings block_device_mappings ********************* EC2.Image.block_device_mappings * *(list) --* Any block device mapping entries. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. Image / Attribute / tags tags **** EC2.Image.tags * *(list) --* Any tags assigned to the image. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Image / Attribute / image_type image_type ********** EC2.Image.image_type * *(string) --* The type of image. Image / Attribute / ramdisk_id ramdisk_id ********** EC2.Image.ramdisk_id * *(string) --* The RAM disk associated with the image, if any. Only applicable for machine images. Image / Attribute / free_tier_eligible free_tier_eligible ****************** EC2.Image.free_tier_eligible * *(boolean) --* Indicates whether the image is eligible for Amazon Web Services Free Tier. * If "true", the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits. * If "false", the AMI is not eligible for Free Tier. Image / Attribute / virtualization_type virtualization_type ******************* EC2.Image.virtualization_type * *(string) --* The type of virtualization of the AMI. Image / Attribute / image_owner_alias image_owner_alias ***************** EC2.Image.image_owner_alias * *(string) --* The owner alias ( "amazon" | "aws-backup-vault" | "aws- marketplace"). DhcpOptions / Action / get_available_subresources get_available_subresources ************************** EC2.DhcpOptions.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str DhcpOptions / Attribute / dhcp_options_id dhcp_options_id *************** EC2.DhcpOptions.dhcp_options_id * *(string) --* The ID of the set of DHCP options. DhcpOptions / Action / load load **** EC2.DhcpOptions.load() Calls "EC2.Client.describe_dhcp_options()" to update the attributes of the DhcpOptions resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** dhcp_options.load() Returns: None EC2 / Resource / DhcpOptions DhcpOptions *********** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.DhcpOptions(id) A resource representing an Amazon Elastic Compute Cloud (EC2) DhcpOptions: import boto3 ec2 = boto3.resource('ec2') dhcp_options = ec2.DhcpOptions('id') Parameters: **id** (*string*) -- The DhcpOptions's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * dhcp_configurations * dhcp_options_id * owner_id * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * associate_with_vpc * create_tags * delete * get_available_subresources * load * reload DhcpOptions / Action / create_tags create_tags *********** EC2.DhcpOptions.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = dhcp_options.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources DhcpOptions / Action / associate_with_vpc associate_with_vpc ****************** EC2.DhcpOptions.associate_with_vpc(**kwargs) Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. For more information, see DHCP option sets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = dhcp_options.associate_with_vpc( VpcId='string', DryRun=True|False ) Parameters: * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None DhcpOptions / Action / reload reload ****** EC2.DhcpOptions.reload() Calls "EC2.Client.describe_dhcp_options()" to update the attributes of the DhcpOptions resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** dhcp_options.reload() Returns: None DhcpOptions / Attribute / dhcp_configurations dhcp_configurations ******************* EC2.DhcpOptions.dhcp_configurations * *(list) --* The DHCP options in the set. * *(dict) --* Describes a DHCP configuration option. * **Key** *(string) --* The name of a DHCP option. * **Values** *(list) --* The values for the DHCP option. * *(dict) --* Describes a value for a resource attribute that is a String. * **Value** *(string) --* The attribute value. The value is case-sensitive. DhcpOptions / Identifier / id id ** EC2.DhcpOptions.id *(string)* The DhcpOptions's id identifier. This **must** be set. DhcpOptions / Attribute / owner_id owner_id ******** EC2.DhcpOptions.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the DHCP options set. DhcpOptions / Attribute / tags tags **** EC2.DhcpOptions.tags * *(list) --* Any tags assigned to the DHCP options set. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. DhcpOptions / Action / delete delete ****** EC2.DhcpOptions.delete(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = dhcp_options.delete( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None KeyPair / Action / get_available_subresources get_available_subresources ************************** EC2.KeyPair.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str KeyPair / Attribute / key_fingerprint key_fingerprint *************** EC2.KeyPair.key_fingerprint * *(string) --* * For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. EC2 / Resource / KeyPair KeyPair ******* Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.KeyPair(name) A resource representing an Amazon Elastic Compute Cloud (EC2) KeyPair: import boto3 ec2 = boto3.resource('ec2') key_pair = ec2.KeyPair('name') Parameters: **name** (*string*) -- The KeyPair's name identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * name Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * key_fingerprint * key_material * key_name * key_pair_id * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources KeyPair / Attribute / key_name key_name ******** EC2.KeyPair.key_name * *(string) --* The name of the key pair. KeyPair / Attribute / key_material key_material ************ EC2.KeyPair.key_material * *(string) --* An unencrypted PEM encoded RSA or ED25519 private key. KeyPair / Identifier / name name **** EC2.KeyPair.name *(string)* The KeyPair's name identifier. This **must** be set. KeyPair / Attribute / key_pair_id key_pair_id *********** EC2.KeyPair.key_pair_id * *(string) --* The ID of the key pair. KeyPair / Attribute / tags tags **** EC2.KeyPair.tags * *(list) --* Any tags applied to the key pair. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. KeyPair / Action / delete delete ****** EC2.KeyPair.delete(**kwargs) Deletes the specified key pair, by removing the public key from Amazon EC2. See also: AWS API Documentation **Request Syntax** response = key_pair.delete( KeyPairId='string', DryRun=True|False ) Parameters: * **KeyPairId** (*string*) -- The ID of the key pair. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'KeyPairId': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Is "true" if the request succeeds, and an error otherwise. * **KeyPairId** *(string) --* The ID of the key pair. EC2 / Waiter / InstanceTerminated InstanceTerminated ****************** class EC2.Waiter.InstanceTerminated waiter = client.get_waiter('instance_terminated') wait(**kwargs) Polls "EC2.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned- ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer-owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name- dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network- interface.addresses.private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpcPeeringConnectionExists VpcPeeringConnectionExists ************************** class EC2.Waiter.VpcPeeringConnectionExists waiter = client.get_waiter('vpc_peering_connection_exists') wait(**kwargs) Polls "EC2.Client.describe_vpc_peering_connections()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( NextToken='string', MaxResults=123, DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* * **Filters** (*list*) -- The filters. * "accepter-vpc-info.cidr-block" - The IPv4 CIDR block of the accepter VPC. * "accepter-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns 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. * "requester-vpc-info.cidr-block" - The IPv4 CIDR block of the requester's VPC. * "requester-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns the requester VPC. * "requester-vpc-info.vpc-id" - The ID of the requester VPC. * "status-code" - The status of the VPC peering connection ( "pending-acceptance" | "failed" | "expired" | "provisioning" | "active" | "deleting" | "deleted" | "rejected"). * "status-message" - A message that provides more information about the status of the VPC peering connection, if applicable. * "tag" - 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-peering-connection-id" - The ID of the VPC peering connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / StoreImageTaskComplete StoreImageTaskComplete ********************** class EC2.Waiter.StoreImageTaskComplete waiter = client.get_waiter('store_image_task_complete') wait(**kwargs) Polls "EC2.Client.describe_store_image_tasks()" every 5 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ImageIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ImageIds** (*list*) -- The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. Note: When you specify the "ImageIds" parameter, any filters that you specify are ignored. To use the filters, you must remove the "ImageIds" parameter. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the "ImageIds" parameter in the same call. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpcExists VpcExists ********* class EC2.Waiter.VpcExists waiter = client.get_waiter('vpc_exists') wait(**kwargs) Polls "EC2.Client.describe_vpcs()" every 1 seconds until a successful state is reached. An error is raised after 5 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpcIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpcIds** (*list*) -- The IDs of the VPCs. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 1 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 5 Returns: None EC2 / Waiter / SpotInstanceRequestFulfilled SpotInstanceRequestFulfilled **************************** class EC2.Waiter.SpotInstanceRequestFulfilled waiter = client.get_waiter('spot_instance_request_fulfilled') wait(**kwargs) Polls "EC2.Client.describe_spot_instance_requests()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( NextToken='string', MaxResults=123, DryRun=True|False, SpotInstanceRequestIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotInstanceRequestIds** (*list*) -- The IDs of the Spot Instance requests. * *(string) --* * **Filters** (*list*) -- The 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" or "gp3" for General Purpose SSD, "io1" or "io2" for Provisioned IOPS SSD, "st1" for Throughput Optimized HDD, "sc1" for 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*. * "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:" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / NatGatewayAvailable NatGatewayAvailable ******************* class EC2.Waiter.NatGatewayAvailable waiter = client.get_waiter('nat_gateway_available') wait(**kwargs) Polls "EC2.Client.describe_nat_gateways()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NatGatewayIds=[ 'string', ], NextToken='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "nat-gateway-id" - The ID of the NAT gateway. * "state" - The state of the NAT gateway ( "pending" | "failed" | "available" | "deleting" | "deleted"). * "subnet-id" - The ID of the subnet in which the NAT gateway resides. * "tag" - 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 in which the NAT gateway resides. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NatGatewayIds** (*list*) -- The IDs of the NAT gateways. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / ImageAvailable ImageAvailable ************** class EC2.Waiter.ImageAvailable waiter = client.get_waiter('image_available') wait(**kwargs) Polls "EC2.Client.describe_images()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ExecutableUsers=[ 'string', ], ImageIds=[ 'string', ], Owners=[ 'string', ], IncludeDeprecated=True|False, IncludeDisabled=True|False, MaxResults=123, NextToken='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ExecutableUsers** (*list*) -- Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, "self" (the sender of the request), or "all" (public AMIs). * If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned. * If you specify "self" or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned. * If you specify "all", all public AMIs are returned. * *(string) --* * **ImageIds** (*list*) -- The image IDs. Default: Describes all images available to you. * *(string) --* * **Owners** (*list*) -- Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", "amazon", "aws-backup-vault", and "aws- marketplace". If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. * *(string) --* * **IncludeDeprecated** (*boolean*) -- Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. Note: If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. * **IncludeDisabled** (*boolean*) -- Specifies whether to include disabled AMIs. Default: No disabled AMIs are included in the response. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "architecture" - The image architecture ( "i386" | "x86_64" | "arm64" | "x86_64_mac" | "arm64_mac"). * "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 Amazon EBS volume. * "block-device-mapping.volume-size" - The volume size of the Amazon EBS volume, in GiB. * "block-device-mapping.volume-type" - The volume type of the Amazon EBS volume ( "io1" | "io2" | "gp2" | "gp3" | "sc1 ``| ``st1" | "standard"). * "block-device-mapping.encrypted" - A Boolean that indicates whether the Amazon EBS volume is encrypted. * "creation-date" - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "description" - The description of the image (provided during image creation). * "ena-support" - A Boolean that indicates whether enhanced networking with ENA is enabled. * "free-tier-eligible" - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier ( "true" | "false"). * "hypervisor" - The hypervisor type ( "ovm" | "xen"). * "image-allowed" - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. * "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-backup- vault" | "aws-marketplace"). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the **Owner** request parameter instead of this filter. * "platform" - The platform. The only supported value is "windows". * "product-code" - The product code. * "product-code.type" - The type of the product code ( "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"). * "source-image-id" - The ID of the source AMI from which the AMI was created. * "source-image-region" - The Region of the source AMI. * "source-instance-id" - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. * "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:" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / ExportTaskCompleted ExportTaskCompleted ******************* class EC2.Waiter.ExportTaskCompleted waiter = client.get_waiter('export_task_completed') wait(**kwargs) Polls "EC2.Client.describe_export_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ExportTaskIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- the filters for the export tasks. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ExportTaskIds** (*list*) -- The export task IDs. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SecurityGroupVpcAssociationDisassociated SecurityGroupVpcAssociationDisassociated **************************************** class EC2.Waiter.SecurityGroupVpcAssociationDisassociated waiter = client.get_waiter('security_group_vpc_association_disassociated') wait(**kwargs) Polls "EC2.Client.describe_security_group_vpc_associations()" every 10 seconds until a successful state is reached. An error is raised after 7 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- Security group VPC association filters. * "group-id": The security group ID. * "group-owner-id": The group owner ID. * "vpc-id": The ID of the associated VPC. * "vpc-owner-id": The account ID of the VPC owner. * "state": The state of the association. * "tag:": 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 7 Returns: None EC2 / Waiter / InternetGatewayExists InternetGatewayExists ********************* class EC2.Waiter.InternetGatewayExists waiter = client.get_waiter('internet_gateway_exists') wait(**kwargs) Polls "EC2.Client.describe_internet_gateways()" every 5 seconds until a successful state is reached. An error is raised after 6 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( NextToken='string', MaxResults=123, DryRun=True|False, InternetGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InternetGatewayIds** (*list*) -- The IDs of the internet gateways. Default: Describes all your internet gateways. * *(string) --* * **Filters** (*list*) -- The 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 Amazon Web Services account that owns the internet gateway. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 6 Returns: None EC2 / Waiter / ImageExists ImageExists *********** class EC2.Waiter.ImageExists waiter = client.get_waiter('image_exists') wait(**kwargs) Polls "EC2.Client.describe_images()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ExecutableUsers=[ 'string', ], ImageIds=[ 'string', ], Owners=[ 'string', ], IncludeDeprecated=True|False, IncludeDisabled=True|False, MaxResults=123, NextToken='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ExecutableUsers** (*list*) -- Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, "self" (the sender of the request), or "all" (public AMIs). * If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned. * If you specify "self" or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned. * If you specify "all", all public AMIs are returned. * *(string) --* * **ImageIds** (*list*) -- The image IDs. Default: Describes all images available to you. * *(string) --* * **Owners** (*list*) -- Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", "amazon", "aws-backup-vault", and "aws- marketplace". If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. * *(string) --* * **IncludeDeprecated** (*boolean*) -- Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. Note: If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. * **IncludeDisabled** (*boolean*) -- Specifies whether to include disabled AMIs. Default: No disabled AMIs are included in the response. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "architecture" - The image architecture ( "i386" | "x86_64" | "arm64" | "x86_64_mac" | "arm64_mac"). * "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 Amazon EBS volume. * "block-device-mapping.volume-size" - The volume size of the Amazon EBS volume, in GiB. * "block-device-mapping.volume-type" - The volume type of the Amazon EBS volume ( "io1" | "io2" | "gp2" | "gp3" | "sc1 ``| ``st1" | "standard"). * "block-device-mapping.encrypted" - A Boolean that indicates whether the Amazon EBS volume is encrypted. * "creation-date" - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "description" - The description of the image (provided during image creation). * "ena-support" - A Boolean that indicates whether enhanced networking with ENA is enabled. * "free-tier-eligible" - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier ( "true" | "false"). * "hypervisor" - The hypervisor type ( "ovm" | "xen"). * "image-allowed" - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. * "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-backup- vault" | "aws-marketplace"). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the **Owner** request parameter instead of this filter. * "platform" - The platform. The only supported value is "windows". * "product-code" - The product code. * "product-code.type" - The type of the product code ( "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"). * "source-image-id" - The ID of the source AMI from which the AMI was created. * "source-image-region" - The Region of the source AMI. * "source-instance-id" - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. * "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:" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SnapshotCompleted SnapshotCompleted ***************** class EC2.Waiter.SnapshotCompleted waiter = client.get_waiter('snapshot_completed') wait(**kwargs) Polls "EC2.Client.describe_snapshots()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( MaxResults=123, NextToken='string', OwnerIds=[ 'string', ], RestorableByUserIds=[ 'string', ], SnapshotIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **OwnerIds** (*list*) -- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", and "amazon". * *(string) --* * **RestorableByUserIds** (*list*) -- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. * *(string) --* * **SnapshotIds** (*list*) -- The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. * "owner-id" - The Amazon Web Services 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"). * "storage-tier" - The storage tier of the snapshot ( "archive" | "standard"). * "transfer-type" - The type of operation used to create the snapshot ( "time-based" | "standard"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / CustomerGatewayAvailable CustomerGatewayAvailable ************************ class EC2.Waiter.CustomerGatewayAvailable waiter = client.get_waiter('customer_gateway_available') wait(**kwargs) Polls "EC2.Client.describe_customer_gateways()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( CustomerGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **CustomerGatewayIds** (*list*) -- One or more customer gateway IDs. Default: Describes all your customer gateways. * *(string) --* * **Filters** (*list*) -- 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 device's 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VolumeInUse VolumeInUse *********** class EC2.Waiter.VolumeInUse waiter = client.get_waiter('volume_in_use') wait(**kwargs) Polls "EC2.Client.describe_volumes()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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") * "fast-restored" - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( "true" | "false"). * "multi-attach-enabled" - Indicates whether the volume is enabled for Multi-Attach ( "true" | "false") * "operator.managed" - A Boolean that indicates whether this is a managed volume. * "operator.principal" - The principal that manages the volume. Only valid for managed volumes, where "managed" is "true". * "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": - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SecurityGroupExists SecurityGroupExists ******************* class EC2.Waiter.SecurityGroupExists waiter = client.get_waiter('security_group_exists') wait(**kwargs) Polls "EC2.Client.describe_security_groups()" every 5 seconds until a successful state is reached. An error is raised after 6 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( GroupIds=[ 'string', ], GroupNames=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **GroupIds** (*list*) -- The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all of your security groups. * *(string) --* * **GroupNames** (*list*) -- [Default VPC] The names of the security groups. You can specify either the security group name or the security group ID. Default: Describes all of your security groups. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services 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 Amazon Web Services account that has been referenced in an inbound security group rule. * "owner-id" - The Amazon Web Services account ID of the owner of the security group. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 6 Returns: None EC2 / Waiter / ConversionTaskCompleted ConversionTaskCompleted *********************** class EC2.Waiter.ConversionTaskCompleted waiter = client.get_waiter('conversion_task_completed') wait(**kwargs) Polls "EC2.Client.describe_conversion_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, ConversionTaskIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConversionTaskIds** (*list*) -- The conversion task IDs. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VolumeAvailable VolumeAvailable *************** class EC2.Waiter.VolumeAvailable waiter = client.get_waiter('volume_available') wait(**kwargs) Polls "EC2.Client.describe_volumes()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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") * "fast-restored" - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( "true" | "false"). * "multi-attach-enabled" - Indicates whether the volume is enabled for Multi-Attach ( "true" | "false") * "operator.managed" - A Boolean that indicates whether this is a managed volume. * "operator.principal" - The principal that manages the volume. Only valid for managed volumes, where "managed" is "true". * "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": - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / PasswordDataAvailable PasswordDataAvailable ********************* class EC2.Waiter.PasswordDataAvailable waiter = client.get_waiter('password_data_available') wait(**kwargs) Polls "EC2.Client.get_password_data()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceId='string', DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the Windows instance. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpnConnectionAvailable VpnConnectionAvailable ********************** class EC2.Waiter.VpnConnectionAvailable waiter = client.get_waiter('vpn_connection_available') wait(**kwargs) Polls "EC2.Client.describe_vpn_connections()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpnConnectionIds=[ 'string', ], DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- 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": - 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". * "vpn-connection-id" - The ID of the VPN connection. * "vpn-gateway-id" - The ID of a virtual private gateway associated with the VPN connection. * "transit-gateway-id" - The ID of a transit gateway associated with the VPN connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpnConnectionIds** (*list*) -- One or more VPN connection IDs. Default: Describes your VPN connections. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SystemStatusOk SystemStatusOk ************** class EC2.Waiter.SystemStatusOk waiter = client.get_waiter('system_status_ok') wait(**kwargs) Polls "EC2.Client.describe_instance_status()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], MaxResults=123, NextToken='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IncludeAllInstances=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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"). * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "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"). * "attached-ebs-status.status" - The status of the attached EBS volume for the instance ( "ok" | "impaired" | "initializing" | "insufficient-data" | "not-applicable"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IncludeAllInstances** (*boolean*) -- When "true", includes the health status for all instances. When "false", includes the health status for running instances only. Default: "false" * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SubnetAvailable SubnetAvailable *************** class EC2.Waiter.SubnetAvailable waiter = client.get_waiter('subnet_available') wait(**kwargs) Polls "EC2.Client.describe_subnets()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SubnetIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- The 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. * "customer-owned-ipv4-pool" - The customer-owned IPv4 address pool associated with the subnet. * "default-for-az" - Indicates whether this is the default subnet for the Availability Zone ( "true" | "false"). You can also use "defaultForAz" as the filter name. * "enable-dns64" - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. * "enable-lni-at-device-index" - Indicates the device position for local network interfaces in this subnet. For example, "1" indicates local network interfaces in this subnet are the secondary network interface (eth1). * "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. * "ipv6-native" - Indicates whether this is an IPv6 only subnet ( "true" | "false"). * "map-customer-owned-ip-on-launch" - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. * "map-public-ip-on-launch" - Indicates whether instances launched in this subnet receive a public IPv4 address. * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The ID of the Amazon Web Services account that owns the subnet. * "private-dns-name-options-on-launch.hostname-type" - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name). * "private-dns-name-options-on-launch.enable-resource-name- dns-a-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options-on-launch.enable-resource-name- dns-aaaa-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "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" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SubnetIds** (*list*) -- The IDs of the subnets. Default: Describes all your subnets. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / NatGatewayDeleted NatGatewayDeleted ***************** class EC2.Waiter.NatGatewayDeleted waiter = client.get_waiter('nat_gateway_deleted') wait(**kwargs) Polls "EC2.Client.describe_nat_gateways()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NatGatewayIds=[ 'string', ], NextToken='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "nat-gateway-id" - The ID of the NAT gateway. * "state" - The state of the NAT gateway ( "pending" | "failed" | "available" | "deleting" | "deleted"). * "subnet-id" - The ID of the subnet in which the NAT gateway resides. * "tag" - 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 in which the NAT gateway resides. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NatGatewayIds** (*list*) -- The IDs of the NAT gateways. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpnConnectionDeleted VpnConnectionDeleted ******************** class EC2.Waiter.VpnConnectionDeleted waiter = client.get_waiter('vpn_connection_deleted') wait(**kwargs) Polls "EC2.Client.describe_vpn_connections()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpnConnectionIds=[ 'string', ], DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- 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": - 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". * "vpn-connection-id" - The ID of the VPN connection. * "vpn-gateway-id" - The ID of a virtual private gateway associated with the VPN connection. * "transit-gateway-id" - The ID of a transit gateway associated with the VPN connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpnConnectionIds** (*list*) -- One or more VPN connection IDs. Default: Describes your VPN connections. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / InstanceStopped InstanceStopped *************** class EC2.Waiter.InstanceStopped waiter = client.get_waiter('instance_stopped') wait(**kwargs) Polls "EC2.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned- ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer-owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name- dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network- interface.addresses.private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / InstanceExists InstanceExists ************** class EC2.Waiter.InstanceExists waiter = client.get_waiter('instance_exists') wait(**kwargs) Polls "EC2.Client.describe_instances()" every 5 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned- ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer-owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name- dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network- interface.addresses.private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpcPeeringConnectionDeleted VpcPeeringConnectionDeleted *************************** class EC2.Waiter.VpcPeeringConnectionDeleted waiter = client.get_waiter('vpc_peering_connection_deleted') wait(**kwargs) Polls "EC2.Client.describe_vpc_peering_connections()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( NextToken='string', MaxResults=123, DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* * **Filters** (*list*) -- The filters. * "accepter-vpc-info.cidr-block" - The IPv4 CIDR block of the accepter VPC. * "accepter-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns 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. * "requester-vpc-info.cidr-block" - The IPv4 CIDR block of the requester's VPC. * "requester-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns the requester VPC. * "requester-vpc-info.vpc-id" - The ID of the requester VPC. * "status-code" - The status of the VPC peering connection ( "pending-acceptance" | "failed" | "expired" | "provisioning" | "active" | "deleting" | "deleted" | "rejected"). * "status-message" - A message that provides more information about the status of the VPC peering connection, if applicable. * "tag" - 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-peering-connection-id" - The ID of the VPC peering connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / ConversionTaskCancelled ConversionTaskCancelled *********************** class EC2.Waiter.ConversionTaskCancelled waiter = client.get_waiter('conversion_task_cancelled') wait(**kwargs) Polls "EC2.Client.describe_conversion_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, ConversionTaskIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConversionTaskIds** (*list*) -- The conversion task IDs. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VpcAvailable VpcAvailable ************ class EC2.Waiter.VpcAvailable waiter = client.get_waiter('vpc_available') wait(**kwargs) Polls "EC2.Client.describe_vpcs()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpcIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpcIds** (*list*) -- The IDs of the VPCs. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / SecurityGroupVpcAssociationAssociated SecurityGroupVpcAssociationAssociated ************************************* class EC2.Waiter.SecurityGroupVpcAssociationAssociated waiter = client.get_waiter('security_group_vpc_association_associated') wait(**kwargs) Polls "EC2.Client.describe_security_group_vpc_associations()" every 10 seconds until a successful state is reached. An error is raised after 7 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, DryRun=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- Security group VPC association filters. * "group-id": The security group ID. * "group-owner-id": The group owner ID. * "vpc-id": The ID of the associated VPC. * "vpc-owner-id": The account ID of the VPC owner. * "state": The state of the association. * "tag:": 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 7 Returns: None EC2 / Waiter / InstanceStatusOk InstanceStatusOk **************** class EC2.Waiter.InstanceStatusOk waiter = client.get_waiter('instance_status_ok') wait(**kwargs) Polls "EC2.Client.describe_instance_status()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], MaxResults=123, NextToken='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IncludeAllInstances=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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"). * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "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"). * "attached-ebs-status.status" - The status of the attached EBS volume for the instance ( "ok" | "impaired" | "initializing" | "insufficient-data" | "not-applicable"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IncludeAllInstances** (*boolean*) -- When "true", includes the health status for all instances. When "false", includes the health status for running instances only. Default: "false" * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / NetworkInterfaceAvailable NetworkInterfaceAvailable ************************* class EC2.Waiter.NetworkInterfaceAvailable waiter = client.get_waiter('network_interface_available') wait(**kwargs) Polls "EC2.Client.describe_network_interfaces()" every 20 seconds until a successful state is reached. An error is raised after 10 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( NextToken='string', MaxResults=123, DryRun=True|False, NetworkInterfaceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkInterfaceIds** (*list*) -- The network interface IDs. Default: Describes all your network interfaces. * *(string) --* * **Filters** (*list*) -- One or more filters. * "association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "addresses.association.owner-id" - The owner ID of the addresses 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.primary" - Whether the private IPv4 address is the primary IP address associated with the network interface. * "addresses.private-ip-address" - The private IPv4 addresses associated with the 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.attach-time" - The time that the network interface was attached to an instance. * "attachment.attachment-id" - The ID of the interface attachment. * "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. * "ipv6-addresses.ipv6-address" - An IPv6 address associated with the network interface. * "interface-type" - The type of network interface ( "api_gateway_managed" | "aws_codestar_connections_managed" | "branch" | "ec2_instance_connect_endpoint" | "efa" | "efa-only" | "efs" | "evs" | "gateway_load_balancer" | "gateway_load_balancer_endpoint" | "global_accelerator_managed" | "interface" | "iot_rules_managed" | "lambda" | "load_balancer" | "nat_gateway" | "network_load_balancer" | "quicksight" | "transit_gateway" | "trunk" | "vpc_endpoint"). * "mac-address" - The MAC address of the network interface. * "network-interface-id" - The ID of the network interface. * "operator.managed" - A Boolean that indicates whether this is a managed network interface. * "operator.principal" - The principal that manages the network interface. Only valid for managed network interfaces, where "managed" is "true". * "owner-id" - The Amazon Web Services account ID of the network interface owner. * "private-dns-name" - The private DNS name of the network interface (IPv4). * "private-ip-address" - The private IPv4 address or addresses of the network interface. * "requester-id" - The alias or Amazon Web Services account ID of the principal or service that created the network interface. * "requester-managed" - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 20 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 10 Returns: None EC2 / Waiter / InstanceRunning InstanceRunning *************** class EC2.Waiter.InstanceRunning waiter = client.get_waiter('instance_running') wait(**kwargs) Polls "EC2.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned- ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer-owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name- dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network- interface.addresses.private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / VolumeDeleted VolumeDeleted ************* class EC2.Waiter.VolumeDeleted waiter = client.get_waiter('volume_deleted') wait(**kwargs) Polls "EC2.Client.describe_volumes()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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") * "fast-restored" - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( "true" | "false"). * "multi-attach-enabled" - Indicates whether the volume is enabled for Multi-Attach ( "true" | "false") * "operator.managed" - A Boolean that indicates whether this is a managed volume. * "operator.principal" - The principal that manages the volume. Only valid for managed volumes, where "managed" is "true". * "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": - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / ConversionTaskDeleted ConversionTaskDeleted ********************* class EC2.Waiter.ConversionTaskDeleted waiter = client.get_waiter('conversion_task_deleted') wait(**kwargs) Polls "EC2.Client.describe_conversion_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, ConversionTaskIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConversionTaskIds** (*list*) -- The conversion task IDs. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / KeyPairExists KeyPairExists ************* class EC2.Waiter.KeyPairExists waiter = client.get_waiter('key_pair_exists') wait(**kwargs) Polls "EC2.Client.describe_key_pairs()" every 5 seconds until a successful state is reached. An error is raised after 6 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( KeyNames=[ 'string', ], KeyPairIds=[ 'string', ], IncludePublicKey=True|False, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **KeyNames** (*list*) -- The key pair names. Default: Describes all of your key pairs. * *(string) --* * **KeyPairIds** (*list*) -- The IDs of the key pairs. * *(string) --* * **IncludePublicKey** (*boolean*) -- If "true", the public key material is included in the response. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 5 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 6 Returns: None EC2 / Waiter / SnapshotImported SnapshotImported **************** class EC2.Waiter.SnapshotImported waiter = client.get_waiter('snapshot_imported') wait(**kwargs) Polls "EC2.Client.describe_import_snapshot_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ImportTaskIds=[ 'string', ], MaxResults=123, NextToken='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ImportTaskIds** (*list*) -- A list of import snapshot task IDs. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- A token that indicates the next page of results. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / ExportTaskCancelled ExportTaskCancelled ******************* class EC2.Waiter.ExportTaskCancelled waiter = client.get_waiter('export_task_cancelled') wait(**kwargs) Polls "EC2.Client.describe_export_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ExportTaskIds=[ 'string', ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Filters** (*list*) -- the filters for the export tasks. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ExportTaskIds** (*list*) -- The export task IDs. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None EC2 / Waiter / BundleTaskComplete BundleTaskComplete ****************** class EC2.Waiter.BundleTaskComplete waiter = client.get_waiter('bundle_task_complete') wait(**kwargs) Polls "EC2.Client.describe_bundle_tasks()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( BundleIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **BundleIds** (*list*) -- The bundle task IDs. Default: Describes all your bundle tasks. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None Instance / Attribute / ebs_optimized ebs_optimized ************* EC2.Instance.ebs_optimized * *(boolean) --* 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 I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Instance / Action / describe_attribute describe_attribute ****************** EC2.Instance.describe_attribute(**kwargs) Describes the specified attribute of the specified instance. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = instance.describe_attribute( DryRun=True|False, Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Attribute** (*string*) -- **[REQUIRED]** The instance attribute. Note that the "enaSupport" attribute is not supported. Return type: dict Returns: **Response Syntax** { 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'Ebs': { 'AttachTime': datetime(2015, 1, 1), 'DeleteOnTermination': True|False, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'VolumeId': 'string', 'AssociatedResource': 'string', 'VolumeOwnerId': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' } } }, ], 'DisableApiTermination': { 'Value': True|False }, 'EnaSupport': { 'Value': True|False }, 'EnclaveOptions': { 'Enabled': True|False }, 'EbsOptimized': { 'Value': True|False }, 'InstanceId': 'string', 'InstanceInitiatedShutdownBehavior': { 'Value': 'string' }, 'InstanceType': { 'Value': 'string' }, 'KernelId': { 'Value': 'string' }, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'RamdiskId': { 'Value': 'string' }, 'RootDeviceName': { 'Value': 'string' }, 'SourceDestCheck': { 'Value': True|False }, 'SriovNetSupport': { 'Value': 'string' }, 'UserData': { 'Value': 'string' }, 'DisableApiStop': { 'Value': True|False }, 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ] } **Response Structure** * *(dict) --* Describes an instance attribute. * **BlockDeviceMappings** *(list) --* The block device mapping of the instance. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Status** *(string) --* The attachment state. * **VolumeId** *(string) --* The ID of the EBS volume. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **VolumeOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the volume. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **Operator** *(dict) --* The service provider that manages the EBS volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **DisableApiTermination** *(dict) --* Indicates whether termination protection is enabled. If the value is "true", you can't terminate the instance using the Amazon EC2 console, command line tools, or API. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnaSupport** *(dict) --* Indicates whether enhanced networking with ENA is enabled. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **EbsOptimized** *(dict) --* Indicates whether the instance is optimized for Amazon EBS I/O. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **InstanceId** *(string) --* The ID of the instance. * **InstanceInitiatedShutdownBehavior** *(dict) --* Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). * **Value** *(string) --* The attribute value. The value is case-sensitive. * **InstanceType** *(dict) --* The instance type. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **KernelId** *(dict) --* The kernel ID. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **ProductCodes** *(list) --* The product codes. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **RamdiskId** *(dict) --* The RAM disk ID. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **RootDeviceName** *(dict) --* The device name of the root device volume (for example, "/dev/sda1"). * **Value** *(string) --* The attribute value. The value is case-sensitive. * **SourceDestCheck** *(dict) --* Indicates whether source/destination checks are enabled. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **SriovNetSupport** *(dict) --* Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **UserData** *(dict) --* The user data. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **DisableApiStop** *(dict) --* Indicates whether stop protection is enabled for the instance. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **Groups** *(list) --* The security groups associated with the instance. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. Instance / Attribute / instance_lifecycle instance_lifecycle ****************** EC2.Instance.instance_lifecycle * *(string) --* Indicates whether this is a Spot Instance or a Scheduled Instance. Instance / Attribute / capacity_block_id capacity_block_id ***************** EC2.Instance.capacity_block_id * *(string) --* The ID of the Capacity Block. Note: For P5 instances, a Capacity Block ID refers to a group of instances. For Trn2u instances, a capacity block ID refers to an EC2 UltraServer. Instance / Attribute / security_groups security_groups *************** EC2.Instance.security_groups * *(list) --* The security groups for the instance. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. Instance / Attribute / usage_operation_update_time usage_operation_update_time *************************** EC2.Instance.usage_operation_update_time * *(datetime) --* The time that the usage operation was last updated. Instance / Action / get_available_subresources get_available_subresources ************************** EC2.Instance.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Instance / Action / reset_source_dest_check reset_source_dest_check *********************** EC2.Instance.reset_source_dest_check(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = instance.reset_source_dest_check( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Instance / Attribute / tpm_support tpm_support *********** EC2.Instance.tpm_support * *(string) --* If the instance is configured for NitroTPM support, the value is "v2.0". For more information, see NitroTPM in the *Amazon EC2 User Guide*. Instance / Waiter / wait_until_stopped wait_until_stopped ****************** EC2.Instance.wait_until_stopped(**kwargs) Waits until this Instance is stopped. This method calls "EC2.Waiter.instance_stopped.wait()" which polls "EC2.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** instance.wait_until_stopped( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer- owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name-dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network-interface.addresses .private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Returns: None Instance / Attribute / monitoring monitoring ********** EC2.Instance.monitoring * *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Instance / Attribute / source_dest_check source_dest_check ***************** EC2.Instance.source_dest_check * *(boolean) --* Indicates whether source/destination checking is enabled. Instance / Attribute / platform platform ******** EC2.Instance.platform * *(string) --* The platform. This value is "windows" for Windows instances; otherwise, it is empty. Instance / Attribute / ena_support ena_support *********** EC2.Instance.ena_support * *(boolean) --* Specifies whether enhanced networking with ENA is enabled. Instance / Attribute / boot_mode boot_mode ********* EC2.Instance.boot_mode * *(string) --* The boot mode that was specified by the AMI. If the value is "uefi-preferred", the AMI supports both UEFI and Legacy BIOS. The "currentInstanceBootMode" parameter is the boot mode that is used to boot the instance at launch or start. Note: The operating system contained in the AMI must be configured to support the specified boot mode. For more information, see Boot modes in the *Amazon EC2 User Guide*. Instance / Attribute / launch_time launch_time *********** EC2.Instance.launch_time * *(datetime) --* The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface. Instance / Attribute / kernel_id kernel_id ********* EC2.Instance.kernel_id * *(string) --* The kernel associated with this instance, if applicable. Instance / Attribute / sriov_net_support sriov_net_support ***************** EC2.Instance.sriov_net_support * *(string) --* Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. Instance / Attribute / root_device_name root_device_name **************** EC2.Instance.root_device_name * *(string) --* The device name of the root device volume (for example, "/dev/sda1"). Instance / Reference / placement_group placement_group *************** EC2.Instance.placement_group ("PlacementGroup") The related placement_group if set, otherwise "None". Instance / Attribute / outpost_arn outpost_arn *********** EC2.Instance.outpost_arn * *(string) --* The Amazon Resource Name (ARN) of the Outpost. Instance / Action / modify_attribute modify_attribute **************** EC2.Instance.modify_attribute(**kwargs) Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. >>**<>**<" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Returns: None Instance / Action / attach_volume attach_volume ************* EC2.Instance.attach_volume(**kwargs) Attaches an Amazon EBS volume to a "running" or "stopped" instance, and exposes it to the instance with the specified device name. Note: The maximum number of Amazon EBS volumes that you can attach to an instance depends on the instance type. If you exceed the volume attachment limit for an instance type, the attachment request fails with the "AttachmentLimitExceeded" error. For more information, see Instance volume limits. After you attach an EBS volume, you must make it available for use. For more information, see Make an EBS volume available for use. If a volume has an Amazon Web Services Marketplace product code: * The volume can be attached only to a stopped instance. * Amazon Web Services Marketplace product codes are copied from the volume to the instance. * You must be subscribed to the product. * The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information, see Attach an Amazon EBS volume to an instance in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.attach_volume( Device='string', VolumeId='string', DryRun=True|False ) Parameters: * **Device** (*string*) -- **[REQUIRED]** The device name (for example, "/dev/sdh" or "xvdh"). * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the EBS volume. The volume and instance must be within the same Availability Zone. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. Instance / Collection / volumes volumes ******* EC2.Instance.volumes A collection of Volume resources.A Volume Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Volume resources in the collection. See also: AWS API Documentation **Request Syntax** volume_iterator = instance.volumes.all() Return type: list("ec2.Volume") Returns: A list of Volume resources filter(**kwargs) Creates an iterable of all Volume resources in the collection filtered by kwargs passed to method. A Volume collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** volume_iterator = instance.volumes.filter( VolumeIds=[ 'string', ], DryRun=True|False, NextToken='string', MaxResults=123 ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Return type: list("ec2.Volume") Returns: A list of Volume resources limit(**kwargs) Creates an iterable up to a specified amount of Volume resources in the collection. See also: AWS API Documentation **Request Syntax** volume_iterator = instance.volumes.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Volume") Returns: A list of Volume resources page_size(**kwargs) Creates an iterable of all Volume resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** volume_iterator = instance.volumes.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Volume") Returns: A list of Volume resources Instance / Attribute / ipv6_address ipv6_address ************ EC2.Instance.ipv6_address * *(string) --* The IPv6 address assigned to the instance. Instance / Waiter / wait_until_exists wait_until_exists ***************** EC2.Instance.wait_until_exists(**kwargs) Waits until this Instance is exists. This method calls "EC2.Waiter.instance_exists.wait()" which polls "EC2.Client.describe_instances()" every 5 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** instance.wait_until_exists( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer- owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name-dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network-interface.addresses .private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Returns: None Instance / Attribute / iam_instance_profile iam_instance_profile ******************** EC2.Instance.iam_instance_profile * *(dict) --* The IAM instance profile associated with the instance, if applicable. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. Instance / Action / report_status report_status ************* EC2.Instance.report_status(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = instance.report_status( DryRun=True|False, Status='ok'|'impaired', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), ReasonCodes=[ 'instance-stuck-in-state'|'unresponsive'|'not-accepting-credentials'|'password-not-available'|'performance-network'|'performance-instance-store'|'performance-ebs-volume'|'performance-other'|'other', ], Description='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Status** (*string*) -- **[REQUIRED]** The status of all instances listed. * **StartTime** (*datetime*) -- The time at which the reported instance health state began. * **EndTime** (*datetime*) -- The time at which the reported instance health state ended. * **ReasonCodes** (*list*) -- **[REQUIRED]** 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] * *(string) --* * **Description** (*string*) -- Descriptive text about the health state of your instance. Returns: None Instance / Action / stop stop **** EC2.Instance.stop(**kwargs) Stops an Amazon EBS-backed instance. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can use the StopInstances operation together with the "Hibernate" parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. If your instance appears stuck in the "stopping" state, there might be an issue with the underlying host computer. You can use the StopInstances operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per- second billing. You can't stop or hibernate instance store-backed instances. See also: AWS API Documentation **Request Syntax** response = instance.stop( Hibernate=True|False, SkipOsShutdown=True|False, DryRun=True|False, Force=True|False ) Parameters: * **Hibernate** (*boolean*) -- 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 Amazon EC2 instance in the *Amazon EC2 User Guide*. Default: "false" * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is stopped. Warning: Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*boolean*) -- Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Default: "false" Return type: dict Returns: **Response Syntax** { 'StoppingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StoppingInstances** *(list) --* Information about the stopped instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. Instance / Action / load load **** EC2.Instance.load() Calls "EC2.Client.describe_instances()" to update the attributes of the Instance resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** instance.load() Returns: None Instance / Attribute / instance_id instance_id *********** EC2.Instance.instance_id * *(string) --* The ID of the instance. Instance / Action / detach_volume detach_volume ************* EC2.Instance.detach_volume(**kwargs) Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the "busy" state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance. You can't detach or force detach volumes that are attached to Amazon Web Services-managed resources. Attempting to do this results in the "UnsupportedOperationException" exception. For more information, see Detach an Amazon EBS volume in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.detach_volume( Device='string', Force=True|False, VolumeId='string', DryRun=True|False ) Parameters: * **Device** (*string*) -- The device name. * **Force** (*boolean*) -- 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. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the volume. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. EC2 / Resource / Instance Instance ******** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.Instance(id) A resource representing an Amazon Elastic Compute Cloud (EC2) Instance: import boto3 ec2 = boto3.resource('ec2') instance = ec2.Instance('id') Parameters: **id** (*string*) -- The Instance's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * ami_launch_index * architecture * block_device_mappings * boot_mode * capacity_block_id * capacity_reservation_id * capacity_reservation_specification * client_token * cpu_options * current_instance_boot_mode * ebs_optimized * elastic_gpu_associations * elastic_inference_accelerator_associations * ena_support * enclave_options * hibernation_options * hypervisor * iam_instance_profile * image_id * instance_id * instance_lifecycle * instance_type * ipv6_address * kernel_id * key_name * launch_time * licenses * maintenance_options * metadata_options * monitoring * network_interfaces_attribute * network_performance_options * operator * outpost_arn * placement * platform * platform_details * private_dns_name * private_dns_name_options * private_ip_address * product_codes * public_dns_name * public_ip_address * ramdisk_id * root_device_name * root_device_type * security_groups * source_dest_check * spot_instance_request_id * sriov_net_support * state * state_reason * state_transition_reason * subnet_id * tags * tpm_support * usage_operation * usage_operation_update_time * virtualization_type * vpc_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * classic_address * image * key_pair * network_interfaces * placement_group * subnet * vpc Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * attach_classic_link_vpc * attach_volume * console_output * create_image * create_tags * delete_tags * describe_attribute * detach_classic_link_vpc * detach_volume * get_available_subresources * load * modify_attribute * monitor * password_data * reboot * reload * report_status * reset_attribute * reset_kernel * reset_ramdisk * reset_source_dest_check * start * stop * terminate * unmonitor Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * volumes * vpc_addresses Waiters ======= Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide. These are the resource's available waiters: * wait_until_exists * wait_until_running * wait_until_stopped * wait_until_terminated Instance / Attribute / spot_instance_request_id spot_instance_request_id ************************ EC2.Instance.spot_instance_request_id * *(string) --* If the request is a Spot Instance request, the ID of the request. Instance / Action / unmonitor unmonitor ********* EC2.Instance.unmonitor(**kwargs) Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.unmonitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Instance / Action / reboot reboot ****** EC2.Instance.reboot(**kwargs) Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Troubleshoot an unreachable instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.reboot( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Instance / Waiter / wait_until_running wait_until_running ****************** EC2.Instance.wait_until_running(**kwargs) Waits until this Instance is running. This method calls "EC2.Waiter.instance_running.wait()" which polls "EC2.Client.describe_instances()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** instance.wait_until_running( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer- owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name-dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network-interface.addresses .private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Returns: None Instance / Reference / network_interfaces network_interfaces ****************** EC2.Instance.network_interfaces ("NetworkInterface") The related network_interfaces if set, otherwise "None". Instance / Attribute / key_name key_name ******** EC2.Instance.key_name * *(string) --* The name of the key pair, if this instance was launched with an associated key pair. Instance / Attribute / platform_details platform_details **************** EC2.Instance.platform_details * *(string) --* The platform details value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. Instance / Action / create_image create_image ************ EC2.Instance.create_image(**kwargs) Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: * If the source instance is in a Region, you must create the snapshots in the same Region as the instance. * If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. For more information, see Create an Amazon EBS-backed AMI in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** image = instance.create_image( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], SnapshotLocation='regional'|'local', DryRun=True|False, Name='string', Description='string', NoReboot=True|False, BlockDeviceMappings=[ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ] ) Parameters: * **TagSpecifications** (*list*) -- 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 Amazon 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SnapshotLocation** (*string*) -- Note: Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter. The Amazon S3 location where the snapshots will be stored. * To create local snapshots in the same Local Zone as the source instance, specify "local". * To create regional snapshots in the parent Region of the Local Zone, specify "regional" or omit this parameter. Default: "regional" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) * **Description** (*string*) -- A description for the new image. * **NoReboot** (*boolean*) -- Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values: * "true" - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots. * "false" - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created. Default: "false" * **BlockDeviceMappings** (*list*) -- The block device mappings. When using the CreateImage action: * You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance. * You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), copy the image instead. * The only option that can be changed for existing mappings or snapshots is "DeleteOnTermination". * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. Return type: "ec2.Image" Returns: Image resource Instance / Collection / vpc_addresses vpc_addresses ************* EC2.Instance.vpc_addresses A collection of VpcAddress resources.A VpcAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all VpcAddress resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = instance.vpc_addresses.all() Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources filter(**kwargs) Creates an iterable of all VpcAddress resources in the collection filtered by kwargs passed to method. A VpcAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = instance.vpc_addresses.filter( PublicIps=[ 'string', ], DryRun=True|False, AllocationIds=[ 'string', ] ) Parameters: * **PublicIps** (*list*) -- One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AllocationIds** (*list*) -- Information about the allocation IDs. * *(string) --* Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources limit(**kwargs) Creates an iterable up to a specified amount of VpcAddress resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = instance.vpc_addresses.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources page_size(**kwargs) Creates an iterable of all VpcAddress resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = instance.vpc_addresses.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources Instance / Attribute / capacity_reservation_id capacity_reservation_id *********************** EC2.Instance.capacity_reservation_id * *(string) --* The ID of the Capacity Reservation. Instance / Attribute / elastic_inference_accelerator_associations elastic_inference_accelerator_associations ****************************************** EC2.Instance.elastic_inference_accelerator_associations * *(list) --* Deprecated Note: Amazon Elastic Inference is no longer available. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes the association between an instance and an elastic inference accelerator. * **ElasticInferenceAcceleratorArn** *(string) --* The Amazon Resource Name (ARN) of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationId** *(string) --* The ID of the association. * **ElasticInferenceAcceleratorAssociationState** *(string) --* The state of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationTime** *(datetime) --* The time at which the elastic inference accelerator is associated with an instance. Instance / Action / create_tags create_tags *********** EC2.Instance.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = instance.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources Instance / Action / reset_attribute reset_attribute *************** EC2.Instance.reset_attribute(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = instance.reset_attribute( DryRun=True|False, Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Attribute** (*string*) -- **[REQUIRED]** The attribute to reset. Warning: You can only reset the following attributes: "kernel" | "ramdisk" | "sourceDestCheck". Returns: None Instance / Attribute / enclave_options enclave_options *************** EC2.Instance.enclave_options * *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. Instance / Reference / classic_address classic_address *************** EC2.Instance.classic_address ("ClassicAddress") The related classic_address if set, otherwise "None". Instance / Attribute / network_interfaces_attribute network_interfaces_attribute **************************** EC2.Instance.network_interfaces_attribute * *(list) --* The network interfaces for the instance. * *(dict) --* Describes a network interface. * **Association** *(dict) --* The association information for an Elastic IPv4 associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Attachment** *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The index of the device on the instance for the network interface attachment. * **Status** *(string) --* The attachment state. * **NetworkCardIndex** *(integer) --* The index of the network card. * **EnaSrdSpecification** *(dict) --* Contains the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **Description** *(string) --* The description. * **Groups** *(list) --* The security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **Ipv6Addresses** *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **MacAddress** *(string) --* The MAC address. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that created the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes a private IPv4 address. * **Association** *(dict) --* The association information for an Elastic IP address for the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IP address of the network interface. * **PrivateDnsName** *(string) --* The private IPv4 DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **Status** *(string) --* The status of the network interface. * **SubnetId** *(string) --* The ID of the subnet. * **VpcId** *(string) --* The ID of the VPC. * **InterfaceType** *(string) --* The type of network interface. Valid values: "interface" | "efa" | "efa-only" | "evs" | "trunk" * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv4 prefix. * **Ipv4Prefix** *(string) --* One or more IPv4 prefixes assigned to the network interface. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv6 prefix. * **Ipv6Prefix** *(string) --* One or more IPv6 prefixes assigned to the network interface. * **ConnectionTrackingConfiguration** *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request- response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Operator** *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. Instance / Attribute / elastic_gpu_associations elastic_gpu_associations ************************ EC2.Instance.elastic_gpu_associations * *(list) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. Describes the association between an instance and an Elastic Graphics accelerator. * **ElasticGpuId** *(string) --* The ID of the Elastic Graphics accelerator. * **ElasticGpuAssociationId** *(string) --* The ID of the association. * **ElasticGpuAssociationState** *(string) --* The state of the association between the instance and the Elastic Graphics accelerator. * **ElasticGpuAssociationTime** *(string) --* The time the Elastic Graphics accelerator was associated with the instance. Instance / Action / detach_classic_link_vpc detach_classic_link_vpc *********************** EC2.Instance.detach_classic_link_vpc(**kwargs) Note: This action is deprecated. 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. See also: AWS API Documentation **Request Syntax** response = instance.detach_classic_link_vpc( DryRun=True|False, VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC to which the instance is linked. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Instance / Attribute / image_id image_id ******** EC2.Instance.image_id * *(string) --* The ID of the AMI used to launch the instance. Instance / Reference / subnet subnet ****** EC2.Instance.subnet ("Subnet") The related subnet if set, otherwise "None". Instance / Attribute / state_reason state_reason ************ EC2.Instance.state_reason * *(dict) --* The reason for the most recent state transition. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. Instance / Action / attach_classic_link_vpc attach_classic_link_vpc *********************** EC2.Instance.attach_classic_link_vpc(**kwargs) Note: This action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the "running" state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as *attaching* your instance. See also: AWS API Documentation **Request Syntax** response = instance.attach_classic_link_vpc( DryRun=True|False, VpcId='string', Groups=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the ClassicLink-enabled VPC. * **Groups** (*list*) -- **[REQUIRED]** The IDs of the security groups. You cannot specify security groups from a different VPC. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Instance / Reference / vpc vpc *** EC2.Instance.vpc ("Vpc") The related vpc if set, otherwise "None". Instance / Attribute / capacity_reservation_specification capacity_reservation_specification ********************************** EC2.Instance.capacity_reservation_specification * *(dict) --* Information about the Capacity Reservation targeting option. * **CapacityReservationPreference** *(string) --* Describes the instance's Capacity Reservation preferences. Possible preferences include: * "open" - The instance can run in any "open" Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * "none" - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. * **CapacityReservationTarget** *(dict) --* Information about the targeted Capacity Reservation or Capacity Reservation group. * **CapacityReservationId** *(string) --* The ID of the targeted Capacity Reservation. * **CapacityReservationResourceGroupArn** *(string) --* The ARN of the targeted Capacity Reservation group. Instance / Attribute / usage_operation usage_operation *************** EC2.Instance.usage_operation * *(string) --* The usage operation value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. Instance / Action / reload reload ****** EC2.Instance.reload() Calls "EC2.Client.describe_instances()" to update the attributes of the Instance resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** instance.reload() Returns: None Instance / Action / terminate terminate ********* EC2.Instance.terminate(**kwargs) Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results: * The specified instances that are in the same Availability Zone as the protected instance are not terminated. * The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated. For example, say you have the following instances: * Instance A: "us-east-1a"; Not protected * Instance B: "us-east-1a"; Not protected * Instance C: "us-east-1b"; Protected * Instance D: "us-east-1b"; not protected If you attempt to terminate all of these instances in the same request, the request reports failure with the following results: * Instance A and Instance B are successfully terminated because none of the specified instances in "us-east-1a" are enabled for termination protection. * Instance C and Instance D fail to terminate because at least one of the specified instances in "us-east-1b" (Instance C) is enabled for termination protection. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. By default, the TerminateInstances operation includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the "DeleteOnTermination" block device mapping parameter set to "true" are automatically deleted. For more information about the differences between stopping and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and Troubleshooting terminating your instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.terminate( Force=True|False, SkipOsShutdown=True|False, DryRun=True|False ) Parameters: * **Force** (*boolean*) -- Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is terminated. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TerminatingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **TerminatingInstances** *(list) --* Information about the terminated instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. Instance / Attribute / private_ip_address private_ip_address ****************** EC2.Instance.private_ip_address * *(string) --* The private IPv4 address assigned to the instance. Instance / Action / reset_kernel reset_kernel ************ EC2.Instance.reset_kernel(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = instance.reset_kernel( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Instance / Attribute / architecture architecture ************ EC2.Instance.architecture * *(string) --* The architecture of the image. Instance / Action / delete_tags delete_tags *********** EC2.Instance.delete_tags(**kwargs) Deletes the specified set of tags from the specified set of resources. To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.delete_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- 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 Amazon Web Services-generated tags (tags that have the "aws:" prefix). Constraints: Up to 1000 tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None Instance / Attribute / hibernation_options hibernation_options ******************* EC2.Instance.hibernation_options * *(dict) --* Indicates whether the instance is enabled for hibernation. * **Configured** *(boolean) --* If "true", your instance is enabled for hibernation; otherwise, it is not enabled for hibernation. Instance / Attribute / cpu_options cpu_options *********** EC2.Instance.cpu_options * *(dict) --* The CPU options for the instance. * **CoreCount** *(integer) --* The number of CPU cores for the instance. * **ThreadsPerCore** *(integer) --* The number of threads per CPU core. * **AmdSevSnp** *(string) --* Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP. Instance / Action / start start ***** EC2.Instance.start(**kwargs) Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. If you attempt to start a T3 instance with "host" tenancy and the "unlimited" CPU credit option, the request fails. The "unlimited" CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to "standard", or change its tenancy to "default" or "dedicated". For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.start( AdditionalInfo='string', DryRun=True|False ) Parameters: * **AdditionalInfo** (*string*) -- Reserved. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'StartingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StartingInstances** *(list) --* Information about the started instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. Instance / Reference / key_pair key_pair ******** EC2.Instance.key_pair ("KeyPairInfo") The related key_pair if set, otherwise "None". Instance / Reference / image image ***** EC2.Instance.image ("Image") The related image if set, otherwise "None". Instance / Attribute / root_device_type root_device_type **************** EC2.Instance.root_device_type * *(string) --* The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. Instance / Attribute / subnet_id subnet_id ********* EC2.Instance.subnet_id * *(string) --* The ID of the subnet in which the instance is running. Instance / Action / monitor monitor ******* EC2.Instance.monitor(**kwargs) Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the *Amazon EC2 User Guide*. To disable detailed monitoring, see UnmonitorInstances. See also: AWS API Documentation **Request Syntax** response = instance.monitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Instance / Attribute / metadata_options metadata_options **************** EC2.Instance.metadata_options * *(dict) --* The metadata options for the instance. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. * "required" - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. * **HttpPutResponseHopLimit** *(integer) --* The maximum number of hops that the metadata token can travel. Possible values: Integers from "1" to "64" * **HttpEndpoint** *(string) --* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is "disabled", you cannot access your instance metadata. * **HttpProtocolIpv6** *(string) --* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Default: "disabled" * **InstanceMetadataTags** *(string) --* Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata. Instance / Attribute / product_codes product_codes ************* EC2.Instance.product_codes * *(list) --* The product codes attached to this instance, if applicable. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. Instance / Attribute / operator operator ******** EC2.Instance.operator * *(dict) --* The service provider that manages the instance. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. Instance / Attribute / client_token client_token ************ EC2.Instance.client_token * *(string) --* The idempotency token you provided when you launched the instance, if applicable. Instance / Action / reset_ramdisk reset_ramdisk ************* EC2.Instance.reset_ramdisk(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = instance.reset_ramdisk( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Instance / Attribute / network_performance_options network_performance_options *************************** EC2.Instance.network_performance_options * *(dict) --* Contains settings for the network performance options for your instance. * **BandwidthWeighting** *(string) --* When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type. Instance / Attribute / state state ***** EC2.Instance.state * *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. Instance / Attribute / vpc_id vpc_id ****** EC2.Instance.vpc_id * *(string) --* The ID of the VPC in which the instance is running. Instance / Attribute / state_transition_reason state_transition_reason *********************** EC2.Instance.state_transition_reason * *(string) --* The reason for the most recent state transition. This might be an empty string. Instance / Identifier / id id ** EC2.Instance.id *(string)* The Instance's id identifier. This **must** be set. Instance / Attribute / hypervisor hypervisor ********** EC2.Instance.hypervisor * *(string) --* The hypervisor type of the instance. The value "xen" is used for both Xen and Nitro hypervisors. Instance / Attribute / instance_type instance_type ************* EC2.Instance.instance_type * *(string) --* The instance type. Instance / Attribute / licenses licenses ******** EC2.Instance.licenses * *(list) --* The license configurations for the instance. * *(dict) --* Describes a license configuration. * **LicenseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the license configuration. Instance / Attribute / private_dns_name private_dns_name **************** EC2.Instance.private_dns_name * *(string) --* [IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the "running" state. The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate. Instance / Action / password_data password_data ************* EC2.Instance.password_data(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = instance.password_data( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'Timestamp': datetime(2015, 1, 1), 'PasswordData': 'string' } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The ID of the Windows instance. * **Timestamp** *(datetime) --* The time the data was last updated. * **PasswordData** *(string) --* The password of the instance. Returns an empty string if the password is not available. Instance / Attribute / block_device_mappings block_device_mappings ********************* EC2.Instance.block_device_mappings * *(list) --* Any block device mapping entries for the instance. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Status** *(string) --* The attachment state. * **VolumeId** *(string) --* The ID of the EBS volume. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **VolumeOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the volume. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **Operator** *(dict) --* The service provider that manages the EBS volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. Instance / Attribute / tags tags **** EC2.Instance.tags * *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Instance / Attribute / private_dns_name_options private_dns_name_options ************************ EC2.Instance.private_dns_name_options * *(dict) --* The options for the instance hostname. * **HostnameType** *(string) --* The type of hostname to assign to an instance. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. Instance / Attribute / placement placement ********* EC2.Instance.placement * *(dict) --* The location where the instance launched, if applicable. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. Instance / Action / console_output console_output ************** EC2.Instance.console_output(**kwargs) Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. For more information, see Instance console output in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = instance.console_output( Latest=True|False, DryRun=True|False ) Parameters: * **Latest** (*boolean*) -- When enabled, retrieves the latest console output for the instance. Default: disabled ( "false") * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'Timestamp': datetime(2015, 1, 1), 'Output': 'string' } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The ID of the instance. * **Timestamp** *(datetime) --* The time at which the output was last updated. * **Output** *(string) --* The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. Instance / Attribute / current_instance_boot_mode current_instance_boot_mode ************************** EC2.Instance.current_instance_boot_mode * *(string) --* The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the *Amazon EC2 User Guide*. Instance / Attribute / public_dns_name public_dns_name *************** EC2.Instance.public_dns_name * *(string) --* The public DNS name assigned to the instance. This name is not available until the instance enters the "running" state. This name is only available if you've enabled DNS hostnames for your VPC. The format of this name depends on the public hostname type. Instance / Attribute / ramdisk_id ramdisk_id ********** EC2.Instance.ramdisk_id * *(string) --* The RAM disk associated with this instance, if applicable. Instance / Attribute / public_ip_address public_ip_address ***************** EC2.Instance.public_ip_address * *(string) --* The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone. Instance / Attribute / maintenance_options maintenance_options ******************* EC2.Instance.maintenance_options * *(dict) --* Provides information on the recovery and maintenance options of your instance. * **AutoRecovery** *(string) --* Provides information on the current automatic recovery behavior of your instance. * **RebootMigration** *(string) --* Specifies whether to attempt reboot migration during a user- initiated reboot of an instance that has a scheduled "system- reboot" event: * "default" - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the "system- reboot" event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled. * "disabled" - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The "system-reboot" event remains scheduled. This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the *Amazon EC2 User Guide*. Instance / Attribute / virtualization_type virtualization_type ******************* EC2.Instance.virtualization_type * *(string) --* The virtualization type of the instance. Instance / Attribute / ami_launch_index ami_launch_index **************** EC2.Instance.ami_launch_index * *(integer) --* The AMI launch index, which can be used to find this instance in the launch group. ServiceResource / Sub-Resource / Snapshot Snapshot ******** EC2.ServiceResource.Snapshot(id) Creates a Snapshot resource.: snapshot = ec2.Snapshot('id') Parameters: **id** (*string*) -- The Snapshot's id identifier. This **must** be set. Return type: "EC2.Snapshot" Returns: A Snapshot resource ServiceResource / Collection / instances instances ********* EC2.ServiceResource.instances A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = ec2.instances.all() Return type: list("ec2.Instance") Returns: A list of Instance resources create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.instances.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None filter(**kwargs) Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method. A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** instance_iterator = ec2.instances.filter( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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, "2022-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. * "boot-mode" - The boot mode that was specified by the AMI ( "legacy-bios" | "uefi" | "uefi-preferred"). * "capacity-reservation-id" - The ID of the Capacity Reservation into which the instance was launched. * "capacity-reservation-specification.capacity-reservation- preference" - The instance's Capacity Reservation preference ( "open" | "none"). * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-id" - The ID of the targeted Capacity Reservation. * "capacity-reservation-specification.capacity-reservation- target.capacity-reservation-resource-group-arn" - The ARN of the targeted Capacity Reservation group. * "client-token" - The idempotency token you provided when you launched the instance. * "current-instance-boot-mode" - The boot mode that is used to launch the instance at launch or start ( "legacy-bios" | "uefi"). * "dns-name" - The public DNS name of the instance. * "ebs-optimized" - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. * "ena-support" - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. * "enclave-options.enabled" - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * "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. * "iam-instance-profile.id" - The instance profile associated with the instance. Specified as an ID. * "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, a Scheduled Instance, or a Capacity Block ( "spot" | "scheduled" | "capacity-block"). * "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. * "ipv6-address" - The IPv6 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, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "maintenance-options.auto-recovery" - The current automatic recovery behavior of the instance ( "disabled" | "default"). * "metadata-options.http-endpoint" - The status of access to the HTTP metadata endpoint on your instance ( "enabled" | "disabled") * "metadata-options.http-protocol-ipv4" - Indicates whether the IPv4 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-protocol-ipv6" - Indicates whether the IPv6 endpoint is enabled ( "disabled" | "enabled"). * "metadata-options.http-put-response-hop-limit" - The HTTP metadata request put response hop limit (integer, possible values "1" to "64") * "metadata-options.http-tokens" - The metadata request authorization state ( "optional" | "required") * "metadata-options.instance-metadata-tags" - The status of access to instance tags from the instance metadata ( "enabled" | "disabled") * "metadata-options.state" - The state of the metadata option changes ( "pending" | "applied"). * "monitoring-state" - Indicates whether detailed monitoring is enabled ( "disabled" | "enabled"). * "network-interface.addresses.association.allocation-id" - The allocation ID. * "network-interface.addresses.association.association-id" - The association ID. * "network-interface.addresses.association.carrier-ip" - The carrier IP address. * "network-interface.addresses.association.customer-owned- ip" - The customer-owned IP address. * "network-interface.addresses.association.ip-owner-id" - The owner ID of the private IPv4 address associated with the network interface. * "network-interface.addresses.association.public-dns-name" - The public DNS name. * "network-interface.addresses.association.public-ip" - The ID of the association of an Elastic IP address (IPv4) with a network interface. * "network-interface.addresses.primary" - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. * "network-interface.addresses.private-dns-name" - The private DNS name. * "network-interface.addresses.private-ip-address" - The private IPv4 address associated with the network interface. * "network-interface.association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "network-interface.association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "network-interface.association.carrier-ip" - The customer-owned IP address. * "network-interface.association.customer-owned-ip" - The customer-owned IP address. * "network-interface.association.ip-owner-id" - The owner of the Elastic IP address (IPv4) associated with the network interface. * "network-interface.association.public-dns-name" - The public DNS name. * "network-interface.association.public-ip" - The address of the Elastic IP address (IPv4) bound to the network interface. * "network-interface.attachment.attach-time" - The time that the network interface was attached to an instance. * "network-interface.attachment.attachment-id" - The ID of the interface attachment. * "network-interface.attachment.delete-on-termination" - Specifies whether the attachment is deleted when an instance is terminated. * "network-interface.attachment.device-index" - The device index to which the network interface is attached. * "network-interface.attachment.instance-id" - The ID of the instance to which the network interface is attached. * "network-interface.attachment.instance-owner-id" - The owner ID of the instance to which the network interface is attached. * "network-interface.attachment.network-card-index" - The index of the network card. * "network-interface.attachment.status" - The status of the attachment ( "attaching" | "attached" | "detaching" | "detached"). * "network-interface.availability-zone" - The Availability Zone for the network interface. * "network-interface.deny-all-igw-traffic" - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. * "network-interface.description" - The description of the network interface. * "network-interface.group-id" - The ID of a security group associated with the network interface. * "network-interface.group-name" - The name of a security group associated with the network interface. * "network-interface.ipv4-prefixes.ipv4-prefix" - The IPv4 prefixes that are assigned to the network interface. * "network-interface.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.ipv6-address" - The IPv6 address associated with the network interface. * "network-interface.ipv6-addresses.is-primary-ipv6" - A Boolean that indicates whether this is the primary IPv6 address. * "network-interface.ipv6-native" - A Boolean that indicates whether this is an IPv6 only network interface. * "network-interface.ipv6-prefixes.ipv6-prefix" - The IPv6 prefix assigned to the network interface. * "network-interface.mac-address" - The MAC address of the network interface. * "network-interface.network-interface-id" - The ID of the network interface. * "network-interface.operator.managed" - A Boolean that indicates whether the instance has a managed network interface. * "network-interface.operator.principal" - The principal that manages the network interface. Only valid for instances with managed network interfaces, where "managed" is "true". * "network-interface.outpost-arn" - The ARN of the Outpost. * "network-interface.owner-id" - The ID of the owner of the network interface. * "network-interface.private-dns-name" - The private DNS name of the network interface. * "network-interface.private-ip-address" - The private IPv4 address. * "network-interface.public-dns-name" - The public DNS name. * "network-interface.requester-id" - The requester ID for the network interface. * "network-interface.requester-managed" - Indicates whether the network interface is being managed by Amazon Web Services. * "network-interface.status" - The status of the network interface ( "available") | "in-use"). * "network-interface.source-dest-check" - Whether the network interface performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the network interface to perform network address translation (NAT) in your VPC. * "network-interface.subnet-id" - The ID of the subnet for the network interface. * "network-interface.tag-key" - The key of a tag assigned to the network interface. * "network-interface.tag-value" - The value of a tag assigned to the network interface. * "network-interface.vpc-id" - The ID of the VPC for the network interface. * "network-performance-options.bandwidth-weighting" - Where the performance boost is applied, if applicable. Valid values: "default", "vpc-1", "ebs-1". * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The Amazon Web Services account ID of the instance owner. * "placement-group-name" - The name of the placement group for the instance. * "placement-partition-number" - The partition in which the instance is located. * "platform" - The platform. To list only Windows instances, use "windows". * "platform-details" - The platform ( "Linux/UNIX" | "Red Hat BYOL Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Red Hat Enterprise Linux with SQL Server Standard and HA" | "Red Hat Enterprise Linux with SQL Server Enterprise and HA" | "Red Hat Enterprise Linux with SQL Server Standard" | "Red Hat Enterprise Linux with SQL Server Web" | "Red Hat Enterprise Linux with SQL Server Enterprise" | "SQL Server Enterprise" | "SQL Server Standard" | "SQL Server Web" | "SUSE Linux" | "Ubuntu Pro" | "Windows" | "Windows BYOL" | "Windows with SQL Server Enterprise" | "Windows with SQL Server Standard" | "Windows with SQL Server Web"). * "private-dns-name" - The private IPv4 DNS name of the instance. * "private-dns-name-options.enable-resource-name- dns-a-record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options.enable-resource-name-dns-aaaa- record" - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "private-dns-name-options.hostname-type" - The type of hostname ( "ip-name" | "resource-name"). * "private-ip-address" - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter "network- interface.addresses.private-ip-address". * "product-code" - The product code associated with the AMI used to launch the instance. * "product-code.type" - The type of product code ( "devpay" | "marketplace"). * "ramdisk-id" - The RAM disk ID. * "reason" - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. * "requester-id" - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on). * "reservation-id" - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation 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"). * "source-dest-check" - Indicates whether the instance performs source/destination checking. A value of "true" means that checking is enabled, and "false" means that checking is disabled. The value must be "false" for the instance to perform network address translation (NAT) in your VPC. * "spot-instance-request-id" - The ID of the Spot Instance request. * "state-reason-code" - The reason code for the state change. * "state-reason-message" - A message that describes the state change. * "subnet-id" - The ID of the subnet for the instance. * "tag:" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Return type: list("ec2.Instance") Returns: A list of Instance resources limit(**kwargs) Creates an iterable up to a specified amount of Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = ec2.instances.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Instance") Returns: A list of Instance resources monitor(**kwargs) Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the *Amazon EC2 User Guide*. To disable detailed monitoring, see UnmonitorInstances. See also: AWS API Documentation **Request Syntax** response = ec2.instances.monitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. page_size(**kwargs) Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** instance_iterator = ec2.instances.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Instance") Returns: A list of Instance resources reboot(**kwargs) Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Troubleshoot an unreachable instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.instances.reboot( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None start(**kwargs) Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. If you attempt to start a T3 instance with "host" tenancy and the "unlimited" CPU credit option, the request fails. The "unlimited" CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to "standard", or change its tenancy to "default" or "dedicated". For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.instances.start( AdditionalInfo='string', DryRun=True|False ) Parameters: * **AdditionalInfo** (*string*) -- Reserved. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'StartingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StartingInstances** *(list) --* Information about the started instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. stop(**kwargs) Stops an Amazon EBS-backed instance. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can use the StopInstances operation together with the "Hibernate" parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. If your instance appears stuck in the "stopping" state, there might be an issue with the underlying host computer. You can use the StopInstances operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing. You can't stop or hibernate instance store-backed instances. See also: AWS API Documentation **Request Syntax** response = ec2.instances.stop( Hibernate=True|False, SkipOsShutdown=True|False, DryRun=True|False, Force=True|False ) Parameters: * **Hibernate** (*boolean*) -- 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 Amazon EC2 instance in the *Amazon EC2 User Guide*. Default: "false" * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is stopped. Warning: Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*boolean*) -- Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Default: "false" Return type: dict Returns: **Response Syntax** { 'StoppingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StoppingInstances** *(list) --* Information about the stopped instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. terminate(**kwargs) Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results: * The specified instances that are in the same Availability Zone as the protected instance are not terminated. * The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated. For example, say you have the following instances: * Instance A: "us-east-1a"; Not protected * Instance B: "us-east-1a"; Not protected * Instance C: "us-east-1b"; Protected * Instance D: "us-east-1b"; not protected If you attempt to terminate all of these instances in the same request, the request reports failure with the following results: * Instance A and Instance B are successfully terminated because none of the specified instances in "us-east-1a" are enabled for termination protection. * Instance C and Instance D fail to terminate because at least one of the specified instances in "us-east-1b" (Instance C) is enabled for termination protection. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. By default, the TerminateInstances operation includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the "DeleteOnTermination" block device mapping parameter set to "true" are automatically deleted. For more information about the differences between stopping and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and Troubleshooting terminating your instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.instances.terminate( Force=True|False, SkipOsShutdown=True|False, DryRun=True|False ) Parameters: * **Force** (*boolean*) -- Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is terminated. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TerminatingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **TerminatingInstances** *(list) --* Information about the terminated instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. unmonitor(**kwargs) Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.instances.unmonitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. ServiceResource / Action / create_snapshot create_snapshot *************** EC2.ServiceResource.create_snapshot(**kwargs) Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. The location of the source EBS volume determines where you can create the snapshot. * If the source volume is in a Region, you must create the snapshot in the same Region as the volume. * If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services Region. * If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent Amazon Web Services Region. When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is "pending". When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. For more information, see Amazon EBS encryption in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** snapshot = ec2.create_snapshot( Description='string', OutpostArn='string', VolumeId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], Location='regional'|'local', DryRun=True|False ) Parameters: * **Description** (*string*) -- A description for the snapshot. * **OutpostArn** (*string*) -- Note: Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter. * To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume. * To create the snapshot in the parent Region of the Outpost, omit this parameter. For more information, see Create local snapshots from volumes on an Outpost in the *Amazon EBS User Guide*. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the Amazon EBS volume. * **TagSpecifications** (*list*) -- The tags to apply to the snapshot during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Location** (*string*) -- Note: Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter. * To create a local snapshot in the same Local Zone as the source volume, specify "local". * To create a regional snapshot in the parent Region of the Local Zone, specify "regional" or omit this parameter. Default value: "regional" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.Snapshot" Returns: Snapshot resource ServiceResource / Collection / security_groups security_groups *************** EC2.ServiceResource.security_groups A collection of SecurityGroup resources.A SecurityGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all SecurityGroup resources in the collection. See also: AWS API Documentation **Request Syntax** security_group_iterator = ec2.security_groups.all() Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources filter(**kwargs) Creates an iterable of all SecurityGroup resources in the collection filtered by kwargs passed to method. A SecurityGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** security_group_iterator = ec2.security_groups.filter( GroupIds=[ 'string', ], GroupNames=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **GroupIds** (*list*) -- The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all of your security groups. * *(string) --* * **GroupNames** (*list*) -- [Default VPC] The names of the security groups. You can specify either the security group name or the security group ID. Default: Describes all of your security groups. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services 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 Amazon Web Services account that has been referenced in an inbound security group rule. * "owner-id" - The Amazon Web Services account ID of the owner of the security group. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources limit(**kwargs) Creates an iterable up to a specified amount of SecurityGroup resources in the collection. See also: AWS API Documentation **Request Syntax** security_group_iterator = ec2.security_groups.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources page_size(**kwargs) Creates an iterable of all SecurityGroup resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** security_group_iterator = ec2.security_groups.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources ServiceResource / Sub-Resource / RouteTable RouteTable ********** EC2.ServiceResource.RouteTable(id) Creates a RouteTable resource.: route_table = ec2.RouteTable('id') Parameters: **id** (*string*) -- The RouteTable's id identifier. This **must** be set. Return type: "EC2.RouteTable" Returns: A RouteTable resource ServiceResource / Collection / route_tables route_tables ************ EC2.ServiceResource.route_tables A collection of RouteTable resources.A RouteTable Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all RouteTable resources in the collection. See also: AWS API Documentation **Request Syntax** route_table_iterator = ec2.route_tables.all() Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources filter(**kwargs) Creates an iterable of all RouteTable resources in the collection filtered by kwargs passed to method. A RouteTable collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** route_table_iterator = ec2.route_tables.filter( NextToken='string', MaxResults=123, DryRun=True|False, RouteTableIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableIds** (*list*) -- The IDs of the route tables. * *(string) --* * **Filters** (*list*) -- The filters. * "association.gateway-id" - The ID of the gateway involved in the association. * "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 Amazon Web Services 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 Amazon Web Services 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" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources limit(**kwargs) Creates an iterable up to a specified amount of RouteTable resources in the collection. See also: AWS API Documentation **Request Syntax** route_table_iterator = ec2.route_tables.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources page_size(**kwargs) Creates an iterable of all RouteTable resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** route_table_iterator = ec2.route_tables.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources ServiceResource / Sub-Resource / Tag Tag *** EC2.ServiceResource.Tag(resource_id, key, value) Creates a Tag resource.: tag = ec2.Tag('resource_id','key','value') Parameters: * **resource_id** (*string*) -- The Tag's resource_id identifier. This **must** be set. * **key** (*string*) -- The Tag's key identifier. This **must** be set. * **value** (*string*) -- The Tag's value identifier. This **must** be set. Return type: "EC2.Tag" Returns: A Tag resource ServiceResource / Action / create_placement_group create_placement_group ********************** EC2.ServiceResource.create_placement_group(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** placement_group = ec2.create_placement_group( PartitionCount=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], SpreadLevel='host'|'rack', DryRun=True|False, GroupName='string', Strategy='cluster'|'spread'|'partition' ) Parameters: * **PartitionCount** (*integer*) -- The number of partitions. Valid only when **Strategy** is set to "partition". * **TagSpecifications** (*list*) -- The tags to apply to the new placement group. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SpreadLevel** (*string*) -- Determines how placement groups spread instances. * Host – You can use "host" only with Outpost placement groups. * Rack – No usage restrictions. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*string*) -- 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** (*string*) -- The placement strategy. Return type: "ec2.PlacementGroup" Returns: PlacementGroup resource ServiceResource / Action / get_available_subresources get_available_subresources ************************** EC2.ServiceResource.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str ServiceResource / Collection / snapshots snapshots ********* EC2.ServiceResource.snapshots A collection of Snapshot resources.A Snapshot Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Snapshot resources in the collection. See also: AWS API Documentation **Request Syntax** snapshot_iterator = ec2.snapshots.all() Return type: list("ec2.Snapshot") Returns: A list of Snapshot resources filter(**kwargs) Creates an iterable of all Snapshot resources in the collection filtered by kwargs passed to method. A Snapshot collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** snapshot_iterator = ec2.snapshots.filter( MaxResults=123, NextToken='string', OwnerIds=[ 'string', ], RestorableByUserIds=[ 'string', ], SnapshotIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **OwnerIds** (*list*) -- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", and "amazon". * *(string) --* * **RestorableByUserIds** (*list*) -- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. * *(string) --* * **SnapshotIds** (*list*) -- The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. * "owner-id" - The Amazon Web Services 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"). * "storage-tier" - The storage tier of the snapshot ( "archive" | "standard"). * "transfer-type" - The type of operation used to create the snapshot ( "time-based" | "standard"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.Snapshot") Returns: A list of Snapshot resources limit(**kwargs) Creates an iterable up to a specified amount of Snapshot resources in the collection. See also: AWS API Documentation **Request Syntax** snapshot_iterator = ec2.snapshots.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Snapshot") Returns: A list of Snapshot resources page_size(**kwargs) Creates an iterable of all Snapshot resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** snapshot_iterator = ec2.snapshots.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Snapshot") Returns: A list of Snapshot resources ServiceResource / Collection / subnets subnets ******* EC2.ServiceResource.subnets A collection of Subnet resources.A Subnet Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Subnet resources in the collection. See also: AWS API Documentation **Request Syntax** subnet_iterator = ec2.subnets.all() Return type: list("ec2.Subnet") Returns: A list of Subnet resources filter(**kwargs) Creates an iterable of all Subnet resources in the collection filtered by kwargs passed to method. A Subnet collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** subnet_iterator = ec2.subnets.filter( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SubnetIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **Filters** (*list*) -- The 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. * "customer-owned-ipv4-pool" - The customer-owned IPv4 address pool associated with the subnet. * "default-for-az" - Indicates whether this is the default subnet for the Availability Zone ( "true" | "false"). You can also use "defaultForAz" as the filter name. * "enable-dns64" - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. * "enable-lni-at-device-index" - Indicates the device position for local network interfaces in this subnet. For example, "1" indicates local network interfaces in this subnet are the secondary network interface (eth1). * "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. * "ipv6-native" - Indicates whether this is an IPv6 only subnet ( "true" | "false"). * "map-customer-owned-ip-on-launch" - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. * "map-public-ip-on-launch" - Indicates whether instances launched in this subnet receive a public IPv4 address. * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The ID of the Amazon Web Services account that owns the subnet. * "private-dns-name-options-on-launch.hostname-type" - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name). * "private-dns-name-options-on-launch.enable-resource-name- dns-a-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options-on-launch.enable-resource-name- dns-aaaa-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "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" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SubnetIds** (*list*) -- The IDs of the subnets. Default: Describes all your subnets. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: list("ec2.Subnet") Returns: A list of Subnet resources limit(**kwargs) Creates an iterable up to a specified amount of Subnet resources in the collection. See also: AWS API Documentation **Request Syntax** subnet_iterator = ec2.subnets.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Subnet") Returns: A list of Subnet resources page_size(**kwargs) Creates an iterable of all Subnet resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** subnet_iterator = ec2.subnets.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Subnet") Returns: A list of Subnet resources ServiceResource / Sub-Resource / VpcPeeringConnection VpcPeeringConnection ******************** EC2.ServiceResource.VpcPeeringConnection(id) Creates a VpcPeeringConnection resource.: vpc_peering_connection = ec2.VpcPeeringConnection('id') Parameters: **id** (*string*) -- The VpcPeeringConnection's id identifier. This **must** be set. Return type: "EC2.VpcPeeringConnection" Returns: A VpcPeeringConnection resource ServiceResource / Collection / volumes volumes ******* EC2.ServiceResource.volumes A collection of Volume resources.A Volume Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Volume resources in the collection. See also: AWS API Documentation **Request Syntax** volume_iterator = ec2.volumes.all() Return type: list("ec2.Volume") Returns: A list of Volume resources filter(**kwargs) Creates an iterable of all Volume resources in the collection filtered by kwargs passed to method. A Volume collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** volume_iterator = ec2.volumes.filter( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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") * "fast-restored" - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( "true" | "false"). * "multi-attach-enabled" - Indicates whether the volume is enabled for Multi-Attach ( "true" | "false") * "operator.managed" - A Boolean that indicates whether this is a managed volume. * "operator.principal" - The principal that manages the volume. Only valid for managed volumes, where "managed" is "true". * "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": - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Return type: list("ec2.Volume") Returns: A list of Volume resources limit(**kwargs) Creates an iterable up to a specified amount of Volume resources in the collection. See also: AWS API Documentation **Request Syntax** volume_iterator = ec2.volumes.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Volume") Returns: A list of Volume resources page_size(**kwargs) Creates an iterable of all Volume resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** volume_iterator = ec2.volumes.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Volume") Returns: A list of Volume resources ServiceResource / Sub-Resource / NetworkAcl NetworkAcl ********** EC2.ServiceResource.NetworkAcl(id) Creates a NetworkAcl resource.: network_acl = ec2.NetworkAcl('id') Parameters: **id** (*string*) -- The NetworkAcl's id identifier. This **must** be set. Return type: "EC2.NetworkAcl" Returns: A NetworkAcl resource ServiceResource / Action / create_route_table create_route_table ****************** EC2.ServiceResource.create_route_table(**kwargs) Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** route_table = ec2.create_route_table( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', DryRun=True|False, VpcId='string' ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the route table. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Return type: "ec2.RouteTable" Returns: RouteTable resource ServiceResource / Collection / vpc_peering_connections vpc_peering_connections *********************** EC2.ServiceResource.vpc_peering_connections A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = ec2.vpc_peering_connections.all() Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources filter(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method. A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = ec2.vpc_peering_connections.filter( NextToken='string', MaxResults=123, DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* * **Filters** (*list*) -- The filters. * "accepter-vpc-info.cidr-block" - The IPv4 CIDR block of the accepter VPC. * "accepter-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns 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. * "requester-vpc-info.cidr-block" - The IPv4 CIDR block of the requester's VPC. * "requester-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns the requester VPC. * "requester-vpc-info.vpc-id" - The ID of the requester VPC. * "status-code" - The status of the VPC peering connection ( "pending-acceptance" | "failed" | "expired" | "provisioning" | "active" | "deleting" | "deleted" | "rejected"). * "status-message" - A message that provides more information about the status of the VPC peering connection, if applicable. * "tag" - 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-peering-connection-id" - The ID of the VPC peering connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources limit(**kwargs) Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = ec2.vpc_peering_connections.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources page_size(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = ec2.vpc_peering_connections.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources ServiceResource / Action / disassociate_route_table disassociate_route_table ************************ EC2.ServiceResource.disassociate_route_table(**kwargs) Disassociates a subnet or gateway from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.disassociate_route_table( DryRun=True|False, AssociationId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AssociationId** (*string*) -- **[REQUIRED]** The association ID representing the current association between the route table and subnet or gateway. Returns: None ServiceResource / Sub-Resource / Instance Instance ******** EC2.ServiceResource.Instance(id) Creates a Instance resource.: instance = ec2.Instance('id') Parameters: **id** (*string*) -- The Instance's id identifier. This **must** be set. Return type: "EC2.Instance" Returns: A Instance resource ServiceResource / Sub-Resource / NetworkInterface NetworkInterface **************** EC2.ServiceResource.NetworkInterface(id) Creates a NetworkInterface resource.: network_interface = ec2.NetworkInterface('id') Parameters: **id** (*string*) -- The NetworkInterface's id identifier. This **must** be set. Return type: "EC2.NetworkInterface" Returns: A NetworkInterface resource ServiceResource / Sub-Resource / RouteTableAssociation RouteTableAssociation ********************* EC2.ServiceResource.RouteTableAssociation(id) Creates a RouteTableAssociation resource.: route_table_association = ec2.RouteTableAssociation('id') Parameters: **id** (*string*) -- The RouteTableAssociation's id identifier. This **must** be set. Return type: "EC2.RouteTableAssociation" Returns: A RouteTableAssociation resource ServiceResource / Collection / key_pairs key_pairs ********* EC2.ServiceResource.key_pairs A collection of KeyPairInfo resources.A KeyPairInfo Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all KeyPairInfo resources in the collection. See also: AWS API Documentation **Request Syntax** key_pair_info_iterator = ec2.key_pairs.all() Return type: list("ec2.KeyPairInfo") Returns: A list of KeyPairInfo resources filter(**kwargs) Creates an iterable of all KeyPairInfo resources in the collection filtered by kwargs passed to method. A KeyPairInfo collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** key_pair_info_iterator = ec2.key_pairs.filter( KeyNames=[ 'string', ], KeyPairIds=[ 'string', ], IncludePublicKey=True|False, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **KeyNames** (*list*) -- The key pair names. Default: Describes all of your key pairs. * *(string) --* * **KeyPairIds** (*list*) -- The IDs of the key pairs. * *(string) --* * **IncludePublicKey** (*boolean*) -- If "true", the public key material is included in the response. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.KeyPairInfo") Returns: A list of KeyPairInfo resources limit(**kwargs) Creates an iterable up to a specified amount of KeyPairInfo resources in the collection. See also: AWS API Documentation **Request Syntax** key_pair_info_iterator = ec2.key_pairs.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.KeyPairInfo") Returns: A list of KeyPairInfo resources page_size(**kwargs) Creates an iterable of all KeyPairInfo resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** key_pair_info_iterator = ec2.key_pairs.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.KeyPairInfo") Returns: A list of KeyPairInfo resources EC2 / Resource / ServiceResource Service Resource **************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.ServiceResource A resource representing Amazon Elastic Compute Cloud (EC2): import boto3 ec2 = boto3.resource('ec2') Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * create_dhcp_options * create_instances * create_internet_gateway * create_key_pair * create_network_acl * create_network_interface * create_placement_group * create_route_table * create_security_group * create_snapshot * create_subnet * create_tags * create_volume * create_vpc * create_vpc_peering_connection * disassociate_route_table * get_available_subresources * import_key_pair * register_image Sub-resources ============= Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child. For more information about sub-resources refer to the Resources Introduction Guide. These are the resource's available sub-resources: * ClassicAddress * DhcpOptions * Image * Instance * InternetGateway * KeyPair * NetworkAcl * NetworkInterface * NetworkInterfaceAssociation * PlacementGroup * Route * RouteTable * RouteTableAssociation * SecurityGroup * Snapshot * Subnet * Tag * Volume * Vpc * VpcAddress * VpcPeeringConnection Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * classic_addresses * dhcp_options_sets * images * instances * internet_gateways * key_pairs * network_acls * network_interfaces * placement_groups * route_tables * security_groups * snapshots * subnets * volumes * vpc_addresses * vpc_peering_connections * vpcs ServiceResource / Sub-Resource / SecurityGroup SecurityGroup ************* EC2.ServiceResource.SecurityGroup(id) Creates a SecurityGroup resource.: security_group = ec2.SecurityGroup('id') Parameters: **id** (*string*) -- The SecurityGroup's id identifier. This **must** be set. Return type: "EC2.SecurityGroup" Returns: A SecurityGroup resource ServiceResource / Action / import_key_pair import_key_pair *************** EC2.ServiceResource.import_key_pair(**kwargs) Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services. For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** key_pair_info = ec2.import_key_pair( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, KeyName='string', PublicKeyMaterial=b'bytes' ) Parameters: * **TagSpecifications** (*list*) -- The tags to apply to the imported key pair. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **KeyName** (*string*) -- **[REQUIRED]** A unique name for the key pair. * **PublicKeyMaterial** (*bytes*) -- **[REQUIRED]** The public key. Return type: "ec2.KeyPairInfo" Returns: KeyPairInfo resource ServiceResource / Sub-Resource / Volume Volume ****** EC2.ServiceResource.Volume(id) Creates a Volume resource.: volume = ec2.Volume('id') Parameters: **id** (*string*) -- The Volume's id identifier. This **must** be set. Return type: "EC2.Volume" Returns: A Volume resource ServiceResource / Action / create_network_interface create_network_interface ************************ EC2.ServiceResource.create_network_interface(**kwargs) Creates a network interface in the specified subnet. The number of IP addresses you can assign to a network interface varies by instance type. For more information about network interfaces, see Elastic network interfaces in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** network_interface = ec2.create_network_interface( Ipv4Prefixes=[ { 'Ipv4Prefix': 'string' }, ], Ipv4PrefixCount=123, Ipv6Prefixes=[ { 'Ipv6Prefix': 'string' }, ], Ipv6PrefixCount=123, InterfaceType='efa'|'efa-only'|'branch'|'trunk', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', EnablePrimaryIpv6=True|False, ConnectionTrackingSpecification={ 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, Operator={ 'Principal': 'string' }, SubnetId='string', Description='string', PrivateIpAddress='string', Groups=[ 'string', ], PrivateIpAddresses=[ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], SecondaryPrivateIpAddressCount=123, Ipv6Addresses=[ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], Ipv6AddressCount=123, DryRun=True|False ) Parameters: * **Ipv4Prefixes** (*list*) -- The IPv4 prefixes assigned to the network interface. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. * *(dict) --* Describes the IPv4 prefix option for a network interface. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv4PrefixCount** (*integer*) -- The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. * **Ipv6Prefixes** (*list*) -- The IPv6 prefixes assigned to the network interface. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. * *(dict) --* Describes the IPv6 prefix option for a network interface. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **Ipv6PrefixCount** (*integer*) -- The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. * **InterfaceType** (*string*) -- The type of network interface. The default is "interface". If you specify "efa-only", do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. The only supported values are "interface", "efa", "efa-only", and "trunk". * **TagSpecifications** (*list*) -- The tags to apply to the new network interface. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **EnablePrimaryIpv6** (*boolean*) -- If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address. * **ConnectionTrackingSpecification** (*dict*) -- A connection tracking specification for the network interface. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request- response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Operator** (*dict*) -- Reserved for internal use. * **Principal** *(string) --* The service provider that manages the resource. * **SubnetId** (*string*) -- **[REQUIRED]** The ID of the subnet to associate with the network interface. * **Description** (*string*) -- A description for the network interface. * **PrivateIpAddress** (*string*) -- 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). * **Groups** (*list*) -- The IDs of the security groups. * *(string) --* * **PrivateIpAddresses** (*list*) -- The private IPv4 addresses. You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** (*integer*) -- 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". You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes. * **Ipv6Addresses** (*list*) -- The IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **Ipv6AddressCount** (*integer*) -- 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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes. If your subnet has the "AssignIpv6AddressOnCreation" attribute set, you can override that setting by specifying 0 as the IPv6 address count. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.NetworkInterface" Returns: NetworkInterface resource ServiceResource / Sub-Resource / NetworkInterfaceAssociation NetworkInterfaceAssociation *************************** EC2.ServiceResource.NetworkInterfaceAssociation(id) Creates a NetworkInterfaceAssociation resource.: network_interface_association = ec2.NetworkInterfaceAssociation('id') Parameters: **id** (*string*) -- The NetworkInterfaceAssociation's id identifier. This **must** be set. Return type: "EC2.NetworkInterfaceAssociation" Returns: A NetworkInterfaceAssociation resource ServiceResource / Collection / network_interfaces network_interfaces ****************** EC2.ServiceResource.network_interfaces A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all NetworkInterface resources in the collection. See also: AWS API Documentation **Request Syntax** network_interface_iterator = ec2.network_interfaces.all() Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources filter(**kwargs) Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method. A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** network_interface_iterator = ec2.network_interfaces.filter( NextToken='string', MaxResults=123, DryRun=True|False, NetworkInterfaceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkInterfaceIds** (*list*) -- The network interface IDs. Default: Describes all your network interfaces. * *(string) --* * **Filters** (*list*) -- One or more filters. * "association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "addresses.association.owner-id" - The owner ID of the addresses 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.primary" - Whether the private IPv4 address is the primary IP address associated with the network interface. * "addresses.private-ip-address" - The private IPv4 addresses associated with the 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.attach-time" - The time that the network interface was attached to an instance. * "attachment.attachment-id" - The ID of the interface attachment. * "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. * "ipv6-addresses.ipv6-address" - An IPv6 address associated with the network interface. * "interface-type" - The type of network interface ( "api_gateway_managed" | "aws_codestar_connections_managed" | "branch" | "ec2_instance_connect_endpoint" | "efa" | "efa-only" | "efs" | "evs" | "gateway_load_balancer" | "gateway_load_balancer_endpoint" | "global_accelerator_managed" | "interface" | "iot_rules_managed" | "lambda" | "load_balancer" | "nat_gateway" | "network_load_balancer" | "quicksight" | "transit_gateway" | "trunk" | "vpc_endpoint"). * "mac-address" - The MAC address of the network interface. * "network-interface-id" - The ID of the network interface. * "operator.managed" - A Boolean that indicates whether this is a managed network interface. * "operator.principal" - The principal that manages the network interface. Only valid for managed network interfaces, where "managed" is "true". * "owner-id" - The Amazon Web Services account ID of the network interface owner. * "private-dns-name" - The private DNS name of the network interface (IPv4). * "private-ip-address" - The private IPv4 address or addresses of the network interface. * "requester-id" - The alias or Amazon Web Services account ID of the principal or service that created the network interface. * "requester-managed" - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources limit(**kwargs) Creates an iterable up to a specified amount of NetworkInterface resources in the collection. See also: AWS API Documentation **Request Syntax** network_interface_iterator = ec2.network_interfaces.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources page_size(**kwargs) Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** network_interface_iterator = ec2.network_interfaces.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources ServiceResource / Collection / network_acls network_acls ************ EC2.ServiceResource.network_acls A collection of NetworkAcl resources.A NetworkAcl Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all NetworkAcl resources in the collection. See also: AWS API Documentation **Request Syntax** network_acl_iterator = ec2.network_acls.all() Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources filter(**kwargs) Creates an iterable of all NetworkAcl resources in the collection filtered by kwargs passed to method. A NetworkAcl collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** network_acl_iterator = ec2.network_acls.filter( NextToken='string', MaxResults=123, DryRun=True|False, NetworkAclIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclIds** (*list*) -- The IDs of the network ACLs. * *(string) --* * **Filters** (*list*) -- The 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 in the entry, if any. * "entry.icmp.type" - The ICMP type specified in the entry, if any. * "entry.ipv6-cidr" - The IPv6 CIDR range specified in the entry. * "entry.port-range.from" - The start of the port range specified in the entry. * "entry.port-range.to" - The end of the port range specified in the entry. * "entry.protocol" - The protocol specified in the entry ( "tcp" | "udp" | "icmp" or a protocol number). * "entry.rule-action" - Allows or denies the matching traffic ( "allow" | "deny"). * "entry.egress" - A Boolean that indicates the type of rule. Specify "true" for egress rules, or "false" for ingress rules. * "entry.rule-number" - The number of an entry (in other words, rule) in the set of ACL entries. * "network-acl-id" - The ID of the network ACL. * "owner-id" - The ID of the Amazon Web Services account that owns the network ACL. * "tag" - 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 ACL. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources limit(**kwargs) Creates an iterable up to a specified amount of NetworkAcl resources in the collection. See also: AWS API Documentation **Request Syntax** network_acl_iterator = ec2.network_acls.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources page_size(**kwargs) Creates an iterable of all NetworkAcl resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** network_acl_iterator = ec2.network_acls.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources ServiceResource / Collection / classic_addresses classic_addresses ***************** EC2.ServiceResource.classic_addresses A collection of ClassicAddress resources.A ClassicAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all ClassicAddress resources in the collection. See also: AWS API Documentation **Request Syntax** classic_address_iterator = ec2.classic_addresses.all() Return type: list("ec2.ClassicAddress") Returns: A list of ClassicAddress resources filter(**kwargs) Creates an iterable of all ClassicAddress resources in the collection filtered by kwargs passed to method. A ClassicAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** classic_address_iterator = ec2.classic_addresses.filter( PublicIps=[ 'string', ], DryRun=True|False, AllocationIds=[ 'string', ] ) Parameters: * **PublicIps** (*list*) -- One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AllocationIds** (*list*) -- Information about the allocation IDs. * *(string) --* Return type: list("ec2.ClassicAddress") Returns: A list of ClassicAddress resources limit(**kwargs) Creates an iterable up to a specified amount of ClassicAddress resources in the collection. See also: AWS API Documentation **Request Syntax** classic_address_iterator = ec2.classic_addresses.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.ClassicAddress") Returns: A list of ClassicAddress resources page_size(**kwargs) Creates an iterable of all ClassicAddress resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** classic_address_iterator = ec2.classic_addresses.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.ClassicAddress") Returns: A list of ClassicAddress resources ServiceResource / Action / create_volume create_volume ************* EC2.ServiceResource.create_volume(**kwargs) Creates an EBS volume that can be attached to an instance in the same Availability Zone. You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume. You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the *Amazon EBS User Guide*. You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the *Amazon EC2 User Guide*. For more information, see Create an Amazon EBS volume in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** volume = ec2.create_volume( AvailabilityZone='string', Encrypted=True|False, Iops=123, KmsKeyId='string', OutpostArn='string', Size=123, SnapshotId='string', VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], MultiAttachEnabled=True|False, Throughput=123, ClientToken='string', VolumeInitializationRate=123, Operator={ 'Principal': 'string' }, DryRun=True|False ) Parameters: * **AvailabilityZone** (*string*) -- **[REQUIRED]** The ID of the Availability Zone in which to create the volume. For example, "us-east-1a". * **Encrypted** (*boolean*) -- 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 EBS User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. * **Iops** (*integer*) -- 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve 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** (*string*) -- The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If "KmsKeyId" is specified, the encrypted state must be "true". You can specify the KMS key 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. Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. * **OutpostArn** (*string*) -- The Amazon Resource Name (ARN) of the Outpost on which to create the volume. If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around. * **Size** (*integer*) -- 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 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **SnapshotId** (*string*) -- The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. * **VolumeType** (*string*) -- 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" Warning: Throughput Optimized HDD ( "st1") and Cold HDD ( "sc1") volumes can't be used as boot volumes. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. Default: "gp2" * **TagSpecifications** (*list*) -- The tags to apply to the volume during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **MultiAttachEnabled** (*boolean*) -- 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 EBS User Guide*. * **Throughput** (*integer*) -- 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. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. This field is autopopulated if not provided. * **VolumeInitializationRate** (*integer*) -- Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. Valid range: 100 - 300 MiB/s * **Operator** (*dict*) -- Reserved for internal use. * **Principal** *(string) --* The service provider that manages the resource. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.Volume" Returns: Volume resource ServiceResource / Action / create_network_acl create_network_acl ****************** EC2.ServiceResource.create_network_acl(**kwargs) Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** network_acl = ec2.create_network_acl( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', DryRun=True|False, VpcId='string' ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the network ACL. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Return type: "ec2.NetworkAcl" Returns: NetworkAcl resource ServiceResource / Collection / vpc_addresses vpc_addresses ************* EC2.ServiceResource.vpc_addresses A collection of VpcAddress resources.A VpcAddress Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all VpcAddress resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = ec2.vpc_addresses.all() Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources filter(**kwargs) Creates an iterable of all VpcAddress resources in the collection filtered by kwargs passed to method. A VpcAddress collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = ec2.vpc_addresses.filter( PublicIps=[ 'string', ], DryRun=True|False, AllocationIds=[ 'string', ] ) Parameters: * **PublicIps** (*list*) -- One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AllocationIds** (*list*) -- Information about the allocation IDs. * *(string) --* Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources limit(**kwargs) Creates an iterable up to a specified amount of VpcAddress resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = ec2.vpc_addresses.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources page_size(**kwargs) Creates an iterable of all VpcAddress resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_address_iterator = ec2.vpc_addresses.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.VpcAddress") Returns: A list of VpcAddress resources ServiceResource / Action / create_tags create_tags *********** EC2.ServiceResource.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = ec2.create_tags( DryRun=True|False, Resources=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Resources** (*list*) -- **[REQUIRED]** The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. * *(string) --* * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None ServiceResource / Action / register_image register_image ************** EC2.ServiceResource.register_image(**kwargs) Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see Create an AMI from a snapshot and Create an instance-store backed AMI in the *Amazon EC2 User Guide*. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. **Register a snapshot of a root device volume** You can use "RegisterImage" to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted. For more information, see Create an AMI from a snapshot and Use encryption with EBS-backed AMIs in the *Amazon EC2 User Guide*. **Amazon Web Services Marketplace product codes** If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI. In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing information to be present on the AMI. For more information, see Understand AMI billing information in the *Amazon EC2 User Guide*. When creating an AMI from a snapshot, the "RegisterImage" operation derives the correct billing information from the snapshot's metadata, but this requires the appropriate metadata to be present. To verify if the correct billing information was applied, check the "PlatformDetails" field on the new AMI. If the field is empty or doesn't match the expected operating system code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you should discard the AMI and instead create the AMI from an instance. For more information, see Create an AMI from an instance in the *Amazon EC2 User Guide*. If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance is not applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** image = ec2.register_image( ImageLocation='string', BillingProducts=[ 'string', ], BootMode='legacy-bios'|'uefi'|'uefi-preferred', TpmSupport='v2.0', UefiData='string', ImdsSupport='v2.0', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, Name='string', Description='string', Architecture='i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', KernelId='string', RamdiskId='string', RootDeviceName='string', BlockDeviceMappings=[ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], VirtualizationType='string', SriovNetSupport='string', EnaSupport=True|False ) Parameters: * **ImageLocation** (*string*) -- 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 ACL in the *Amazon S3 Service Developer Guide*. * **BillingProducts** (*list*) -- The billing product codes. Your account must be authorized to specify billing product codes. If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as an Amazon Web Services Marketplace seller and AMI-based products in Amazon Web Services Marketplace in the *Amazon Web Services Marketplace Seller Guide*. * *(string) --* * **BootMode** (*string*) -- The boot mode of the AMI. A value of "uefi-preferred" indicates that the AMI supports both UEFI and Legacy BIOS. Note: The operating system contained in the AMI must be configured to support the specified boot mode. For more information, see Instance launch behavior with Amazon EC2 boot modes in the *Amazon EC2 User Guide*. * **TpmSupport** (*string*) -- Set to "v2.0" to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the *Amazon EC2 User Guide*. * **UefiData** (*string*) -- Base64 representation of the non- volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot for Amazon EC2 instances in the *Amazon EC2 User Guide*. * **ImdsSupport** (*string*) -- Set to "v2.0" to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have "HttpTokens" automatically set to "required" so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, "HttpPutResponseHopLimit" is set to "2". For more information, see Configure the AMI in the *Amazon EC2 User Guide*. Note: If you set the value to "v2.0", make sure that your AMI software can support IMDSv2. * **TagSpecifications** (*list*) -- The tags to apply to the AMI. To tag the AMI, the value for "ResourceType" must be "image". If you specify another value for "ResourceType", the request fails. To tag an AMI after it has been registered, see CreateTags. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) * **Description** (*string*) -- A description for your AMI. * **Architecture** (*string*) -- The architecture of the AMI. Default: For Amazon EBS-backed AMIs, "i386". For instance store-backed AMIs, the architecture specified in the manifest file. * **KernelId** (*string*) -- The ID of the kernel. * **RamdiskId** (*string*) -- The ID of the RAM disk. * **RootDeviceName** (*string*) -- The device name of the root device volume (for example, "/dev/sda1"). * **BlockDeviceMappings** (*list*) -- The block device mapping entries. If you specify an Amazon EBS volume using the ID of an Amazon 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, Create AMIs from local snapshots in the *Amazon EBS User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **VirtualizationType** (*string*) -- The type of virtualization ( "hvm" | "paravirtual"). Default: "paravirtual" * **SriovNetSupport** (*string*) -- 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. * **EnaSupport** (*boolean*) -- 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. Return type: "ec2.Image" Returns: Image resource ServiceResource / Action / create_subnet create_subnet ************* EC2.ServiceResource.create_subnet(**kwargs) Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block. The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use. If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information, see Subnets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** subnet = ec2.create_subnet( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], AvailabilityZone='string', AvailabilityZoneId='string', CidrBlock='string', Ipv6CidrBlock='string', OutpostArn='string', VpcId='string', Ipv6Native=True|False, Ipv4IpamPoolId='string', Ipv4NetmaskLength=123, Ipv6IpamPoolId='string', Ipv6NetmaskLength=123, DryRun=True|False ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the subnet. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AvailabilityZone** (*string*) -- The Availability Zone or Local Zone for the subnet. Default: Amazon Web Services 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 Local Zones. To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN. * **AvailabilityZoneId** (*string*) -- The AZ ID or the Local Zone ID of the subnet. * **CidrBlock** (*string*) -- 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". This parameter is not supported for an IPv6 only subnet. * **Ipv6CidrBlock** (*string*) -- The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet. * **OutpostArn** (*string*) -- 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. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **Ipv6Native** (*boolean*) -- Indicates whether to create an IPv6 only subnet. * **Ipv4IpamPoolId** (*string*) -- An IPv4 IPAM pool ID for the subnet. * **Ipv4NetmaskLength** (*integer*) -- An IPv4 netmask length for the subnet. * **Ipv6IpamPoolId** (*string*) -- An IPv6 IPAM pool ID for the subnet. * **Ipv6NetmaskLength** (*integer*) -- An IPv6 netmask length for the subnet. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.Subnet" Returns: Subnet resource ServiceResource / Action / create_vpc_peering_connection create_vpc_peering_connection ***************************** EC2.ServiceResource.create_vpc_peering_connection(**kwargs) Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Note: Limitations and rules apply to a VPC peering connection. For more information, see the VPC peering limitations 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". See also: AWS API Documentation **Request Syntax** vpc_peering_connection = ec2.create_vpc_peering_connection( PeerRegion='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, VpcId='string', PeerVpcId='string', PeerOwnerId='string' ) Parameters: * **PeerRegion** (*string*) -- 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. * **TagSpecifications** (*list*) -- The tags to assign to the peering connection. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the requester VPC. You must specify this parameter in the request. * **PeerVpcId** (*string*) -- The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. * **PeerOwnerId** (*string*) -- The Amazon Web Services account ID of the owner of the accepter VPC. Default: Your Amazon Web Services account ID Return type: "ec2.VpcPeeringConnection" Returns: VpcPeeringConnection resource ServiceResource / Sub-Resource / DhcpOptions DhcpOptions *********** EC2.ServiceResource.DhcpOptions(id) Creates a DhcpOptions resource.: dhcp_options = ec2.DhcpOptions('id') Parameters: **id** (*string*) -- The DhcpOptions's id identifier. This **must** be set. Return type: "EC2.DhcpOptions" Returns: A DhcpOptions resource ServiceResource / Collection / vpcs vpcs **** EC2.ServiceResource.vpcs A collection of Vpc resources.A Vpc Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Vpc resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_iterator = ec2.vpcs.all() Return type: list("ec2.Vpc") Returns: A list of Vpc resources filter(**kwargs) Creates an iterable of all Vpc resources in the collection filtered by kwargs passed to method. A Vpc collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_iterator = ec2.vpcs.filter( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpcIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpcIds** (*list*) -- The IDs of the VPCs. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: list("ec2.Vpc") Returns: A list of Vpc resources limit(**kwargs) Creates an iterable up to a specified amount of Vpc resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_iterator = ec2.vpcs.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Vpc") Returns: A list of Vpc resources page_size(**kwargs) Creates an iterable of all Vpc resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_iterator = ec2.vpcs.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Vpc") Returns: A list of Vpc resources ServiceResource / Sub-Resource / ClassicAddress ClassicAddress ************** EC2.ServiceResource.ClassicAddress(public_ip) Creates a ClassicAddress resource.: classic_address = ec2.ClassicAddress('public_ip') Parameters: **public_ip** (*string*) -- The ClassicAddress's public_ip identifier. This **must** be set. Return type: "EC2.ClassicAddress" Returns: A ClassicAddress resource ServiceResource / Sub-Resource / Subnet Subnet ****** EC2.ServiceResource.Subnet(id) Creates a Subnet resource.: subnet = ec2.Subnet('id') Parameters: **id** (*string*) -- The Subnet's id identifier. This **must** be set. Return type: "EC2.Subnet" Returns: A Subnet resource ServiceResource / Collection / internet_gateways internet_gateways ***************** EC2.ServiceResource.internet_gateways A collection of InternetGateway resources.A InternetGateway Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all InternetGateway resources in the collection. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = ec2.internet_gateways.all() Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources filter(**kwargs) Creates an iterable of all InternetGateway resources in the collection filtered by kwargs passed to method. A InternetGateway collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = ec2.internet_gateways.filter( NextToken='string', MaxResults=123, DryRun=True|False, InternetGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InternetGatewayIds** (*list*) -- The IDs of the internet gateways. Default: Describes all your internet gateways. * *(string) --* * **Filters** (*list*) -- The 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 Amazon Web Services account that owns the internet gateway. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources limit(**kwargs) Creates an iterable up to a specified amount of InternetGateway resources in the collection. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = ec2.internet_gateways.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources page_size(**kwargs) Creates an iterable of all InternetGateway resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = ec2.internet_gateways.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources ServiceResource / Sub-Resource / InternetGateway InternetGateway *************** EC2.ServiceResource.InternetGateway(id) Creates a InternetGateway resource.: internet_gateway = ec2.InternetGateway('id') Parameters: **id** (*string*) -- The InternetGateway's id identifier. This **must** be set. Return type: "EC2.InternetGateway" Returns: A InternetGateway resource ServiceResource / Collection / placement_groups placement_groups **************** EC2.ServiceResource.placement_groups A collection of PlacementGroup resources.A PlacementGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all PlacementGroup resources in the collection. See also: AWS API Documentation **Request Syntax** placement_group_iterator = ec2.placement_groups.all() Return type: list("ec2.PlacementGroup") Returns: A list of PlacementGroup resources filter(**kwargs) Creates an iterable of all PlacementGroup resources in the collection filtered by kwargs passed to method. A PlacementGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** placement_group_iterator = ec2.placement_groups.filter( GroupIds=[ 'string', ], DryRun=True|False, GroupNames=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **GroupIds** (*list*) -- The IDs of the placement groups. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **GroupNames** (*list*) -- The names of the placement groups. Constraints: * You can specify a name only if the placement group is owned by your account. * If a placement group is *shared* with your account, specifying the name results in an error. You must use the "GroupId" parameter instead. * *(string) --* * **Filters** (*list*) -- The filters. * "group-name" - The name of the placement group. * "group-arn" - The Amazon Resource Name (ARN) of the placement group. * "spread-level" - The spread level for the placement group ( "host" | "rack"). * "state" - The state of the placement group ( "pending" | "available" | "deleting" | "deleted"). * "strategy" - The strategy of the placement group ( "cluster" | "spread" | "partition"). * "tag:" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.PlacementGroup") Returns: A list of PlacementGroup resources limit(**kwargs) Creates an iterable up to a specified amount of PlacementGroup resources in the collection. See also: AWS API Documentation **Request Syntax** placement_group_iterator = ec2.placement_groups.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.PlacementGroup") Returns: A list of PlacementGroup resources page_size(**kwargs) Creates an iterable of all PlacementGroup resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** placement_group_iterator = ec2.placement_groups.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.PlacementGroup") Returns: A list of PlacementGroup resources ServiceResource / Sub-Resource / Vpc Vpc *** EC2.ServiceResource.Vpc(id) Creates a Vpc resource.: vpc = ec2.Vpc('id') Parameters: **id** (*string*) -- The Vpc's id identifier. This **must** be set. Return type: "EC2.Vpc" Returns: A Vpc resource ServiceResource / Action / create_instances create_instances **************** EC2.ServiceResource.create_instances(**kwargs) Launches the specified number of instances using an AMI for which you have permissions. You can specify a number of options, or leave the default options. The following rules apply: * If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request. * All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet. * Not all instance types support IPv6 addresses. For more information, see Instance types. * If you don't specify a security group ID, we use the default security group for the VPC. For more information, see Security groups. * If any of the AMIs have a product code attached for which the user has not subscribed, the request fails. You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters. To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances. "RunInstances" is subject to both request rate limiting and resource rate limiting. For more information, see Request throttling. An instance is ready for you to use when it's in the "running" state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources. Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs. For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance. See also: AWS API Documentation **Request Syntax** instance = ec2.create_instances( BlockDeviceMappings=[ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], ImageId='string', InstanceType='a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', Ipv6AddressCount=123, Ipv6Addresses=[ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], KernelId='string', KeyName='string', MaxCount=123, MinCount=123, Monitoring={ 'Enabled': True|False }, Placement={ 'Affinity': 'string', 'GroupName': 'string', 'PartitionNumber': 123, 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'GroupId': 'string', 'AvailabilityZone': 'string' }, RamdiskId='string', SecurityGroupIds=[ 'string', ], SecurityGroups=[ 'string', ], SubnetId='string', UserData='string', ElasticGpuSpecification=[ { 'Type': 'string' }, ], ElasticInferenceAccelerators=[ { 'Type': 'string', 'Count': 123 }, ], TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], LaunchTemplate={ 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, InstanceMarketOptions={ 'MarketType': 'spot'|'capacity-block', 'SpotOptions': { 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'BlockDurationMinutes': 123, 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' } }, CreditSpecification={ 'CpuCredits': 'string' }, CpuOptions={ 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, CapacityReservationSpecification={ 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, HibernationOptions={ 'Configured': True|False }, LicenseSpecifications=[ { 'LicenseConfigurationArn': 'string' }, ], MetadataOptions={ 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, EnclaveOptions={ 'Enabled': True|False }, PrivateDnsNameOptions={ 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, MaintenanceOptions={ 'AutoRecovery': 'disabled'|'default' }, DisableApiStop=True|False, EnablePrimaryIpv6=True|False, NetworkPerformanceOptions={ 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' }, Operator={ 'Principal': 'string' }, DryRun=True|False, DisableApiTermination=True|False, InstanceInitiatedShutdownBehavior='stop'|'terminate', PrivateIpAddress='string', ClientToken='string', AdditionalInfo='string', NetworkInterfaces=[ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], IamInstanceProfile={ 'Arn': 'string', 'Name': 'string' }, EbsOptimized=True|False ) Parameters: * **BlockDeviceMappings** (*list*) -- The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the *Amazon EC2 User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **ImageId** (*string*) -- The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. * **InstanceType** (*string*) -- The instance type. For more information, see Amazon EC2 Instance Types Guide. * **Ipv6AddressCount** (*integer*) -- 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. * **Ipv6Addresses** (*list*) -- 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **KernelId** (*string*) -- The ID of the kernel. Warning: 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** (*string*) -- The name of the key pair. For more information, see Create a key pair for your EC2 instance. Warning: 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. * **MaxCount** (*integer*) -- **[REQUIRED]** The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count. Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas. * **MinCount** (*integer*) -- **[REQUIRED]** The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances. Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas. * **Monitoring** (*dict*) -- Specifies whether detailed monitoring is enabled for the instance. * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **Placement** (*dict*) -- The placement for the instance. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. * **RamdiskId** (*string*) -- 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 Amazon Web Services Resource Center and search for the kernel ID. Warning: 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*. * **SecurityGroupIds** (*list*) -- The IDs of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. * *(string) --* * **SecurityGroups** (*list*) -- [Default VPC] The names of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. Default: Amazon EC2 uses the default security group. * *(string) --* * **SubnetId** (*string*) -- 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 instead of using this parameter. * **UserData** (*string*) -- The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data. **This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.** * **ElasticGpuSpecification** (*list*) -- An elastic GPU to associate with the instance. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. A specification for an Elastic Graphics accelerator. * **Type** *(string) --* **[REQUIRED]** The type of Elastic Graphics accelerator. * **ElasticInferenceAccelerators** (*list*) -- An elastic inference accelerator to associate with the instance. Note: Amazon Elastic Inference is no longer available. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes an elastic inference accelerator. * **Type** *(string) --* **[REQUIRED]** The type of elastic inference accelerator. The possible values are "eia1.medium", "eia1.large", "eia1.xlarge", "eia2.medium", "eia2.large", and "eia2.xlarge". * **Count** *(integer) --* The number of elastic inference accelerators to attach to the instance. Default: 1 * **TagSpecifications** (*list*) -- The tags to apply to the resources that are created during instance launch. You can specify tags for the following resources only: * Instances * Volumes * Spot Instance requests * Network interfaces To tag a resource after it has been created, see CreateTags. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **LaunchTemplate** (*dict*) -- The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". A value of "$Latest" uses the latest version of the launch template. A value of "$Default" uses the default version of the launch template. Default: The default version of the launch template. * **InstanceMarketOptions** (*dict*) -- 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". * **MarketType** *(string) --* The market type. * **SpotOptions** *(dict) --* The options for Spot Instances. * **MaxPrice** *(string) --* The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message. * **SpotInstanceType** *(string) --* The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either "hibernate" or "stop". * **BlockDurationMinutes** *(integer) --* Deprecated. * **ValidUntil** *(datetime) --* The end date of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.Image") Returns: A list of Image resources limit(**kwargs) Creates an iterable up to a specified amount of Image resources in the collection. See also: AWS API Documentation **Request Syntax** image_iterator = ec2.images.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Image") Returns: A list of Image resources page_size(**kwargs) Creates an iterable of all Image resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** image_iterator = ec2.images.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Image") Returns: A list of Image resources ServiceResource / Sub-Resource / KeyPair KeyPair ******* EC2.ServiceResource.KeyPair(name) Creates a KeyPairInfo resource.: key_pair_info = ec2.KeyPair('name') Parameters: **name** (*string*) -- The KeyPair's name identifier. This **must** be set. Return type: "EC2.KeyPairInfo" Returns: A KeyPairInfo resource ServiceResource / Sub-Resource / Image Image ***** EC2.ServiceResource.Image(id) Creates a Image resource.: image = ec2.Image('id') Parameters: **id** (*string*) -- The Image's id identifier. This **must** be set. Return type: "EC2.Image" Returns: A Image resource ServiceResource / Action / create_security_group create_security_group ********************* EC2.ServiceResource.create_security_group(**kwargs) Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the *Amazon EC2 User Guide* and Security groups for your VPC in the *Amazon VPC User Guide*. When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name. You have a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC security group limits, see Amazon VPC Limits. See also: AWS API Documentation **Request Syntax** security_group = ec2.create_security_group( Description='string', GroupName='string', VpcId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **Description** (*string*) -- **[REQUIRED]** A description for the security group. Constraints: Up to 255 characters in length Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **GroupName** (*string*) -- **[REQUIRED]** The name of the security group. Names are case-insensitive and must be unique within the VPC. Constraints: Up to 255 characters in length. Can't start with "sg-". Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **VpcId** (*string*) -- The ID of the VPC. Required for a nondefault VPC. * **TagSpecifications** (*list*) -- The tags to assign to the security group. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.SecurityGroup" Returns: SecurityGroup resource ServiceResource / Sub-Resource / PlacementGroup PlacementGroup ************** EC2.ServiceResource.PlacementGroup(name) Creates a PlacementGroup resource.: placement_group = ec2.PlacementGroup('name') Parameters: **name** (*string*) -- The PlacementGroup's name identifier. This **must** be set. Return type: "EC2.PlacementGroup" Returns: A PlacementGroup resource ServiceResource / Action / create_internet_gateway create_internet_gateway *********************** EC2.ServiceResource.create_internet_gateway(**kwargs) Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway. For more information, see Internet gateways in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** internet_gateway = ec2.create_internet_gateway( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the internet gateway. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.InternetGateway" Returns: InternetGateway resource ServiceResource / Sub-Resource / Route Route ***** EC2.ServiceResource.Route(route_table_id, destination_cidr_block) Creates a Route resource.: route = ec2.Route('route_table_id','destination_cidr_block') Parameters: * **route_table_id** (*string*) -- The Route's route_table_id identifier. This **must** be set. * **destination_cidr_block** (*string*) -- The Route's destination_cidr_block identifier. This **must** be set. Return type: "EC2.Route" Returns: A Route resource ServiceResource / Sub-Resource / VpcAddress VpcAddress ********** EC2.ServiceResource.VpcAddress(allocation_id) Creates a VpcAddress resource.: vpc_address = ec2.VpcAddress('allocation_id') Parameters: **allocation_id** (*string*) -- The VpcAddress's allocation_id identifier. This **must** be set. Return type: "EC2.VpcAddress" Returns: A VpcAddress resource ServiceResource / Collection / dhcp_options_sets dhcp_options_sets ***************** EC2.ServiceResource.dhcp_options_sets A collection of DhcpOptions resources.A DhcpOptions Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all DhcpOptions resources in the collection. See also: AWS API Documentation **Request Syntax** dhcp_options_iterator = ec2.dhcp_options_sets.all() Return type: list("ec2.DhcpOptions") Returns: A list of DhcpOptions resources filter(**kwargs) Creates an iterable of all DhcpOptions resources in the collection filtered by kwargs passed to method. A DhcpOptions collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** dhcp_options_iterator = ec2.dhcp_options_sets.filter( DhcpOptionsIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **DhcpOptionsIds** (*list*) -- The IDs of DHCP option sets. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The 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 Amazon Web Services account that owns the DHCP options set. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: list("ec2.DhcpOptions") Returns: A list of DhcpOptions resources limit(**kwargs) Creates an iterable up to a specified amount of DhcpOptions resources in the collection. See also: AWS API Documentation **Request Syntax** dhcp_options_iterator = ec2.dhcp_options_sets.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.DhcpOptions") Returns: A list of DhcpOptions resources page_size(**kwargs) Creates an iterable of all DhcpOptions resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** dhcp_options_iterator = ec2.dhcp_options_sets.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.DhcpOptions") Returns: A list of DhcpOptions resources Vpc / Action / associate_dhcp_options associate_dhcp_options ********************** EC2.Vpc.associate_dhcp_options(**kwargs) Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. For more information, see DHCP option sets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.associate_dhcp_options( DhcpOptionsId='string', DryRun=True|False ) Parameters: * **DhcpOptionsId** (*string*) -- **[REQUIRED]** The ID of the DHCP options set, or "default" to associate no DHCP options with the VPC. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Vpc / Action / describe_attribute describe_attribute ****************** EC2.Vpc.describe_attribute(**kwargs) Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = vpc.describe_attribute( Attribute='enableDnsSupport'|'enableDnsHostnames'|'enableNetworkAddressUsageMetrics', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The VPC attribute. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'EnableDnsHostnames': { 'Value': True|False }, 'EnableDnsSupport': { 'Value': True|False }, 'EnableNetworkAddressUsageMetrics': { 'Value': True|False }, 'VpcId': 'string' } **Response Structure** * *(dict) --* * **EnableDnsHostnames** *(dict) --* Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is "true", instances in the VPC get DNS hostnames; otherwise, they do not. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnableDnsSupport** *(dict) --* Indicates whether DNS resolution is enabled for the VPC. If this attribute is "true", the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnableNetworkAddressUsageMetrics** *(dict) --* Indicates whether Network Address Usage metrics are enabled for your VPC. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **VpcId** *(string) --* The ID of the VPC. Vpc / Collection / instances instances ********* EC2.Vpc.instances A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = vpc.instances.all() Return type: list("ec2.Instance") Returns: A list of Instance resources create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.instances.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None filter(**kwargs) Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method. A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** instance_iterator = vpc.instances.filter( InstanceIds=[ 'string', ], DryRun=True|False, NextToken='string', MaxResults=123 ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Return type: list("ec2.Instance") Returns: A list of Instance resources limit(**kwargs) Creates an iterable up to a specified amount of Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = vpc.instances.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Instance") Returns: A list of Instance resources monitor(**kwargs) Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the *Amazon EC2 User Guide*. To disable detailed monitoring, see UnmonitorInstances. See also: AWS API Documentation **Request Syntax** response = vpc.instances.monitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. page_size(**kwargs) Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** instance_iterator = vpc.instances.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Instance") Returns: A list of Instance resources reboot(**kwargs) Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Troubleshoot an unreachable instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.instances.reboot( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None start(**kwargs) Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. If you attempt to start a T3 instance with "host" tenancy and the "unlimited" CPU credit option, the request fails. The "unlimited" CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to "standard", or change its tenancy to "default" or "dedicated". For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.instances.start( AdditionalInfo='string', DryRun=True|False ) Parameters: * **AdditionalInfo** (*string*) -- Reserved. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'StartingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StartingInstances** *(list) --* Information about the started instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. stop(**kwargs) Stops an Amazon EBS-backed instance. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can use the StopInstances operation together with the "Hibernate" parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. If your instance appears stuck in the "stopping" state, there might be an issue with the underlying host computer. You can use the StopInstances operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing. You can't stop or hibernate instance store-backed instances. See also: AWS API Documentation **Request Syntax** response = vpc.instances.stop( Hibernate=True|False, SkipOsShutdown=True|False, DryRun=True|False, Force=True|False ) Parameters: * **Hibernate** (*boolean*) -- 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 Amazon EC2 instance in the *Amazon EC2 User Guide*. Default: "false" * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is stopped. Warning: Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*boolean*) -- Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Default: "false" Return type: dict Returns: **Response Syntax** { 'StoppingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StoppingInstances** *(list) --* Information about the stopped instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. terminate(**kwargs) Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results: * The specified instances that are in the same Availability Zone as the protected instance are not terminated. * The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated. For example, say you have the following instances: * Instance A: "us-east-1a"; Not protected * Instance B: "us-east-1a"; Not protected * Instance C: "us-east-1b"; Protected * Instance D: "us-east-1b"; not protected If you attempt to terminate all of these instances in the same request, the request reports failure with the following results: * Instance A and Instance B are successfully terminated because none of the specified instances in "us-east-1a" are enabled for termination protection. * Instance C and Instance D fail to terminate because at least one of the specified instances in "us-east-1b" (Instance C) is enabled for termination protection. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. By default, the TerminateInstances operation includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the "DeleteOnTermination" block device mapping parameter set to "true" are automatically deleted. For more information about the differences between stopping and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and Troubleshooting terminating your instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.instances.terminate( Force=True|False, SkipOsShutdown=True|False, DryRun=True|False ) Parameters: * **Force** (*boolean*) -- Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is terminated. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TerminatingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **TerminatingInstances** *(list) --* Information about the terminated instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. unmonitor(**kwargs) Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.instances.unmonitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Vpc / Waiter / wait_until_available wait_until_available ******************** EC2.Vpc.wait_until_available(**kwargs) Waits until this Vpc is available. This method calls "EC2.Waiter.vpc_available.wait()" which polls "EC2.Client.describe_vpcs()" every 15 seconds until a successful state is reached. An error is raised after 40 failed checks. See also: AWS API Documentation **Request Syntax** vpc.wait_until_available( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Vpc / Collection / security_groups security_groups *************** EC2.Vpc.security_groups A collection of SecurityGroup resources.A SecurityGroup Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all SecurityGroup resources in the collection. See also: AWS API Documentation **Request Syntax** security_group_iterator = vpc.security_groups.all() Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources filter(**kwargs) Creates an iterable of all SecurityGroup resources in the collection filtered by kwargs passed to method. A SecurityGroup collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** security_group_iterator = vpc.security_groups.filter( GroupIds=[ 'string', ], GroupNames=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, ) Parameters: * **GroupIds** (*list*) -- The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all of your security groups. * *(string) --* * **GroupNames** (*list*) -- [Default VPC] The names of the security groups. You can specify either the security group name or the security group ID. Default: Describes all of your security groups. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources limit(**kwargs) Creates an iterable up to a specified amount of SecurityGroup resources in the collection. See also: AWS API Documentation **Request Syntax** security_group_iterator = vpc.security_groups.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources page_size(**kwargs) Creates an iterable of all SecurityGroup resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** security_group_iterator = vpc.security_groups.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.SecurityGroup") Returns: A list of SecurityGroup resources Vpc / Collection / route_tables route_tables ************ EC2.Vpc.route_tables A collection of RouteTable resources.A RouteTable Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all RouteTable resources in the collection. See also: AWS API Documentation **Request Syntax** route_table_iterator = vpc.route_tables.all() Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources filter(**kwargs) Creates an iterable of all RouteTable resources in the collection filtered by kwargs passed to method. A RouteTable collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** route_table_iterator = vpc.route_tables.filter( NextToken='string', MaxResults=123, DryRun=True|False, RouteTableIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableIds** (*list*) -- The IDs of the route tables. * *(string) --* Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources limit(**kwargs) Creates an iterable up to a specified amount of RouteTable resources in the collection. See also: AWS API Documentation **Request Syntax** route_table_iterator = vpc.route_tables.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources page_size(**kwargs) Creates an iterable of all RouteTable resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** route_table_iterator = vpc.route_tables.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.RouteTable") Returns: A list of RouteTable resources Vpc / Action / detach_classic_link_instance detach_classic_link_instance **************************** EC2.Vpc.detach_classic_link_instance(**kwargs) Note: This action is deprecated. 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. See also: AWS API Documentation **Request Syntax** response = vpc.detach_classic_link_instance( DryRun=True|False, InstanceId='string', ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance to unlink from the VPC. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Vpc / Action / get_available_subresources get_available_subresources ************************** EC2.Vpc.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str Vpc / Attribute / dhcp_options_id dhcp_options_id *************** EC2.Vpc.dhcp_options_id * *(string) --* The ID of the set of DHCP options you've associated with the VPC. Vpc / Attribute / is_default is_default ********** EC2.Vpc.is_default * *(boolean) --* Indicates whether the VPC is the default VPC. Vpc / Collection / subnets subnets ******* EC2.Vpc.subnets A collection of Subnet resources.A Subnet Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Subnet resources in the collection. See also: AWS API Documentation **Request Syntax** subnet_iterator = vpc.subnets.all() Return type: list("ec2.Subnet") Returns: A list of Subnet resources filter(**kwargs) Creates an iterable of all Subnet resources in the collection filtered by kwargs passed to method. A Subnet collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** subnet_iterator = vpc.subnets.filter( SubnetIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **SubnetIds** (*list*) -- The IDs of the subnets. Default: Describes all your subnets. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: list("ec2.Subnet") Returns: A list of Subnet resources limit(**kwargs) Creates an iterable up to a specified amount of Subnet resources in the collection. See also: AWS API Documentation **Request Syntax** subnet_iterator = vpc.subnets.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Subnet") Returns: A list of Subnet resources page_size(**kwargs) Creates an iterable of all Subnet resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** subnet_iterator = vpc.subnets.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Subnet") Returns: A list of Subnet resources Vpc / Action / modify_attribute modify_attribute **************** EC2.Vpc.modify_attribute(**kwargs) Modifies the specified attribute of the specified VPC. See also: AWS API Documentation **Request Syntax** response = vpc.modify_attribute( EnableDnsHostnames={ 'Value': True|False }, EnableDnsSupport={ 'Value': True|False }, EnableNetworkAddressUsageMetrics={ 'Value': True|False } ) Parameters: * **EnableDnsHostnames** (*dict*) -- 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. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnableDnsSupport** (*dict*) -- 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. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnableNetworkAddressUsageMetrics** (*dict*) -- Indicates whether Network Address Usage metrics are enabled for your VPC. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". Returns: None Vpc / Action / attach_classic_link_instance attach_classic_link_instance **************************** EC2.Vpc.attach_classic_link_instance(**kwargs) Note: This action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the "running" state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as *attaching* your instance. See also: AWS API Documentation **Request Syntax** response = vpc.attach_classic_link_instance( DryRun=True|False, InstanceId='string', Groups=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the EC2-Classic instance. * **Groups** (*list*) -- **[REQUIRED]** The IDs of the security groups. You cannot specify security groups from a different VPC. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Vpc / Action / create_route_table create_route_table ****************** EC2.Vpc.create_route_table(**kwargs) Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** route_table = vpc.create_route_table( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', DryRun=True|False, ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the route table. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.RouteTable" Returns: RouteTable resource Vpc / Attribute / cidr_block_association_set cidr_block_association_set ************************** EC2.Vpc.cidr_block_association_set * *(list) --* Information about the IPv4 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv4 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. Vpc / Waiter / wait_until_exists wait_until_exists ***************** EC2.Vpc.wait_until_exists(**kwargs) Waits until this Vpc is exists. This method calls "EC2.Waiter.vpc_exists.wait()" which polls "EC2.Client.describe_vpcs()" every 1 seconds until a successful state is reached. An error is raised after 5 failed checks. See also: AWS API Documentation **Request Syntax** vpc.wait_until_exists( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None Vpc / Attribute / cidr_block cidr_block ********** EC2.Vpc.cidr_block * *(string) --* The primary IPv4 CIDR block for the VPC. Vpc / Attribute / instance_tenancy instance_tenancy **************** EC2.Vpc.instance_tenancy * *(string) --* The allowed tenancy of instances launched into the VPC. Vpc / Attribute / ipv6_cidr_block_association_set ipv6_cidr_block_association_set ******************************* EC2.Vpc.ipv6_cidr_block_association_set * *(list) --* Information about the IPv6 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv6 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, "us-east-1-wl1-bos- wlz-1". * **Ipv6Pool** *(string) --* The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. Vpc / Reference / dhcp_options dhcp_options ************ EC2.Vpc.dhcp_options ("DhcpOptions") The related dhcp_options if set, otherwise "None". Vpc / Action / load load **** EC2.Vpc.load() Calls "EC2.Client.describe_vpcs()" to update the attributes of the Vpc resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc.load() Returns: None EC2 / Resource / Vpc Vpc *** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.Vpc(id) A resource representing an Amazon Elastic Compute Cloud (EC2) Vpc: import boto3 ec2 = boto3.resource('ec2') vpc = ec2.Vpc('id') Parameters: **id** (*string*) -- The Vpc's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * block_public_access_states * cidr_block * cidr_block_association_set * dhcp_options_id * encryption_control * instance_tenancy * ipv6_cidr_block_association_set * is_default * owner_id * state * tags * vpc_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * dhcp_options Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * associate_dhcp_options * attach_classic_link_instance * attach_internet_gateway * create_network_acl * create_route_table * create_security_group * create_subnet * create_tags * delete * describe_attribute * detach_classic_link_instance * detach_internet_gateway * disable_classic_link * enable_classic_link * get_available_subresources * load * modify_attribute * reload * request_vpc_peering_connection Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * accepted_vpc_peering_connections * instances * internet_gateways * network_acls * network_interfaces * requested_vpc_peering_connections * route_tables * security_groups * subnets Waiters ======= Waiters provide an interface to wait for a resource to reach a specific state. For more information about waiters refer to the Resources Introduction Guide. These are the resource's available waiters: * wait_until_available * wait_until_exists Vpc / Collection / requested_vpc_peering_connections requested_vpc_peering_connections ********************************* EC2.Vpc.requested_vpc_peering_connections A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.all() Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources filter(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method. A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.filter( NextToken='string', MaxResults=123, DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources limit(**kwargs) Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources page_size(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.requested_vpc_peering_connections.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources Vpc / Collection / network_interfaces network_interfaces ****************** EC2.Vpc.network_interfaces A collection of NetworkInterface resources.A NetworkInterface Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all NetworkInterface resources in the collection. See also: AWS API Documentation **Request Syntax** network_interface_iterator = vpc.network_interfaces.all() Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources filter(**kwargs) Creates an iterable of all NetworkInterface resources in the collection filtered by kwargs passed to method. A NetworkInterface collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** network_interface_iterator = vpc.network_interfaces.filter( NextToken='string', MaxResults=123, DryRun=True|False, NetworkInterfaceIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkInterfaceIds** (*list*) -- The network interface IDs. Default: Describes all your network interfaces. * *(string) --* Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources limit(**kwargs) Creates an iterable up to a specified amount of NetworkInterface resources in the collection. See also: AWS API Documentation **Request Syntax** network_interface_iterator = vpc.network_interfaces.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources page_size(**kwargs) Creates an iterable of all NetworkInterface resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** network_interface_iterator = vpc.network_interfaces.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.NetworkInterface") Returns: A list of NetworkInterface resources Vpc / Collection / network_acls network_acls ************ EC2.Vpc.network_acls A collection of NetworkAcl resources.A NetworkAcl Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all NetworkAcl resources in the collection. See also: AWS API Documentation **Request Syntax** network_acl_iterator = vpc.network_acls.all() Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources filter(**kwargs) Creates an iterable of all NetworkAcl resources in the collection filtered by kwargs passed to method. A NetworkAcl collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** network_acl_iterator = vpc.network_acls.filter( NextToken='string', MaxResults=123, DryRun=True|False, NetworkAclIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclIds** (*list*) -- The IDs of the network ACLs. * *(string) --* Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources limit(**kwargs) Creates an iterable up to a specified amount of NetworkAcl resources in the collection. See also: AWS API Documentation **Request Syntax** network_acl_iterator = vpc.network_acls.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources page_size(**kwargs) Creates an iterable of all NetworkAcl resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** network_acl_iterator = vpc.network_acls.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.NetworkAcl") Returns: A list of NetworkAcl resources Vpc / Action / create_network_acl create_network_acl ****************** EC2.Vpc.create_network_acl(**kwargs) Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** network_acl = vpc.create_network_acl( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', DryRun=True|False, ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the network ACL. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.NetworkAcl" Returns: NetworkAcl resource Vpc / Action / create_tags create_tags *********** EC2.Vpc.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = vpc.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources Vpc / Action / create_subnet create_subnet ************* EC2.Vpc.create_subnet(**kwargs) Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block. The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). Amazon Web Services reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use. If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information, see Subnets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** subnet = vpc.create_subnet( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], AvailabilityZone='string', AvailabilityZoneId='string', CidrBlock='string', Ipv6CidrBlock='string', OutpostArn='string', Ipv6Native=True|False, Ipv4IpamPoolId='string', Ipv4NetmaskLength=123, Ipv6IpamPoolId='string', Ipv6NetmaskLength=123, DryRun=True|False ) Parameters: * **TagSpecifications** (*list*) -- The tags to assign to the subnet. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AvailabilityZone** (*string*) -- The Availability Zone or Local Zone for the subnet. Default: Amazon Web Services 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 Local Zones. To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN. * **AvailabilityZoneId** (*string*) -- The AZ ID or the Local Zone ID of the subnet. * **CidrBlock** (*string*) -- 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". This parameter is not supported for an IPv6 only subnet. * **Ipv6CidrBlock** (*string*) -- The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet. * **OutpostArn** (*string*) -- 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. * **Ipv6Native** (*boolean*) -- Indicates whether to create an IPv6 only subnet. * **Ipv4IpamPoolId** (*string*) -- An IPv4 IPAM pool ID for the subnet. * **Ipv4NetmaskLength** (*integer*) -- An IPv4 netmask length for the subnet. * **Ipv6IpamPoolId** (*string*) -- An IPv6 IPAM pool ID for the subnet. * **Ipv6NetmaskLength** (*integer*) -- An IPv6 netmask length for the subnet. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.Subnet" Returns: Subnet resource Vpc / Action / enable_classic_link enable_classic_link ******************* EC2.Vpc.enable_classic_link(**kwargs) Note: This action is deprecated. 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. See also: AWS API Documentation **Request Syntax** response = vpc.enable_classic_link( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Vpc / Attribute / block_public_access_states block_public_access_states ************************** EC2.Vpc.block_public_access_states * *(dict) --* The state of VPC Block Public Access (BPA). * **InternetGatewayBlockMode** *(string) --* The mode of VPC BPA. * "off": VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. * "block-bidirectional": Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets). * "block-ingress": Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established. Vpc / Action / detach_internet_gateway detach_internet_gateway *********************** EC2.Vpc.detach_internet_gateway(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = vpc.detach_internet_gateway( DryRun=True|False, InternetGatewayId='string', ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the internet gateway. Returns: None Vpc / Collection / internet_gateways internet_gateways ***************** EC2.Vpc.internet_gateways A collection of InternetGateway resources.A InternetGateway Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all InternetGateway resources in the collection. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = vpc.internet_gateways.all() Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources filter(**kwargs) Creates an iterable of all InternetGateway resources in the collection filtered by kwargs passed to method. A InternetGateway collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = vpc.internet_gateways.filter( NextToken='string', MaxResults=123, DryRun=True|False, InternetGatewayIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InternetGatewayIds** (*list*) -- The IDs of the internet gateways. Default: Describes all your internet gateways. * *(string) --* Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources limit(**kwargs) Creates an iterable up to a specified amount of InternetGateway resources in the collection. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = vpc.internet_gateways.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources page_size(**kwargs) Creates an iterable of all InternetGateway resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** internet_gateway_iterator = vpc.internet_gateways.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.InternetGateway") Returns: A list of InternetGateway resources Vpc / Action / request_vpc_peering_connection request_vpc_peering_connection ****************************** EC2.Vpc.request_vpc_peering_connection(**kwargs) Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. Note: Limitations and rules apply to a VPC peering connection. For more information, see the VPC peering limitations 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". See also: AWS API Documentation **Request Syntax** vpc_peering_connection = vpc.request_vpc_peering_connection( PeerRegion='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, PeerVpcId='string', PeerOwnerId='string' ) Parameters: * **PeerRegion** (*string*) -- 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. * **TagSpecifications** (*list*) -- The tags to assign to the peering connection. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PeerVpcId** (*string*) -- The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. * **PeerOwnerId** (*string*) -- The Amazon Web Services account ID of the owner of the accepter VPC. Default: Your Amazon Web Services account ID Return type: "ec2.VpcPeeringConnection" Returns: VpcPeeringConnection resource Vpc / Attribute / encryption_control encryption_control ****************** EC2.Vpc.encryption_control * *(dict) --* * **VpcId** *(string) --* * **VpcEncryptionControlId** *(string) --* * **Mode** *(string) --* * **State** *(string) --* * **StateMessage** *(string) --* * **ResourceExclusions** *(dict) --* * **InternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **EgressOnlyInternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **NatGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VirtualPrivateGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VpcPeering** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **Tags** *(list) --* * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Vpc / Action / attach_internet_gateway attach_internet_gateway *********************** EC2.Vpc.attach_internet_gateway(**kwargs) Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = vpc.attach_internet_gateway( DryRun=True|False, InternetGatewayId='string', ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the internet gateway. Returns: None Vpc / Action / reload reload ****** EC2.Vpc.reload() Calls "EC2.Client.describe_vpcs()" to update the attributes of the Vpc resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** vpc.reload() Returns: None Vpc / Action / disable_classic_link disable_classic_link ******************** EC2.Vpc.disable_classic_link(**kwargs) Note: This action is deprecated. Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. See also: AWS API Documentation **Request Syntax** response = vpc.disable_classic_link( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. Vpc / Collection / accepted_vpc_peering_connections accepted_vpc_peering_connections ******************************** EC2.Vpc.accepted_vpc_peering_connections A collection of VpcPeeringConnection resources.A VpcPeeringConnection Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.all() Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources filter(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection filtered by kwargs passed to method. A VpcPeeringConnection collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.filter( NextToken='string', MaxResults=123, DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources limit(**kwargs) Creates an iterable up to a specified amount of VpcPeeringConnection resources in the collection. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources page_size(**kwargs) Creates an iterable of all VpcPeeringConnection resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** vpc_peering_connection_iterator = vpc.accepted_vpc_peering_connections.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.VpcPeeringConnection") Returns: A list of VpcPeeringConnection resources Vpc / Attribute / state state ***** EC2.Vpc.state * *(string) --* The current state of the VPC. Vpc / Action / create_security_group create_security_group ********************* EC2.Vpc.create_security_group(**kwargs) Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the *Amazon EC2 User Guide* and Security groups for your VPC in the *Amazon VPC User Guide*. When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name. You have a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress. For more information about VPC security group limits, see Amazon VPC Limits. See also: AWS API Documentation **Request Syntax** security_group = vpc.create_security_group( Description='string', GroupName='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **Description** (*string*) -- **[REQUIRED]** A description for the security group. Constraints: Up to 255 characters in length Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **GroupName** (*string*) -- **[REQUIRED]** The name of the security group. Names are case-insensitive and must be unique within the VPC. Constraints: Up to 255 characters in length. Can't start with "sg-". Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **TagSpecifications** (*list*) -- The tags to assign to the security group. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: "ec2.SecurityGroup" Returns: SecurityGroup resource Vpc / Attribute / vpc_id vpc_id ****** EC2.Vpc.vpc_id * *(string) --* The ID of the VPC. Vpc / Identifier / id id ** EC2.Vpc.id *(string)* The Vpc's id identifier. This **must** be set. Vpc / Attribute / owner_id owner_id ******** EC2.Vpc.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the VPC. Vpc / Attribute / tags tags **** EC2.Vpc.tags * *(list) --* Any tags assigned to the VPC. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Vpc / Action / delete delete ****** EC2.Vpc.delete(**kwargs) Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the default security group, network ACL, and route table for the VPC. If you created a flow log for the VPC that you are deleting, note that flow logs for deleted VPCs are eventually automatically removed. See also: AWS API Documentation **Request Syntax** response = vpc.delete( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None RouteTable / Attribute / routes_attribute routes_attribute **************** EC2.RouteTable.routes_attribute * *(list) --* The routes in the route table. * *(dict) --* Describes a route in a route table. * **DestinationCidrBlock** *(string) --* The IPv4 CIDR block used for the destination match. * **DestinationIpv6CidrBlock** *(string) --* The IPv6 CIDR block used for the destination match. * **DestinationPrefixListId** *(string) --* The prefix of the Amazon Web Services service. * **EgressOnlyInternetGatewayId** *(string) --* The ID of the egress-only internet gateway. * **GatewayId** *(string) --* The ID of a gateway attached to your VPC. * **InstanceId** *(string) --* The ID of a NAT instance in your VPC. * **InstanceOwnerId** *(string) --* The ID of Amazon Web Services account that owns the instance. * **NatGatewayId** *(string) --* The ID of a NAT gateway. * **TransitGatewayId** *(string) --* The ID of a transit gateway. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **CarrierGatewayId** *(string) --* The ID of the carrier gateway. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **Origin** *(string) --* Describes how the route was created. * "CreateRouteTable" - The route was automatically created when the route table was created. * "CreateRoute" - The route was manually added to the route table. * "EnableVgwRoutePropagation" - The route was propagated by route propagation. * **State** *(string) --* The state of the route. The "blackhole" state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). * **VpcPeeringConnectionId** *(string) --* The ID of a VPC peering connection. * **CoreNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the core network. * **OdbNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the ODB network. * **IpAddress** *(string) --* The next hop IP address for routes propagated by VPC Route Server into VPC route tables. RouteTable / Reference / associations associations ************ EC2.RouteTable.associations ("RouteTableAssociation") The related associations if set, otherwise "None". RouteTable / Action / get_available_subresources get_available_subresources ************************** EC2.RouteTable.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str RouteTable / Action / create_route create_route ************ EC2.RouteTable.create_route(**kwargs) Creates a route in a route table within a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address "192.0.2.3", and the route table includes the following two IPv4 routes: * "192.0.2.0/24" (goes to some target A) * "192.0.2.0/28" (goes to some target B) Both routes apply to the traffic destined for "192.0.2.3". However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** route = route_table.create_route( DestinationPrefixListId='string', VpcEndpointId='string', TransitGatewayId='string', LocalGatewayId='string', CarrierGatewayId='string', CoreNetworkArn='string', OdbNetworkArn='string', DryRun=True|False, DestinationCidrBlock='string', GatewayId='string', DestinationIpv6CidrBlock='string', EgressOnlyInternetGatewayId='string', InstanceId='string', NetworkInterfaceId='string', VpcPeeringConnectionId='string', NatGatewayId='string' ) Parameters: * **DestinationPrefixListId** (*string*) -- The ID of a prefix list used for the destination match. * **VpcEndpointId** (*string*) -- The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. * **TransitGatewayId** (*string*) -- The ID of a transit gateway. * **LocalGatewayId** (*string*) -- The ID of the local gateway. * **CarrierGatewayId** (*string*) -- 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. * **CoreNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the core network. * **OdbNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the ODB network. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **DestinationCidrBlock** (*string*) -- 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". * **GatewayId** (*string*) -- The ID of an internet gateway or virtual private gateway attached to your VPC. * **DestinationIpv6CidrBlock** (*string*) -- The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. * **EgressOnlyInternetGatewayId** (*string*) -- [IPv6 traffic only] The ID of an egress-only internet gateway. * **InstanceId** (*string*) -- 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. * **NetworkInterfaceId** (*string*) -- The ID of a network interface. * **VpcPeeringConnectionId** (*string*) -- The ID of a VPC peering connection. * **NatGatewayId** (*string*) -- [IPv4 traffic only] The ID of a NAT gateway. Return type: "ec2.Route" Returns: Route resource RouteTable / Action / load load **** EC2.RouteTable.load() Calls "EC2.Client.describe_route_tables()" to update the attributes of the RouteTable resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** route_table.load() Returns: None RouteTable / Attribute / route_table_id route_table_id ************** EC2.RouteTable.route_table_id * *(string) --* The ID of the route table. EC2 / Resource / RouteTable RouteTable ********** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.RouteTable(id) A resource representing an Amazon Elastic Compute Cloud (EC2) RouteTable: import boto3 ec2 = boto3.resource('ec2') route_table = ec2.RouteTable('id') Parameters: **id** (*string*) -- The RouteTable's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * associations_attribute * owner_id * propagating_vgws * route_table_id * routes_attribute * tags * vpc_id References ========== References are related resource instances that have a belongs-to relationship. For more information about references refer to the Resources Introduction Guide. These are the resource's available references: * associations * routes * vpc Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * associate_with_subnet * create_route * create_tags * delete * get_available_subresources * load * reload RouteTable / Attribute / associations_attribute associations_attribute ********************** EC2.RouteTable.associations_attribute * *(list) --* The associations between the route table and your subnets or gateways. * *(dict) --* Describes an association between a route table and a subnet or gateway. * **Main** *(boolean) --* Indicates whether this is the main route table. * **RouteTableAssociationId** *(string) --* The ID of the association. * **RouteTableId** *(string) --* The ID of the route table. * **SubnetId** *(string) --* The ID of the subnet. A subnet ID is not returned for an implicit association. * **GatewayId** *(string) --* The ID of the internet gateway or virtual private gateway. * **AssociationState** *(dict) --* The state of the association. * **State** *(string) --* The state of the association. * **StatusMessage** *(string) --* The status message, if applicable. RouteTable / Action / create_tags create_tags *********** EC2.RouteTable.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = route_table.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources RouteTable / Attribute / propagating_vgws propagating_vgws **************** EC2.RouteTable.propagating_vgws * *(list) --* Any virtual private gateway (VGW) propagating routes. * *(dict) --* Describes a virtual private gateway propagating route. * **GatewayId** *(string) --* The ID of the virtual private gateway. RouteTable / Reference / vpc vpc *** EC2.RouteTable.vpc ("Vpc") The related vpc if set, otherwise "None". RouteTable / Action / reload reload ****** EC2.RouteTable.reload() Calls "EC2.Client.describe_route_tables()" to update the attributes of the RouteTable resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** route_table.reload() Returns: None RouteTable / Attribute / vpc_id vpc_id ****** EC2.RouteTable.vpc_id * *(string) --* The ID of the VPC. RouteTable / Action / associate_with_subnet associate_with_subnet ********************* EC2.RouteTable.associate_with_subnet(**kwargs) Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** route_table_association = route_table.associate_with_subnet( GatewayId='string', DryRun=True|False, SubnetId='string', ) Parameters: * **GatewayId** (*string*) -- The ID of the internet gateway or virtual private gateway. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the subnet. Return type: "ec2.RouteTableAssociation" Returns: RouteTableAssociation resource RouteTable / Identifier / id id ** EC2.RouteTable.id *(string)* The RouteTable's id identifier. This **must** be set. RouteTable / Attribute / owner_id owner_id ******** EC2.RouteTable.owner_id * *(string) --* The ID of the Amazon Web Services account that owns the route table. RouteTable / Attribute / tags tags **** EC2.RouteTable.tags * *(list) --* Any tags assigned to the route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. RouteTable / Action / delete delete ****** EC2.RouteTable.delete(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = route_table.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None RouteTable / Reference / routes routes ****** EC2.RouteTable.routes ("Route") The related routes if set, otherwise "None". SecurityGroup / Attribute / group_name group_name ********** EC2.SecurityGroup.group_name * *(string) --* The name of the security group. SecurityGroup / Action / get_available_subresources get_available_subresources ************************** EC2.SecurityGroup.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str SecurityGroup / Attribute / ip_permissions_egress ip_permissions_egress ********************* EC2.SecurityGroup.ip_permissions_egress * *(list) --* The outbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. SecurityGroup / Attribute / security_group_arn security_group_arn ****************** EC2.SecurityGroup.security_group_arn * *(string) --* The ARN of the security group. SecurityGroup / Attribute / ip_permissions ip_permissions ************** EC2.SecurityGroup.ip_permissions * *(list) --* The inbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. SecurityGroup / Action / load load **** EC2.SecurityGroup.load() Calls "EC2.Client.describe_security_groups()" to update the attributes of the SecurityGroup resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** security_group.load() Returns: None EC2 / Resource / SecurityGroup SecurityGroup ************* Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.SecurityGroup(id) A resource representing an Amazon Elastic Compute Cloud (EC2) SecurityGroup: import boto3 ec2 = boto3.resource('ec2') security_group = ec2.SecurityGroup('id') Parameters: **id** (*string*) -- The SecurityGroup's id identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * id Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * description * group_id * group_name * ip_permissions * ip_permissions_egress * owner_id * security_group_arn * tags * vpc_id Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * authorize_egress * authorize_ingress * create_tags * delete * get_available_subresources * load * reload * revoke_egress * revoke_ingress SecurityGroup / Action / create_tags create_tags *********** EC2.SecurityGroup.create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** tag = security_group.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: list("ec2.Tag") Returns: A list of Tag resources SecurityGroup / Action / authorize_ingress authorize_ingress ***************** EC2.SecurityGroup.authorize_ingress(**kwargs) Adds the specified inbound (ingress) rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules. You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the *Amazon EC2 User Guide*. For more information about security group quotas, see Amazon VPC quotas in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = security_group.authorize_ingress( CidrIp='string', FromPort=123, GroupName='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], IpProtocol='string', SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', ToPort=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **CidrIp** (*string*) -- The IPv4 address range, in CIDR format. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. To specify an IPv6 address range, use IP permissions instead. To specify multiple rules and descriptions for the rules, use IP permissions instead. * **FromPort** (*integer*) -- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types). To specify multiple rules and descriptions for the rules, use IP permissions instead. * **GroupName** (*string*) -- [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group. * **IpPermissions** (*list*) -- The permissions for the security group rules. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **IpProtocol** (*string*) -- The IP protocol name ( "tcp", "udp", "icmp") or number (see Protocol Numbers). To specify all protocols, use "-1". To specify "icmpv6", use IP permissions instead. If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify. To specify multiple rules and descriptions for the rules, use IP permissions instead. * **SourceSecurityGroupName** (*string*) -- [Default VPC] The name of the source security group. The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead. * **SourceSecurityGroupOwnerId** (*string*) -- The Amazon Web Services account ID for the source security group, if the source security group is in a different account. The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead. * **ToPort** (*integer*) -- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). To specify multiple rules and descriptions for the rules, use IP permissions instead. * **TagSpecifications** (*list*) -- The tags applied to the security group rule. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'SecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'GroupOwnerId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupInfo': { 'GroupId': 'string', 'PeeringStatus': 'string', 'UserId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string' }, 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SecurityGroupRuleArn': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **SecurityGroupRules** *(list) --* Information about the inbound (ingress) security group rules that were added. * *(dict) --* Describes a security group rule. * **SecurityGroupRuleId** *(string) --* The ID of the security group rule. * **GroupId** *(string) --* The ID of the security group. * **GroupOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the security group. * **IsEgress** *(boolean) --* Indicates whether the security group rule is an outbound rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **CidrIpv4** *(string) --* The IPv4 CIDR range. * **CidrIpv6** *(string) --* The IPv6 CIDR range. * **PrefixListId** *(string) --* The ID of the prefix list. * **ReferencedGroupInfo** *(dict) --* Describes the security group that is referenced in the rule. * **GroupId** *(string) --* The ID of the security group. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **UserId** *(string) --* The Amazon Web Services account ID. * **VpcId** *(string) --* The ID of the VPC. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection (if applicable). * **Description** *(string) --* The security group rule description. * **Tags** *(list) --* The tags applied to the security group rule. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupRuleArn** *(string) --* The ARN of the security group rule. SecurityGroup / Action / reload reload ****** EC2.SecurityGroup.reload() Calls "EC2.Client.describe_security_groups()" to update the attributes of the SecurityGroup resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** security_group.reload() Returns: None SecurityGroup / Action / authorize_egress authorize_egress **************** EC2.SecurityGroup.authorize_egress(**kwargs) Adds the specified outbound (egress) rules to a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules. You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code. Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the *Amazon EC2 User Guide*. For information about security group quotas, see Amazon VPC quotas in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = security_group.authorize_egress( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', IpProtocol='string', FromPort=123, ToPort=123, CidrIp='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ] ) Parameters: * **TagSpecifications** (*list*) -- The tags applied to the security group rule. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SourceSecurityGroupName** (*string*) -- Not supported. Use IP permissions instead. * **SourceSecurityGroupOwnerId** (*string*) -- Not supported. Use IP permissions instead. * **IpProtocol** (*string*) -- Not supported. Use IP permissions instead. * **FromPort** (*integer*) -- Not supported. Use IP permissions instead. * **ToPort** (*integer*) -- Not supported. Use IP permissions instead. * **CidrIp** (*string*) -- Not supported. Use IP permissions instead. * **IpPermissions** (*list*) -- The permissions for the security group rules. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'SecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'GroupOwnerId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupInfo': { 'GroupId': 'string', 'PeeringStatus': 'string', 'UserId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string' }, 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SecurityGroupRuleArn': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **SecurityGroupRules** *(list) --* Information about the outbound (egress) security group rules that were added. * *(dict) --* Describes a security group rule. * **SecurityGroupRuleId** *(string) --* The ID of the security group rule. * **GroupId** *(string) --* The ID of the security group. * **GroupOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the security group. * **IsEgress** *(boolean) --* Indicates whether the security group rule is an outbound rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **CidrIpv4** *(string) --* The IPv4 CIDR range. * **CidrIpv6** *(string) --* The IPv6 CIDR range. * **PrefixListId** *(string) --* The ID of the prefix list. * **ReferencedGroupInfo** *(dict) --* Describes the security group that is referenced in the rule. * **GroupId** *(string) --* The ID of the security group. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **UserId** *(string) --* The Amazon Web Services account ID. * **VpcId** *(string) --* The ID of the VPC. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection (if applicable). * **Description** *(string) --* The security group rule description. * **Tags** *(list) --* The tags applied to the security group rule. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupRuleArn** *(string) --* The ARN of the security group rule. SecurityGroup / Attribute / vpc_id vpc_id ****** EC2.SecurityGroup.vpc_id * *(string) --* The ID of the VPC for the security group. SecurityGroup / Attribute / group_id group_id ******** EC2.SecurityGroup.group_id * *(string) --* The ID of the security group. SecurityGroup / Action / revoke_ingress revoke_ingress ************** EC2.SecurityGroup.revoke_ingress(**kwargs) Removes the specified inbound (ingress) rules from a security group. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. For a non-default VPC, if the values you specify do not match the existing rule's values, an "InvalidPermission.NotFound" client error is returned, and no rules are revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. See also: AWS API Documentation **Request Syntax** response = security_group.revoke_ingress( CidrIp='string', FromPort=123, GroupName='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], IpProtocol='string', SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', ToPort=123, SecurityGroupRuleIds=[ 'string', ], DryRun=True|False ) Parameters: * **CidrIp** (*string*) -- The CIDR IP address range. You can't specify this parameter when specifying a source security group. * **FromPort** (*integer*) -- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types). * **GroupName** (*string*) -- [Default VPC] The name 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. * **IpPermissions** (*list*) -- 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. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **IpProtocol** (*string*) -- The IP protocol name ( "tcp", "udp", "icmp") or number (see Protocol Numbers). Use "-1" to specify all. * **SourceSecurityGroupName** (*string*) -- [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. 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** (*string*) -- Not supported. * **ToPort** (*integer*) -- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'UnknownIpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'RevokedSecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupId': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **UnknownIpPermissions** *(list) --* The inbound rules that were unknown to the service. In some cases, "unknownIpPermissionSet" might be in a different format from the request parameter. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **RevokedSecurityGroupRules** *(list) --* Details about the revoked security group rules. * *(dict) --* A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress. * **SecurityGroupRuleId** *(string) --* A security group rule ID. * **GroupId** *(string) --* A security group ID. * **IsEgress** *(boolean) --* Defines if a security group rule is an outbound rule. * **IpProtocol** *(string) --* The security group rule's protocol. * **FromPort** *(integer) --* The 'from' port number of the security group rule. * **ToPort** *(integer) --* The 'to' port number of the security group rule. * **CidrIpv4** *(string) --* The IPv4 CIDR of the traffic source. * **CidrIpv6** *(string) --* The IPv6 CIDR of the traffic source. * **PrefixListId** *(string) --* The ID of a prefix list that's the traffic source. * **ReferencedGroupId** *(string) --* The ID of a referenced security group. * **Description** *(string) --* A description of the revoked security group rule. SecurityGroup / Identifier / id id ** EC2.SecurityGroup.id *(string)* The SecurityGroup's id identifier. This **must** be set. SecurityGroup / Attribute / owner_id owner_id ******** EC2.SecurityGroup.owner_id * *(string) --* The Amazon Web Services account ID of the owner of the security group. SecurityGroup / Attribute / description description *********** EC2.SecurityGroup.description * *(string) --* A description of the security group. SecurityGroup / Action / revoke_egress revoke_egress ************* EC2.SecurityGroup.revoke_egress(**kwargs) Removes the specified outbound (egress) rules from the specified security group. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. See also: AWS API Documentation **Request Syntax** response = security_group.revoke_egress( SecurityGroupRuleIds=[ 'string', ], DryRun=True|False, SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', IpProtocol='string', FromPort=123, ToPort=123, CidrIp='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ] ) Parameters: * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SourceSecurityGroupName** (*string*) -- Not supported. Use a set of IP permissions to specify a destination security group. * **SourceSecurityGroupOwnerId** (*string*) -- Not supported. Use a set of IP permissions to specify a destination security group. * **IpProtocol** (*string*) -- Not supported. Use a set of IP permissions to specify the protocol name or number. * **FromPort** (*integer*) -- Not supported. Use a set of IP permissions to specify the port. * **ToPort** (*integer*) -- Not supported. Use a set of IP permissions to specify the port. * **CidrIp** (*string*) -- Not supported. Use a set of IP permissions to specify the CIDR. * **IpPermissions** (*list*) -- 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. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'UnknownIpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'RevokedSecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupId': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **UnknownIpPermissions** *(list) --* The outbound rules that were unknown to the service. In some cases, "unknownIpPermissionSet" might be in a different format from the request parameter. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **RevokedSecurityGroupRules** *(list) --* Details about the revoked security group rules. * *(dict) --* A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress. * **SecurityGroupRuleId** *(string) --* A security group rule ID. * **GroupId** *(string) --* A security group ID. * **IsEgress** *(boolean) --* Defines if a security group rule is an outbound rule. * **IpProtocol** *(string) --* The security group rule's protocol. * **FromPort** *(integer) --* The 'from' port number of the security group rule. * **ToPort** *(integer) --* The 'to' port number of the security group rule. * **CidrIpv4** *(string) --* The IPv4 CIDR of the traffic source. * **CidrIpv6** *(string) --* The IPv6 CIDR of the traffic source. * **PrefixListId** *(string) --* The ID of a prefix list that's the traffic source. * **ReferencedGroupId** *(string) --* The ID of a referenced security group. * **Description** *(string) --* A description of the revoked security group rule. SecurityGroup / Attribute / tags tags **** EC2.SecurityGroup.tags * *(list) --* Any tags assigned to the security group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. SecurityGroup / Action / delete delete ****** EC2.SecurityGroup.delete(**kwargs) Deletes a security group. If you attempt to delete a security group that is associated with an instance or network interface, is referenced by another security group in the same VPC, or has a VPC association, the operation fails with "DependencyViolation". See also: AWS API Documentation **Request Syntax** response = security_group.delete( GroupName='string', DryRun=True|False ) Parameters: * **GroupName** (*string*) -- [Default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify the security group ID. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'GroupId': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **GroupId** *(string) --* The ID of the deleted security group. PlacementGroup / Collection / instances instances ********* EC2.PlacementGroup.instances A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources. all() Creates an iterable of all Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = placement_group.instances.all() Return type: list("ec2.Instance") Returns: A list of Instance resources create_tags(**kwargs) Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.create_tags( DryRun=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Tags** (*list*) -- **[REQUIRED]** 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None filter(**kwargs) Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method. A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources. See also: AWS API Documentation **Request Syntax** instance_iterator = placement_group.instances.filter( InstanceIds=[ 'string', ], DryRun=True|False, NextToken='string', MaxResults=123 ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Return type: list("ec2.Instance") Returns: A list of Instance resources limit(**kwargs) Creates an iterable up to a specified amount of Instance resources in the collection. See also: AWS API Documentation **Request Syntax** instance_iterator = placement_group.instances.limit( count=123 ) Parameters: **count** (*integer*) -- The limit to the number of resources in the iterable. Return type: list("ec2.Instance") Returns: A list of Instance resources monitor(**kwargs) Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the *Amazon EC2 User Guide*. To disable detailed monitoring, see UnmonitorInstances. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.monitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. page_size(**kwargs) Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount. See also: AWS API Documentation **Request Syntax** instance_iterator = placement_group.instances.page_size( count=123 ) Parameters: **count** (*integer*) -- The number of items returned by each service call Return type: list("ec2.Instance") Returns: A list of Instance resources reboot(**kwargs) Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see Troubleshoot an unreachable instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.reboot( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None start(**kwargs) Starts an Amazon EBS-backed instance that you've previously stopped. Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. Performing this operation on an instance that uses an instance store as its root device returns an error. If you attempt to start a T3 instance with "host" tenancy and the "unlimited" CPU credit option, the request fails. The "unlimited" CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to "standard", or change its tenancy to "default" or "dedicated". For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.start( AdditionalInfo='string', DryRun=True|False ) Parameters: * **AdditionalInfo** (*string*) -- Reserved. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'StartingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StartingInstances** *(list) --* Information about the started instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. stop(**kwargs) Stops an Amazon EBS-backed instance. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the *Amazon EC2 User Guide*. When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can use the StopInstances operation together with the "Hibernate" parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. If your instance appears stuck in the "stopping" state, there might be an issue with the underlying host computer. You can use the StopInstances operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing. You can't stop or hibernate instance store-backed instances. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.stop( Hibernate=True|False, SkipOsShutdown=True|False, DryRun=True|False, Force=True|False ) Parameters: * **Hibernate** (*boolean*) -- 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 Amazon EC2 instance in the *Amazon EC2 User Guide*. Default: "false" * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is stopped. Warning: Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*boolean*) -- Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the *Amazon EC2 User Guide*. Default: "false" Return type: dict Returns: **Response Syntax** { 'StoppingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **StoppingInstances** *(list) --* Information about the stopped instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. terminate(**kwargs) Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated. If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results: * The specified instances that are in the same Availability Zone as the protected instance are not terminated. * The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated. For example, say you have the following instances: * Instance A: "us-east-1a"; Not protected * Instance B: "us-east-1a"; Not protected * Instance C: "us-east-1b"; Protected * Instance D: "us-east-1b"; not protected If you attempt to terminate all of these instances in the same request, the request reports failure with the following results: * Instance A and Instance B are successfully terminated because none of the specified instances in "us-east-1a" are enabled for termination protection. * Instance C and Instance D fail to terminate because at least one of the specified instances in "us-east-1b" (Instance C) is enabled for termination protection. Terminated instances remain visible after termination (for approximately one hour). By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. By default, the TerminateInstances operation includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the "skipOsShutdown" parameter; however, this might risk data integrity. You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the "DeleteOnTermination" block device mapping parameter set to "true" are automatically deleted. For more information about the differences between stopping and terminating instances, see Amazon EC2 instance state changes in the *Amazon EC2 User Guide*. When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see Terminate Amazon EC2 instances and Troubleshooting terminating your instance in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.terminate( Force=True|False, SkipOsShutdown=True|False, DryRun=True|False ) Parameters: * **Force** (*boolean*) -- Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata. * **SkipOsShutdown** (*boolean*) -- Specifies whether to bypass the graceful OS shutdown process when the instance is terminated. Default: "false" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TerminatingInstances': [ { 'InstanceId': 'string', 'CurrentState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PreviousState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' } }, ] } **Response Structure** * *(dict) --* * **TerminatingInstances** *(list) --* Information about the terminated instances. * *(dict) --* Describes an instance state change. * **InstanceId** *(string) --* The ID of the instance. * **CurrentState** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PreviousState** *(dict) --* The previous state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. unmonitor(**kwargs) Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = placement_group.instances.unmonitor( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceMonitorings': [ { 'InstanceId': 'string', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' } }, ] } **Response Structure** * *(dict) --* * **InstanceMonitorings** *(list) --* The monitoring information. * *(dict) --* Describes the monitoring of an instance. * **InstanceId** *(string) --* The ID of the instance. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. PlacementGroup / Attribute / strategy strategy ******** EC2.PlacementGroup.strategy * *(string) --* The placement strategy. PlacementGroup / Attribute / group_name group_name ********** EC2.PlacementGroup.group_name * *(string) --* The name of the placement group. PlacementGroup / Action / get_available_subresources get_available_subresources ************************** EC2.PlacementGroup.get_available_subresources() Returns a list of all the available sub-resources for this Resource. Returns: A list containing the name of each sub-resource for this resource Return type: list of str PlacementGroup / Attribute / group_arn group_arn ********* EC2.PlacementGroup.group_arn * *(string) --* The Amazon Resource Name (ARN) of the placement group. PlacementGroup / Action / load load **** EC2.PlacementGroup.load() Calls "EC2.Client.describe_placement_groups()" to update the attributes of the PlacementGroup resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** placement_group.load() Returns: None EC2 / Resource / PlacementGroup PlacementGroup ************** Note: Before using anything on this page, please refer to the resources user guide for the most recent guidance on using resources. class EC2.PlacementGroup(name) A resource representing an Amazon Elastic Compute Cloud (EC2) PlacementGroup: import boto3 ec2 = boto3.resource('ec2') placement_group = ec2.PlacementGroup('name') Parameters: **name** (*string*) -- The PlacementGroup's name identifier. This **must** be set. Identifiers =========== Identifiers are properties of a resource that are set upon instantiation of the resource. For more information about identifiers refer to the Resources Introduction Guide. These are the resource's available identifiers: * name Attributes ========== Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the "load()" method. For more information about attributes refer to the Resources Introduction Guide. These are the resource's available attributes: * group_arn * group_id * group_name * partition_count * spread_level * state * strategy * tags Actions ======= Actions call operations on resources. They may automatically handle the passing in of arguments set from identifiers and some attributes. For more information about actions refer to the Resources Introduction Guide. These are the resource's available actions: * delete * get_available_subresources * load * reload Collections =========== Collections provide an interface to iterate over and manipulate groups of resources. For more information about collections refer to the Resources Introduction Guide. These are the resource's available collections: * instances PlacementGroup / Attribute / partition_count partition_count *************** EC2.PlacementGroup.partition_count * *(integer) --* The number of partitions. Valid only if **strategy** is set to "partition". PlacementGroup / Identifier / name name **** EC2.PlacementGroup.name *(string)* The PlacementGroup's name identifier. This **must** be set. PlacementGroup / Action / reload reload ****** EC2.PlacementGroup.reload() Calls "EC2.Client.describe_placement_groups()" to update the attributes of the PlacementGroup resource. Note that the load and reload methods are the same method and can be used interchangeably. See also: AWS API Documentation **Request Syntax** placement_group.reload() Returns: None PlacementGroup / Attribute / state state ***** EC2.PlacementGroup.state * *(string) --* The state of the placement group. PlacementGroup / Attribute / group_id group_id ******** EC2.PlacementGroup.group_id * *(string) --* The ID of the placement group. PlacementGroup / Attribute / tags tags **** EC2.PlacementGroup.tags * *(list) --* Any tags applied to the placement group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. PlacementGroup / Attribute / spread_level spread_level ************ EC2.PlacementGroup.spread_level * *(string) --* The spread level for the placement group. *Only* Outpost placement groups can be spread across hosts. PlacementGroup / Action / delete delete ****** EC2.PlacementGroup.delete(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = placement_group.delete( DryRun=True|False, ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None EC2 / Paginator / SearchLocalGatewayRoutes SearchLocalGatewayRoutes ************************ class EC2.Paginator.SearchLocalGatewayRoutes paginator = client.get_paginator('search_local_gateway_routes') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.search_local_gateway_routes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **Filters** (*list*) -- One or more filters. * "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. * "type" - The route type. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Routes': [ { 'DestinationCidrBlock': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'Type': 'static'|'propagated', 'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string', 'SubnetId': 'string', 'CoipPoolId': 'string', 'NetworkInterfaceId': 'string', 'DestinationPrefixListId': 'string' }, ], } **Response Structure** * *(dict) --* * **Routes** *(list) --* Information about the routes. * *(dict) --* Describes a route for a local gateway route table. * **DestinationCidrBlock** *(string) --* The CIDR block used for destination matches. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **Type** *(string) --* The route type. * **State** *(string) --* The state of the route. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route. * **SubnetId** *(string) --* The ID of the subnet. * **CoipPoolId** *(string) --* The ID of the customer-owned address pool. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **DestinationPrefixListId** *(string) --* The ID of the prefix list. EC2 / Paginator / DescribeSecurityGroupRules DescribeSecurityGroupRules ************************** class EC2.Paginator.DescribeSecurityGroupRules paginator = client.get_paginator('describe_security_group_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_security_group_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SecurityGroupRuleIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- One or more filters. * "group-id" - The ID of the security group. * "security-group-rule-id" - The ID of the security group rule. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'GroupOwnerId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupInfo': { 'GroupId': 'string', 'PeeringStatus': 'string', 'UserId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string' }, 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SecurityGroupRuleArn': 'string' }, ], } **Response Structure** * *(dict) --* * **SecurityGroupRules** *(list) --* Information about security group rules. * *(dict) --* Describes a security group rule. * **SecurityGroupRuleId** *(string) --* The ID of the security group rule. * **GroupId** *(string) --* The ID of the security group. * **GroupOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the security group. * **IsEgress** *(boolean) --* Indicates whether the security group rule is an outbound rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **CidrIpv4** *(string) --* The IPv4 CIDR range. * **CidrIpv6** *(string) --* The IPv6 CIDR range. * **PrefixListId** *(string) --* The ID of the prefix list. * **ReferencedGroupInfo** *(dict) --* Describes the security group that is referenced in the rule. * **GroupId** *(string) --* The ID of the security group. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **UserId** *(string) --* The Amazon Web Services account ID. * **VpcId** *(string) --* The ID of the VPC. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection (if applicable). * **Description** *(string) --* The security group rule description. * **Tags** *(list) --* The tags applied to the security group rule. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupRuleArn** *(string) --* The ARN of the security group rule. EC2 / Paginator / GetIpamResourceCidrs GetIpamResourceCidrs ******************** class EC2.Paginator.GetIpamResourceCidrs paginator = client.get_paginator('get_ipam_resource_cidrs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_ipam_resource_cidrs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IpamScopeId='string', IpamPoolId='string', ResourceId='string', ResourceType='vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', ResourceTag={ 'Key': 'string', 'Value': 'string' }, ResourceOwner='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IpamScopeId** (*string*) -- **[REQUIRED]** The ID of the scope that the resource is in. * **IpamPoolId** (*string*) -- The ID of the IPAM pool that the resource is in. * **ResourceId** (*string*) -- The ID of the resource. * **ResourceType** (*string*) -- The resource type. * **ResourceTag** (*dict*) -- The resource tag. * **Key** *(string) --* 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. * **Value** *(string) --* The value for the tag. * **ResourceOwner** (*string*) -- The ID of the Amazon Web Services account that owns the resource. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamResourceCidrs': [ { 'IpamId': 'string', 'IpamScopeId': 'string', 'IpamPoolId': 'string', 'ResourceRegion': 'string', 'ResourceOwnerId': 'string', 'ResourceId': 'string', 'ResourceName': 'string', 'ResourceCidr': 'string', 'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', 'ResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpUsage': 123.0, 'ComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored', 'ManagementState': 'managed'|'unmanaged'|'ignored', 'OverlapStatus': 'overlapping'|'nonoverlapping'|'ignored', 'VpcId': 'string', 'AvailabilityZoneId': 'string' }, ] } **Response Structure** * *(dict) --* * **IpamResourceCidrs** *(list) --* The resource CIDRs. * *(dict) --* The CIDR for an IPAM resource. * **IpamId** *(string) --* The IPAM ID for an IPAM resource. * **IpamScopeId** *(string) --* The scope ID for an IPAM resource. * **IpamPoolId** *(string) --* The pool ID for an IPAM resource. * **ResourceRegion** *(string) --* The Amazon Web Services Region for an IPAM resource. * **ResourceOwnerId** *(string) --* The Amazon Web Services account number of the owner of an IPAM resource. * **ResourceId** *(string) --* The ID of an IPAM resource. * **ResourceName** *(string) --* The name of an IPAM resource. * **ResourceCidr** *(string) --* The CIDR for an IPAM resource. * **ResourceType** *(string) --* The type of IPAM resource. * **ResourceTags** *(list) --* The tags for an IPAM resource. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **IpUsage** *(float) --* The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following: * For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. * For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. * For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). * **ComplianceStatus** *(string) --* The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **ManagementState** *(string) --* The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **OverlapStatus** *(string) --* The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **VpcId** *(string) --* The ID of a VPC. * **AvailabilityZoneId** *(string) --* The Availability Zone ID. EC2 / Paginator / DescribeVpcEndpointServiceConfigurations DescribeVpcEndpointServiceConfigurations **************************************** class EC2.Paginator.DescribeVpcEndpointServiceConfigurations paginator = client.get_paginator('describe_vpc_endpoint_service_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_endpoint_service_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, ServiceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ServiceIds** (*list*) -- The IDs of the endpoint services. * *(string) --* * **Filters** (*list*) -- The filters. * "service-name" - The name of the service. * "service-id" - The ID of the service. * "service-state" - The state of the service ( "Pending" | "Available" | "Deleting" | "Deleted" | "Failed"). * "supported-ip-address-types" - The IP address type ( "ipv4" | "ipv6"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServiceConfigurations': [ { 'ServiceType': [ { 'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer' }, ], 'ServiceId': 'string', 'ServiceName': 'string', 'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed', 'AvailabilityZones': [ 'string', ], 'AcceptanceRequired': True|False, 'ManagesVpcEndpoints': True|False, 'NetworkLoadBalancerArns': [ 'string', ], 'GatewayLoadBalancerArns': [ 'string', ], 'SupportedIpAddressTypes': [ 'ipv4'|'ipv6', ], 'BaseEndpointDnsNames': [ 'string', ], 'PrivateDnsName': 'string', 'PrivateDnsNameConfiguration': { 'State': 'pendingVerification'|'verified'|'failed', 'Type': 'string', 'Value': 'string', 'Name': 'string' }, 'PayerResponsibility': 'ServiceOwner', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SupportedRegions': [ { 'Region': 'string', 'ServiceState': 'string' }, ], 'RemoteAccessEnabled': True|False }, ], } **Response Structure** * *(dict) --* * **ServiceConfigurations** *(list) --* Information about the services. * *(dict) --* Describes a service configuration for a VPC endpoint service. * **ServiceType** *(list) --* The type of service. * *(dict) --* Describes the type of service for a VPC endpoint. * **ServiceType** *(string) --* The type of service. * **ServiceId** *(string) --* The ID of the service. * **ServiceName** *(string) --* The name of the service. * **ServiceState** *(string) --* The service state. * **AvailabilityZones** *(list) --* The Availability Zones in which the service is available. * *(string) --* * **AcceptanceRequired** *(boolean) --* Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted. * **ManagesVpcEndpoints** *(boolean) --* Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. * **NetworkLoadBalancerArns** *(list) --* The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. * *(string) --* * **GatewayLoadBalancerArns** *(list) --* The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. * *(string) --* * **SupportedIpAddressTypes** *(list) --* The supported IP address types. * *(string) --* * **BaseEndpointDnsNames** *(list) --* The DNS names for the service. * *(string) --* * **PrivateDnsName** *(string) --* The private DNS name for the service. * **PrivateDnsNameConfiguration** *(dict) --* Information about the endpoint service private DNS name configuration. * **State** *(string) --* The verification state of the VPC endpoint service. >Consumers of the endpoint service can use the private name only when the state is "verified". * **Type** *(string) --* The endpoint service verification type, for example TXT. * **Value** *(string) --* The value the service provider adds to the private DNS name domain record before verification. * **Name** *(string) --* The name of the record subdomain the service provider needs to create. The service provider adds the "value" text to the "name". * **PayerResponsibility** *(string) --* The payer responsibility. * **Tags** *(list) --* The tags assigned to the service. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SupportedRegions** *(list) --* The supported Regions. * *(dict) --* Describes a supported Region. * **Region** *(string) --* The Region code. * **ServiceState** *(string) --* The service state. The possible values are "Pending", "Available", "Deleting", "Deleted", "Failed", and "Closed". * **RemoteAccessEnabled** *(boolean) --* Indicates whether consumers can access the service from a Region other than the Region where the service is hosted. EC2 / Paginator / DescribeCapacityBlockOfferings DescribeCapacityBlockOfferings ****************************** class EC2.Paginator.DescribeCapacityBlockOfferings paginator = client.get_paginator('describe_capacity_block_offerings') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_capacity_block_offerings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, InstanceType='string', InstanceCount=123, StartDateRange=datetime(2015, 1, 1), EndDateRange=datetime(2015, 1, 1), CapacityDurationHours=123, UltraserverType='string', UltraserverCount=123, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceType** (*string*) -- The type of instance for which the Capacity Block offering reserves capacity. * **InstanceCount** (*integer*) -- The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks. * **StartDateRange** (*datetime*) -- The earliest start date for the Capacity Block offering. * **EndDateRange** (*datetime*) -- The latest end date for the Capacity Block offering. * **CapacityDurationHours** (*integer*) -- **[REQUIRED]** The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days. * **UltraserverType** (*string*) -- The EC2 UltraServer type of the Capacity Block offerings. * **UltraserverCount** (*integer*) -- The number of EC2 UltraServers in the offerings. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityBlockOfferings': [ { 'CapacityBlockOfferingId': 'string', 'InstanceType': 'string', 'AvailabilityZone': 'string', 'InstanceCount': 123, 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'CapacityBlockDurationHours': 123, 'UpfrontFee': 'string', 'CurrencyCode': 'string', 'Tenancy': 'default'|'dedicated', 'UltraserverType': 'string', 'UltraserverCount': 123, 'CapacityBlockDurationMinutes': 123 }, ], } **Response Structure** * *(dict) --* * **CapacityBlockOfferings** *(list) --* The recommended Capacity Block offering for the dates specified. * *(dict) --* The recommended Capacity Block that fits your search requirements. * **CapacityBlockOfferingId** *(string) --* The ID of the Capacity Block offering. * **InstanceType** *(string) --* The instance type of the Capacity Block offering. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block offering. * **InstanceCount** *(integer) --* The number of instances in the Capacity Block offering. * **StartDate** *(datetime) --* The start date of the Capacity Block offering. * **EndDate** *(datetime) --* The end date of the Capacity Block offering. * **CapacityBlockDurationHours** *(integer) --* The number of hours (in addition to "capacityBlockDurationMinutes") for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **04:55** and ends at **11:30**, the hours field would be **6**. * **UpfrontFee** *(string) --* The total price to be paid up front. * **CurrencyCode** *(string) --* The currency of the payment for the Capacity Block. * **Tenancy** *(string) --* The tenancy of the Capacity Block. * **UltraserverType** *(string) --* The EC2 UltraServer type of the Capacity Block offering. * **UltraserverCount** *(integer) --* The number of EC2 UltraServers in the offering. * **CapacityBlockDurationMinutes** *(integer) --* The number of minutes (in addition to "capacityBlockDurationHours") for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **08:55** and ends at **11:30**, the minutes field would be **35**. EC2 / Paginator / DescribeReservedInstancesOfferings DescribeReservedInstancesOfferings ********************************** class EC2.Paginator.DescribeReservedInstancesOfferings paginator = client.get_paginator('describe_reserved_instances_offerings') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_reserved_instances_offerings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AvailabilityZone='string', IncludeMarketplace=True|False, InstanceType='a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', MaxDuration=123, MaxInstanceCount=123, MinDuration=123, OfferingClass='standard'|'convertible', ProductDescription='Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)', ReservedInstancesOfferingIds=[ 'string', ], AvailabilityZoneId='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceTenancy='default'|'dedicated'|'host', OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AvailabilityZone** (*string*) -- The Availability Zone in which the Reserved Instance can be used. Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. * **IncludeMarketplace** (*boolean*) -- Include Reserved Instance Marketplace offerings in the response. * **InstanceType** (*string*) -- The instance type that the reservation will cover (for example, "m1.small"). For more information, see Amazon EC2 instance types in the *Amazon EC2 User Guide*. * **MaxDuration** (*integer*) -- The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years) * **MaxInstanceCount** (*integer*) -- The maximum number of instances to filter when searching for offerings. Default: 20 * **MinDuration** (*integer*) -- The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month) * **OfferingClass** (*string*) -- The offering class of the Reserved Instance. Can be "standard" or "convertible". * **ProductDescription** (*string*) -- The Reserved Instance product platform description. Instances that include "(Amazon VPC)" in the description are for use with Amazon VPC. * **ReservedInstancesOfferingIds** (*list*) -- One or more Reserved Instances offering IDs. * *(string) --* * **AvailabilityZoneId** (*string*) -- The ID of the Availability Zone. Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "availability-zone" - The Availability Zone where the Reserved Instance can be used. * "availability-zone-id" - The ID of 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 Amazon Web Services and the Reserved Instance Marketplace are listed. * "product-description" - The Reserved Instance product platform description ( "Linux/UNIX" | "Linux with SQL Server Standard" | "Linux with SQL Server Web" | "Linux with SQL Server Enterprise" | "SUSE Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Windows" | "Windows with SQL Server Standard" | "Windows with SQL Server Web" | "Windows with SQL Server Enterprise"). * "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). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceTenancy** (*string*) -- 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" * **OfferingType** (*string*) -- 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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReservedInstancesOfferings': [ { 'CurrencyCode': 'USD', 'InstanceTenancy': 'default'|'dedicated'|'host', 'Marketplace': True|False, 'OfferingClass': 'standard'|'convertible', 'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront', 'PricingDetails': [ { 'Count': 123, 'Price': 123.0 }, ], 'RecurringCharges': [ { 'Amount': 123.0, 'Frequency': 'Hourly' }, ], 'Scope': 'Availability Zone'|'Region', 'AvailabilityZoneId': 'string', 'ReservedInstancesOfferingId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'AvailabilityZone': 'string', 'Duration': 123, 'UsagePrice': ..., 'FixedPrice': ..., 'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)' }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeReservedInstancesOfferings. * **ReservedInstancesOfferings** *(list) --* A list of Reserved Instances offerings. * *(dict) --* Describes a Reserved Instance offering. * **CurrencyCode** *(string) --* The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is "USD". * **InstanceTenancy** *(string) --* The tenancy of the instance. * **Marketplace** *(boolean) --* Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is "true". * **OfferingClass** *(string) --* If "convertible" it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If "standard", it is not possible to perform an exchange. * **OfferingType** *(string) --* The Reserved Instance offering type. * **PricingDetails** *(list) --* The pricing details of the Reserved Instance offering. * *(dict) --* Describes a Reserved Instance offering. * **Count** *(integer) --* The number of reservations available for the price. * **Price** *(float) --* The price per instance. * **RecurringCharges** *(list) --* The recurring charge tag assigned to the resource. * *(dict) --* Describes a recurring charge. * **Amount** *(float) --* The amount of the recurring charge. * **Frequency** *(string) --* The frequency of the recurring charge. * **Scope** *(string) --* Whether the Reserved Instance is applied to instances in a Region or an Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. * **ReservedInstancesOfferingId** *(string) --* The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made. * **InstanceType** *(string) --* The instance type on which the Reserved Instance can be used. * **AvailabilityZone** *(string) --* The Availability Zone in which the Reserved Instance can be used. * **Duration** *(integer) --* The duration of the Reserved Instance, in seconds. * **UsagePrice** *(float) --* The usage price of the Reserved Instance, per hour. * **FixedPrice** *(float) --* The purchase price of the Reserved Instance. * **ProductDescription** *(string) --* The Reserved Instance product platform description. EC2 / Paginator / DescribeVolumes DescribeVolumes *************** class EC2.Paginator.DescribeVolumes paginator = client.get_paginator('describe_volumes') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_volumes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VolumeIds** (*list*) -- The volume IDs. If not specified, then all volumes are included in the response. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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") * "fast-restored" - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore ( "true" | "false"). * "multi-attach-enabled" - Indicates whether the volume is enabled for Multi-Attach ( "true" | "false") * "operator.managed" - A Boolean that indicates whether this is a managed volume. * "operator.principal" - The principal that manages the volume. Only valid for managed volumes, where "managed" is "true". * "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": - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Volumes': [ { 'OutpostArn': 'string', 'Iops': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'FastRestored': True|False, 'MultiAttachEnabled': True|False, 'Throughput': 123, 'SseType': 'sse-ebs'|'sse-kms'|'none', 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'VolumeInitializationRate': 123, 'VolumeId': 'string', 'Size': 123, 'SnapshotId': 'string', 'AvailabilityZone': 'string', 'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error', 'CreateTime': datetime(2015, 1, 1), 'Attachments': [ { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) }, ], 'Encrypted': True|False, 'KmsKeyId': 'string' }, ] } **Response Structure** * *(dict) --* * **Volumes** *(list) --* Information about the volumes. * *(dict) --* Describes a volume. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **Iops** *(integer) --* 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. * **Tags** *(list) --* Any tags assigned to the volume. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VolumeType** *(string) --* The volume type. * **FastRestored** *(boolean) --* Note: This parameter is not returned by CreateVolume. Indicates whether the volume was created using fast snapshot restore. * **MultiAttachEnabled** *(boolean) --* Indicates whether Amazon EBS Multi-Attach is enabled. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **SseType** *(string) --* Note: This parameter is not returned by CreateVolume. Reserved for future use. * **Operator** *(dict) --* The service provider that manages the volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **VolumeInitializationRate** *(integer) --* The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is "null". * **VolumeId** *(string) --* The ID of the volume. * **Size** *(integer) --* The size of the volume, in GiBs. * **SnapshotId** *(string) --* The snapshot from which the volume was created, if applicable. * **AvailabilityZone** *(string) --* The Availability Zone for the volume. * **State** *(string) --* The volume state. * **CreateTime** *(datetime) --* The time stamp when volume creation was initiated. * **Attachments** *(list) --* Note: This parameter is not returned by CreateVolume. Information about the volume attachments. * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **Encrypted** *(boolean) --* Indicates whether the volume is encrypted. * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume. EC2 / Paginator / DescribeInstanceStatus DescribeInstanceStatus ********************** class EC2.Paginator.DescribeInstanceStatus paginator = client.get_paginator('describe_instance_status') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_status()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IncludeAllInstances=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- 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"). * "operator.managed" - A Boolean that indicates whether this is a managed instance. * "operator.principal" - The principal that manages the instance. Only valid for managed instances, where "managed" is "true". * "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"). * "attached-ebs-status.status" - The status of the attached EBS volume for the instance ( "ok" | "impaired" | "initializing" | "insufficient-data" | "not-applicable"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IncludeAllInstances** (*boolean*) -- When "true", includes the health status for all instances. When "false", includes the health status for running instances only. Default: "false" * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceStatuses': [ { 'AvailabilityZone': 'string', 'OutpostArn': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'Events': [ { 'InstanceEventId': 'string', 'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop', 'Description': 'string', 'NotAfter': datetime(2015, 1, 1), 'NotBefore': datetime(2015, 1, 1), 'NotBeforeDeadline': datetime(2015, 1, 1) }, ], 'InstanceId': 'string', 'InstanceState': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'InstanceStatus': { 'Details': [ { 'ImpairedSince': datetime(2015, 1, 1), 'Name': 'reachability', 'Status': 'passed'|'failed'|'insufficient-data'|'initializing' }, ], 'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing' }, 'SystemStatus': { 'Details': [ { 'ImpairedSince': datetime(2015, 1, 1), 'Name': 'reachability', 'Status': 'passed'|'failed'|'insufficient-data'|'initializing' }, ], 'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing' }, 'AttachedEbsStatus': { 'Details': [ { 'ImpairedSince': datetime(2015, 1, 1), 'Name': 'reachability', 'Status': 'passed'|'failed'|'insufficient-data'|'initializing' }, ], 'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing' } }, ], } **Response Structure** * *(dict) --* * **InstanceStatuses** *(list) --* Information about the status of the instances. * *(dict) --* Describes the status of an instance. * **AvailabilityZone** *(string) --* The Availability Zone of the instance. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **Operator** *(dict) --* The service provider that manages the instance. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **Events** *(list) --* Any scheduled events associated with the instance. * *(dict) --* Describes a scheduled event for an instance. * **InstanceEventId** *(string) --* The ID of the event. * **Code** *(string) --* The event code. * **Description** *(string) --* A description of the event. After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed]. * **NotAfter** *(datetime) --* The latest scheduled end time for the event. * **NotBefore** *(datetime) --* The earliest scheduled start time for the event. * **NotBeforeDeadline** *(datetime) --* The deadline for starting the event. * **InstanceId** *(string) --* The ID of the instance. * **InstanceState** *(dict) --* The intended state of the instance. DescribeInstanceStatus requires that an instance be in the "running" state. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **InstanceStatus** *(dict) --* Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability. * **Details** *(list) --* The system instance health or application instance health. * *(dict) --* Describes the instance status. * **ImpairedSince** *(datetime) --* The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched. * **Name** *(string) --* The type of instance status. * **Status** *(string) --* The status. * **Status** *(string) --* The status. * **SystemStatus** *(dict) --* Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems. * **Details** *(list) --* The system instance health or application instance health. * *(dict) --* Describes the instance status. * **ImpairedSince** *(datetime) --* The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched. * **Name** *(string) --* The type of instance status. * **Status** *(string) --* The status. * **Status** *(string) --* The status. * **AttachedEbsStatus** *(dict) --* Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations. * **Details** *(list) --* Details about the attached EBS status check for an instance. * *(dict) --* Describes the attached EBS status check for an instance. * **ImpairedSince** *(datetime) --* The date and time when the attached EBS status check failed. * **Name** *(string) --* The name of the attached EBS status check. * **Status** *(string) --* The result of the attached EBS status check. * **Status** *(string) --* The current status. EC2 / Paginator / DescribeVpcPeeringConnections DescribeVpcPeeringConnections ***************************** class EC2.Paginator.DescribeVpcPeeringConnections paginator = client.get_paginator('describe_vpc_peering_connections') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_peering_connections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, VpcPeeringConnectionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcPeeringConnectionIds** (*list*) -- The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. * *(string) --* * **Filters** (*list*) -- The filters. * "accepter-vpc-info.cidr-block" - The IPv4 CIDR block of the accepter VPC. * "accepter-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns 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. * "requester-vpc-info.cidr-block" - The IPv4 CIDR block of the requester's VPC. * "requester-vpc-info.owner-id" - The ID of the Amazon Web Services account that owns the requester VPC. * "requester-vpc-info.vpc-id" - The ID of the requester VPC. * "status-code" - The status of the VPC peering connection ( "pending-acceptance" | "failed" | "expired" | "provisioning" | "active" | "deleting" | "deleted" | "rejected"). * "status-message" - A message that provides more information about the status of the VPC peering connection, if applicable. * "tag" - 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-peering-connection-id" - The ID of the VPC peering connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VpcPeeringConnections': [ { 'AccepterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'ExpirationTime': datetime(2015, 1, 1), 'RequesterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'Status': { 'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcPeeringConnectionId': 'string' }, ], } **Response Structure** * *(dict) --* * **VpcPeeringConnections** *(list) --* Information about the VPC peering connections. * *(dict) --* Describes a VPC peering connection. * **AccepterVpcInfo** *(dict) --* Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **ExpirationTime** *(datetime) --* The time that an unaccepted VPC peering connection will expire. * **RequesterVpcInfo** *(dict) --* Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **Status** *(dict) --* The status of the VPC peering connection. * **Code** *(string) --* The status of the VPC peering connection. * **Message** *(string) --* A message that provides more information about the status, if applicable. * **Tags** *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection. EC2 / Paginator / DescribeTrunkInterfaceAssociations DescribeTrunkInterfaceAssociations ********************************** class EC2.Paginator.DescribeTrunkInterfaceAssociations paginator = client.get_paginator('describe_trunk_interface_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_trunk_interface_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AssociationIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AssociationIds** (*list*) -- The IDs of the associations. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "gre-key" - The ID of a trunk interface association. * "interface-protocol" - The interface protocol. Valid values are "VLAN" and "GRE". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InterfaceAssociations': [ { 'AssociationId': 'string', 'BranchInterfaceId': 'string', 'TrunkInterfaceId': 'string', 'InterfaceProtocol': 'VLAN'|'GRE', 'VlanId': 123, 'GreKey': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **InterfaceAssociations** *(list) --* Information about the trunk associations. * *(dict) --* Information about an association between a branch network interface with a trunk network interface. * **AssociationId** *(string) --* The ID of the association. * **BranchInterfaceId** *(string) --* The ID of the branch network interface. * **TrunkInterfaceId** *(string) --* The ID of the trunk network interface. * **InterfaceProtocol** *(string) --* The interface protocol. Valid values are "VLAN" and "GRE". * **VlanId** *(integer) --* The ID of the VLAN when you use the VLAN protocol. * **GreKey** *(integer) --* The application key when you use the GRE protocol. * **Tags** *(list) --* The tags for the trunk interface association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeNetworkInterfacePermissions DescribeNetworkInterfacePermissions *********************************** class EC2.Paginator.DescribeNetworkInterfacePermissions paginator = client.get_paginator('describe_network_interface_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_interface_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInterfacePermissionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInterfacePermissionIds** (*list*) -- The network interface permission IDs. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account ID. * "network-interface-permission.aws-service" - The Amazon Web Services service. * "network-interface-permission.permission" - The type of permission ( "INSTANCE-ATTACH" | "EIP-ASSOCIATE"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInterfacePermissions': [ { 'NetworkInterfacePermissionId': 'string', 'NetworkInterfaceId': 'string', 'AwsAccountId': 'string', 'AwsService': 'string', 'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE', 'PermissionState': { 'State': 'pending'|'granted'|'revoking'|'revoked', 'StatusMessage': 'string' } }, ], } **Response Structure** * *(dict) --* Contains the output for DescribeNetworkInterfacePermissions. * **NetworkInterfacePermissions** *(list) --* The network interface permissions. * *(dict) --* Describes a permission for a network interface. * **NetworkInterfacePermissionId** *(string) --* The ID of the network interface permission. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **AwsAccountId** *(string) --* The Amazon Web Services account ID. * **AwsService** *(string) --* The Amazon Web Services service. * **Permission** *(string) --* The type of permission. * **PermissionState** *(dict) --* Information about the state of the permission. * **State** *(string) --* The state of the permission. * **StatusMessage** *(string) --* A status message, if applicable. EC2 / Paginator / DescribeNetworkAcls DescribeNetworkAcls ******************* class EC2.Paginator.DescribeNetworkAcls paginator = client.get_paginator('describe_network_acls') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_acls()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, NetworkAclIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclIds** (*list*) -- The IDs of the network ACLs. * *(string) --* * **Filters** (*list*) -- The 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 in the entry, if any. * "entry.icmp.type" - The ICMP type specified in the entry, if any. * "entry.ipv6-cidr" - The IPv6 CIDR range specified in the entry. * "entry.port-range.from" - The start of the port range specified in the entry. * "entry.port-range.to" - The end of the port range specified in the entry. * "entry.protocol" - The protocol specified in the entry ( "tcp" | "udp" | "icmp" or a protocol number). * "entry.rule-action" - Allows or denies the matching traffic ( "allow" | "deny"). * "entry.egress" - A Boolean that indicates the type of rule. Specify "true" for egress rules, or "false" for ingress rules. * "entry.rule-number" - The number of an entry (in other words, rule) in the set of ACL entries. * "network-acl-id" - The ID of the network ACL. * "owner-id" - The ID of the Amazon Web Services account that owns the network ACL. * "tag" - 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 ACL. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkAcls': [ { 'Associations': [ { 'NetworkAclAssociationId': 'string', 'NetworkAclId': 'string', 'SubnetId': 'string' }, ], 'Entries': [ { 'CidrBlock': 'string', 'Egress': True|False, 'IcmpTypeCode': { 'Code': 123, 'Type': 123 }, 'Ipv6CidrBlock': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'allow'|'deny', 'RuleNumber': 123 }, ], 'IsDefault': True|False, 'NetworkAclId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'OwnerId': 'string' }, ], } **Response Structure** * *(dict) --* * **NetworkAcls** *(list) --* Information about the network ACLs. * *(dict) --* Describes a network ACL. * **Associations** *(list) --* Any associations between the network ACL and your subnets * *(dict) --* Describes an association between a network ACL and a subnet. * **NetworkAclAssociationId** *(string) --* The ID of the association between a network ACL and a subnet. * **NetworkAclId** *(string) --* The ID of the network ACL. * **SubnetId** *(string) --* The ID of the subnet. * **Entries** *(list) --* The entries (rules) in the network ACL. * *(dict) --* Describes an entry in a network ACL. * **CidrBlock** *(string) --* The IPv4 network range to allow or deny, in CIDR notation. * **Egress** *(boolean) --* Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). * **IcmpTypeCode** *(dict) --* ICMP protocol: The ICMP type and code. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **Ipv6CidrBlock** *(string) --* The IPv6 network range to allow or deny, in CIDR notation. * **PortRange** *(dict) --* TCP or UDP protocols: The range of ports the rule applies to. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol number. A value of "-1" means all protocols. * **RuleAction** *(string) --* Indicates whether to allow or deny the traffic that matches the rule. * **RuleNumber** *(integer) --* The rule number for the entry. ACL entries are processed in ascending order by rule number. * **IsDefault** *(boolean) --* Indicates whether this is the default network ACL for the VPC. * **NetworkAclId** *(string) --* The ID of the network ACL. * **Tags** *(list) --* Any tags assigned to the network ACL. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC for the network ACL. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the network ACL. EC2 / Paginator / DescribeImportImageTasks DescribeImportImageTasks ************************ class EC2.Paginator.DescribeImportImageTasks paginator = client.get_paginator('describe_import_image_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_import_image_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ImportTaskIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- Filter tasks using the "task-state" filter and one of the following values: "active", "completed", "deleting", or "deleted". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ImportTaskIds** (*list*) -- The IDs of the import image tasks. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ImportImageTasks': [ { 'Architecture': 'string', 'Description': 'string', 'Encrypted': True|False, 'Hypervisor': 'string', 'ImageId': 'string', 'ImportTaskId': 'string', 'KmsKeyId': 'string', 'LicenseType': 'string', 'Platform': 'string', 'Progress': 'string', 'SnapshotDetails': [ { 'Description': 'string', 'DeviceName': 'string', 'DiskImageSize': 123.0, 'Format': 'string', 'Progress': 'string', 'SnapshotId': 'string', 'Status': 'string', 'StatusMessage': 'string', 'Url': 'string', 'UserBucket': { 'S3Bucket': 'string', 'S3Key': 'string' } }, ], 'Status': 'string', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LicenseSpecifications': [ { 'LicenseConfigurationArn': 'string' }, ], 'UsageOperation': 'string', 'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred' }, ], } **Response Structure** * *(dict) --* * **ImportImageTasks** *(list) --* A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days. * *(dict) --* Describes an import image task. * **Architecture** *(string) --* The architecture of the virtual machine. Valid values: "i386" | "x86_64" | "arm64" * **Description** *(string) --* A description of the import task. * **Encrypted** *(boolean) --* Indicates whether the image is encrypted. * **Hypervisor** *(string) --* The target hypervisor for the import task. Valid values: "xen" * **ImageId** *(string) --* The ID of the Amazon Machine Image (AMI) of the imported virtual machine. * **ImportTaskId** *(string) --* The ID of the import image task. * **KmsKeyId** *(string) --* The identifier for the KMS key that was used to create the encrypted image. * **LicenseType** *(string) --* The license type of the virtual machine. * **Platform** *(string) --* The description string for the import image task. * **Progress** *(string) --* The percentage of progress of the import image task. * **SnapshotDetails** *(list) --* Information about the snapshots. * *(dict) --* Describes the snapshot created from the imported disk. * **Description** *(string) --* A description for the snapshot. * **DeviceName** *(string) --* The block device mapping for the snapshot. * **DiskImageSize** *(float) --* The size of the disk in the snapshot, in GiB. * **Format** *(string) --* The format of the disk image from which the snapshot is created. * **Progress** *(string) --* The percentage of progress for the task. * **SnapshotId** *(string) --* The snapshot ID of the disk being imported. * **Status** *(string) --* A brief status of the snapshot creation. * **StatusMessage** *(string) --* A detailed status message for the snapshot creation. * **Url** *(string) --* The URL used to access the disk image. * **UserBucket** *(dict) --* The Amazon S3 bucket for the disk image. * **S3Bucket** *(string) --* The Amazon S3 bucket from which the disk image was created. * **S3Key** *(string) --* The file name of the disk image. * **Status** *(string) --* A brief status for the import image task. * **StatusMessage** *(string) --* A descriptive status message for the import image task. * **Tags** *(list) --* The tags for the import image task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **LicenseSpecifications** *(list) --* The ARNs of the license configurations that are associated with the import image task. * *(dict) --* The response information for license configurations. * **LicenseConfigurationArn** *(string) --* The ARN of a license configuration. * **UsageOperation** *(string) --* The usage operation value. * **BootMode** *(string) --* The boot mode of the virtual machine. EC2 / Paginator / DescribeClientVpnEndpoints DescribeClientVpnEndpoints ************************** class EC2.Paginator.DescribeClientVpnEndpoints paginator = client.get_paginator('describe_client_vpn_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_client_vpn_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClientVpnEndpointIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClientVpnEndpointIds** (*list*) -- The ID of the Client VPN endpoint. * *(string) --* * **Filters** (*list*) -- 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ClientVpnEndpoints': [ { 'ClientVpnEndpointId': 'string', 'Description': 'string', 'Status': { 'Code': 'pending-associate'|'available'|'deleting'|'deleted', 'Message': 'string' }, 'CreationTime': 'string', 'DeletionTime': 'string', 'DnsName': 'string', 'ClientCidrBlock': 'string', 'DnsServers': [ 'string', ], 'SplitTunnel': True|False, 'VpnProtocol': 'openvpn', 'TransportProtocol': 'tcp'|'udp', 'VpnPort': 123, 'AssociatedTargetNetworks': [ { 'NetworkId': 'string', 'NetworkType': 'vpc' }, ], 'ServerCertificateArn': 'string', 'AuthenticationOptions': [ { 'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication', 'ActiveDirectory': { 'DirectoryId': 'string' }, 'MutualAuthentication': { 'ClientRootCertificateChain': 'string' }, 'FederatedAuthentication': { 'SamlProviderArn': 'string', 'SelfServiceSamlProviderArn': 'string' } }, ], 'ConnectionLogOptions': { 'Enabled': True|False, 'CloudwatchLogGroup': 'string', 'CloudwatchLogStream': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SecurityGroupIds': [ 'string', ], 'VpcId': 'string', 'SelfServicePortalUrl': 'string', 'ClientConnectOptions': { 'Enabled': True|False, 'LambdaFunctionArn': 'string', 'Status': { 'Code': 'applying'|'applied', 'Message': 'string' } }, 'SessionTimeoutHours': 123, 'ClientLoginBannerOptions': { 'Enabled': True|False, 'BannerText': 'string' }, 'ClientRouteEnforcementOptions': { 'Enforced': True|False }, 'DisconnectOnSessionTimeout': True|False }, ], } **Response Structure** * *(dict) --* * **ClientVpnEndpoints** *(list) --* Information about the Client VPN endpoints. * *(dict) --* Describes a Client VPN endpoint. * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint. * **Description** *(string) --* A brief description of the endpoint. * **Status** *(dict) --* The current state of the Client VPN endpoint. * **Code** *(string) --* The state of the Client VPN endpoint. Possible states include: * "pending-associate" - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections. * "available" - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections. * "deleting" - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections. * "deleted" - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections. * **Message** *(string) --* A message about the status of the Client VPN endpoint. * **CreationTime** *(string) --* The date and time the Client VPN endpoint was created. * **DeletionTime** *(string) --* The date and time the Client VPN endpoint was deleted, if applicable. * **DnsName** *(string) --* The DNS name to be used by clients when connecting to the Client VPN endpoint. * **ClientCidrBlock** *(string) --* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned. * **DnsServers** *(list) --* Information about the DNS servers to be used for DNS resolution. * *(string) --* * **SplitTunnel** *(boolean) --* Indicates whether split-tunnel is enabled in the Client VPN endpoint. For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the *Client VPN Administrator Guide*. * **VpnProtocol** *(string) --* The protocol used by the VPN session. * **TransportProtocol** *(string) --* The transport protocol used by the Client VPN endpoint. * **VpnPort** *(integer) --* The port number for the Client VPN endpoint. * **AssociatedTargetNetworks** *(list) --* Information about the associated target networks. A target network is a subnet in a VPC. * *(dict) --* Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC. * **NetworkId** *(string) --* The ID of the subnet. * **NetworkType** *(string) --* The target network type. * **ServerCertificateArn** *(string) --* The ARN of the server certificate. * **AuthenticationOptions** *(list) --* Information about the authentication method used by the Client VPN endpoint. * *(dict) --* Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the *Client VPN Administrator Guide*. * **Type** *(string) --* The authentication type used. * **ActiveDirectory** *(dict) --* Information about the Active Directory, if applicable. * **DirectoryId** *(string) --* The ID of the Active Directory used for authentication. * **MutualAuthentication** *(dict) --* Information about the authentication certificates, if applicable. * **ClientRootCertificateChain** *(string) --* The ARN of the client certificate. * **FederatedAuthentication** *(dict) --* Information about the IAM SAML identity provider, if applicable. * **SamlProviderArn** *(string) --* The Amazon Resource Name (ARN) of the IAM SAML identity provider. * **SelfServiceSamlProviderArn** *(string) --* The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal. * **ConnectionLogOptions** *(dict) --* Information about the client connection logging options for the Client VPN endpoint. * **Enabled** *(boolean) --* Indicates whether client connection logging is enabled for the Client VPN endpoint. * **CloudwatchLogGroup** *(string) --* The name of the Amazon CloudWatch Logs log group to which connection logging data is published. * **CloudwatchLogStream** *(string) --* The name of the Amazon CloudWatch Logs log stream to which connection logging data is published. * **Tags** *(list) --* Any tags assigned to the Client VPN endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupIds** *(list) --* The IDs of the security groups for the target network. * *(string) --* * **VpcId** *(string) --* The ID of the VPC. * **SelfServicePortalUrl** *(string) --* The URL of the self-service portal. * **ClientConnectOptions** *(dict) --* The options for managing connection authorization for new client connections. * **Enabled** *(boolean) --* Indicates whether client connect options are enabled. * **LambdaFunctionArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. * **Status** *(dict) --* The status of any updates to the client connect options. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **SessionTimeoutHours** *(integer) --* The maximum VPN session duration time in hours. Valid values: "8 | 10 | 12 | 24" Default value: "24" * **ClientLoginBannerOptions** *(dict) --* Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. * **Enabled** *(boolean) --* Current state of text banner feature. Valid values: "true | false" * **BannerText** *(string) --* Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. * **ClientRouteEnforcementOptions** *(dict) --* Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel. Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations. * **Enforced** *(boolean) --* Status of the client route enforcement feature, indicating whether Client Route Enforcement is "true" (enabled) or "false" (disabled). Valid values: "true | false" Default value: "false" * **DisconnectOnSessionTimeout** *(boolean) --* Indicates whether the client VPN session is disconnected after the maximum "sessionTimeoutHours" is reached. If "true", users are prompted to reconnect client VPN. If "false", client VPN attempts to reconnect automatically. The default value is "true". EC2 / Paginator / SearchTransitGatewayMulticastGroups SearchTransitGatewayMulticastGroups *********************************** class EC2.Paginator.SearchTransitGatewayMulticastGroups paginator = client.get_paginator('search_transit_gateway_multicast_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.search_transit_gateway_multicast_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayMulticastDomainId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- **[REQUIRED]** The ID of the transit gateway multicast domain. * **Filters** (*list*) -- 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". * "subnet-id" - The ID of the subnet. * "transit-gateway-attachment-id" - The id of the transit gateway attachment. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MulticastGroups': [ { 'GroupIpAddress': 'string', 'TransitGatewayAttachmentId': 'string', 'SubnetId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceOwnerId': 'string', 'NetworkInterfaceId': 'string', 'GroupMember': True|False, 'GroupSource': True|False, 'MemberType': 'static'|'igmp', 'SourceType': 'static'|'igmp' }, ], } **Response Structure** * *(dict) --* * **MulticastGroups** *(list) --* Information about the transit gateway multicast group. * *(dict) --* Describes the transit gateway multicast group resources. * **GroupIpAddress** *(string) --* The IP address assigned to the transit gateway multicast group. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **SubnetId** *(string) --* The ID of the subnet. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource, for example a VPC attachment. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource. * **NetworkInterfaceId** *(string) --* The ID of the transit gateway attachment. * **GroupMember** *(boolean) --* Indicates that the resource is a transit gateway multicast group member. * **GroupSource** *(boolean) --* Indicates that the resource is a transit gateway multicast group member. * **MemberType** *(string) --* The member type (for example, "static"). * **SourceType** *(string) --* The source type. EC2 / Paginator / DescribeIpv6Pools DescribeIpv6Pools ***************** class EC2.Paginator.DescribeIpv6Pools paginator = client.get_paginator('describe_ipv6_pools') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipv6_pools()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PoolIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **PoolIds** (*list*) -- The IDs of the IPv6 address pools. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Ipv6Pools': [ { 'PoolId': 'string', 'Description': 'string', 'PoolCidrBlocks': [ { 'Cidr': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **Ipv6Pools** *(list) --* Information about the IPv6 address pools. * *(dict) --* Describes an IPv6 address pool. * **PoolId** *(string) --* The ID of the address pool. * **Description** *(string) --* The description for the address pool. * **PoolCidrBlocks** *(list) --* The CIDR blocks for the address pool. * *(dict) --* Describes a CIDR block for an address pool. * **Cidr** *(string) --* The CIDR block. * **Tags** *(list) --* Any tags for the address pool. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeReplaceRootVolumeTasks DescribeReplaceRootVolumeTasks ****************************** class EC2.Paginator.DescribeReplaceRootVolumeTasks paginator = client.get_paginator('describe_replace_root_volume_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_replace_root_volume_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReplaceRootVolumeTaskIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ReplaceRootVolumeTaskIds** (*list*) -- The ID of the root volume replacement task to view. * *(string) --* * **Filters** (*list*) -- Filter to use: * "instance-id" - The ID of the instance for which the root volume replacement task was created. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReplaceRootVolumeTasks': [ { 'ReplaceRootVolumeTaskId': 'string', 'InstanceId': 'string', 'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached', 'StartTime': 'string', 'CompleteTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ImageId': 'string', 'SnapshotId': 'string', 'DeleteReplacedRootVolume': True|False }, ], } **Response Structure** * *(dict) --* * **ReplaceRootVolumeTasks** *(list) --* Information about the root volume replacement task. * *(dict) --* Information about a root volume replacement task. * **ReplaceRootVolumeTaskId** *(string) --* The ID of the root volume replacement task. * **InstanceId** *(string) --* The ID of the instance for which the root volume replacement task was created. * **TaskState** *(string) --* The state of the task. The task can be in one of the following states: * "pending" - the replacement volume is being created. * "in-progress" - the original volume is being detached and the replacement volume is being attached. * "succeeded" - the replacement volume has been successfully attached to the instance and the instance is available. * "failing" - the replacement task is in the process of failing. * "failed" - the replacement task has failed but the original root volume is still attached. * "failing-detached" - the replacement task is in the process of failing. The instance might have no root volume attached. * "failed-detached" - the replacement task has failed and the instance has no root volume attached. * **StartTime** *(string) --* The time the task was started. * **CompleteTime** *(string) --* The time the task completed. * **Tags** *(list) --* The tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ImageId** *(string) --* The ID of the AMI used to create the replacement root volume. * **SnapshotId** *(string) --* The ID of the snapshot used to create the replacement root volume. * **DeleteReplacedRootVolume** *(boolean) --* Indicates whether the original root volume is to be deleted after the root volume replacement task completes. EC2 / Paginator / GetNetworkInsightsAccessScopeAnalysisFindings GetNetworkInsightsAccessScopeAnalysisFindings ********************************************* class EC2.Paginator.GetNetworkInsightsAccessScopeAnalysisFindings paginator = client.get_paginator('get_network_insights_access_scope_analysis_findings') paginate(**kwargs) Creates an iterator that will paginate through responses from " EC2.Client.get_network_insights_access_scope_analysis_findings( )". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInsightsAccessScopeAnalysisId='string', DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInsightsAccessScopeAnalysisId** (*string*) -- **[REQUIRED]** The ID of the Network Access Scope analysis. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAccessScopeAnalysisId': 'string', 'AnalysisStatus': 'running'|'succeeded'|'failed', 'AnalysisFindings': [ { 'NetworkInsightsAccessScopeAnalysisId': 'string', 'NetworkInsightsAccessScopeId': 'string', 'FindingId': 'string', 'FindingComponents': [ { 'SequenceNumber': 123, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'OutboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'InboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AdditionalDetails': [ { 'AdditionalDetailType': 'string', 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpointService': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ], 'RuleGroupTypePairs': [ { 'RuleGroupArn': 'string', 'RuleGroupType': 'string' }, ], 'RuleGroupRuleOptionsPairs': [ { 'RuleGroupArn': 'string', 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ] }, ], 'ServiceName': 'string', 'LoadBalancers': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ] }, ], 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'Explanations': [ { 'Acl': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'Address': 'string', 'Addresses': [ 'string', ], 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AvailabilityZones': [ 'string', ], 'AvailabilityZoneIds': [ 'string', ], 'Cidrs': [ 'string', ], 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'CustomerGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Destination': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Direction': 'string', 'ExplanationCode': 'string', 'IngressRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'InternetGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerArn': 'string', 'ClassicLoadBalancerListener': { 'LoadBalancerPort': 123, 'InstancePort': 123 }, 'LoadBalancerListenerPort': 123, 'LoadBalancerTarget': { 'Address': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'Instance': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123 }, 'LoadBalancerTargetGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerTargetGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'LoadBalancerTargetPort': 123, 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'MissingComponent': 'string', 'NatGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'NetworkInterface': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'PacketField': 'string', 'VpcPeeringConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123, 'PortRanges': [ { 'From': 123, 'To': 123 }, ], 'PrefixList': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Protocols': [ 'string', ], 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'RouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SecurityGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'State': 'string', 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SubnetRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpoint': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'TransitGatewayAttachment': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'ComponentAccount': 'string', 'ComponentRegion': 'string', 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' } }, ], 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' }, 'ServiceName': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **NetworkInsightsAccessScopeAnalysisId** *(string) --* The ID of the Network Access Scope analysis. * **AnalysisStatus** *(string) --* The status of Network Access Scope Analysis. * **AnalysisFindings** *(list) --* The findings associated with Network Access Scope Analysis. * *(dict) --* Describes a finding for a Network Access Scope. * **NetworkInsightsAccessScopeAnalysisId** *(string) --* The ID of the Network Access Scope analysis. * **NetworkInsightsAccessScopeId** *(string) --* The ID of the Network Access Scope. * **FindingId** *(string) --* The ID of the finding. * **FindingComponents** *(list) --* The finding components. * *(dict) --* Describes a path component. * **SequenceNumber** *(integer) --* The sequence number. * **AclRule** *(dict) --* The network ACL rule. * **Cidr** *(string) --* The IPv4 address range, in CIDR notation. * **Egress** *(boolean) --* Indicates whether the rule is an outbound rule. * **PortRange** *(dict) --* The range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **RuleAction** *(string) --* Indicates whether to allow or deny traffic that matches the rule. * **RuleNumber** *(integer) --* The rule number. * **AttachedTo** *(dict) --* The resource to which the path component is attached. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Component** *(dict) --* The component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **DestinationVpc** *(dict) --* The destination VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **OutboundHeader** *(dict) --* The outbound header. * **DestinationAddresses** *(list) --* The destination addresses. * *(string) --* * **DestinationPortRanges** *(list) --* The destination port ranges. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **SourceAddresses** *(list) --* The source addresses. * *(string) --* * **SourcePortRanges** *(list) --* The source port ranges. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **InboundHeader** *(dict) --* The inbound header. * **DestinationAddresses** *(list) --* The destination addresses. * *(string) --* * **DestinationPortRanges** *(list) --* The destination port ranges. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **SourceAddresses** *(list) --* The source addresses. * *(string) --* * **SourcePortRanges** *(list) --* The source port ranges. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **RouteTableRoute** *(dict) --* The route table route. * **DestinationCidr** *(string) --* The destination IPv4 address, in CIDR notation. * **DestinationPrefixListId** *(string) --* The prefix of the Amazon Web Services service. * **EgressOnlyInternetGatewayId** *(string) --* The ID of an egress-only internet gateway. * **GatewayId** *(string) --* The ID of the gateway, such as an internet gateway or virtual private gateway. * **InstanceId** *(string) --* The ID of the instance, such as a NAT instance. * **NatGatewayId** *(string) --* The ID of a NAT gateway. * **NetworkInterfaceId** *(string) --* The ID of a network interface. * **Origin** *(string) --* Describes how the route was created. The following are the possible values: * CreateRouteTable - The route was automatically created when the route table was created. * CreateRoute - The route was manually added to the route table. * EnableVgwRoutePropagation - The route was propagated by route propagation. * **TransitGatewayId** *(string) --* The ID of a transit gateway. * **VpcPeeringConnectionId** *(string) --* The ID of a VPC peering connection. * **State** *(string) --* The state. The following are the possible values: * active * blackhole * **CarrierGatewayId** *(string) --* The ID of a carrier gateway. * **CoreNetworkArn** *(string) --* The Amazon Resource Name (ARN) of a core network. * **LocalGatewayId** *(string) --* The ID of a local gateway. * **SecurityGroupRule** *(dict) --* The security group rule. * **Cidr** *(string) --* The IPv4 address range, in CIDR notation. * **Direction** *(string) --* The direction. The following are the possible values: * egress * ingress * **SecurityGroupId** *(string) --* The security group ID. * **PortRange** *(dict) --* The port range. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **PrefixListId** *(string) --* The prefix list ID. * **Protocol** *(string) --* The protocol name. * **SourceVpc** *(dict) --* The source VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Subnet** *(dict) --* The subnet. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Vpc** *(dict) --* The component VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **AdditionalDetails** *(list) --* The additional details. * *(dict) --* Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes. * **AdditionalDetailType** *(string) --* The additional detail code. * **Component** *(dict) --* The path component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **VpcEndpointService** *(dict) --* The VPC endpoint service. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **RuleOptions** *(list) --* The rule options. * *(dict) --* Describes additional settings for a stateful rule. * **Keyword** *(string) --* The Suricata keyword. * **Settings** *(list) --* The settings for the keyword. * *(string) --* * **RuleGroupTypePairs** *(list) --* The rule group type. * *(dict) --* Describes the type of a stateful rule group. * **RuleGroupArn** *(string) --* The ARN of the rule group. * **RuleGroupType** *(string) --* The rule group type. The possible values are "Domain List" and "Suricata". * **RuleGroupRuleOptionsPairs** *(list) --* The rule options. * *(dict) --* Describes the rule options for a stateful rule group. * **RuleGroupArn** *(string) --* The ARN of the rule group. * **RuleOptions** *(list) --* The rule options. * *(dict) --* Describes additional settings for a stateful rule. * **Keyword** *(string) --* The Suricata keyword. * **Settings** *(list) --* The settings for the keyword. * *(string) --* * **ServiceName** *(string) --* The name of the VPC endpoint service. * **LoadBalancers** *(list) --* The load balancers. * *(dict) --* Describes a path component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **TransitGateway** *(dict) --* The transit gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **TransitGatewayRouteTableRoute** *(dict) --* The route in a transit gateway route table. * **DestinationCidr** *(string) --* The CIDR block used for destination matches. * **State** *(string) --* The state of the route. * **RouteOrigin** *(string) --* The route origin. The following are the possible values: * static * propagated * **PrefixListId** *(string) --* The ID of the prefix list. * **AttachmentId** *(string) --* The ID of the route attachment. * **ResourceId** *(string) --* The ID of the resource for the route attachment. * **ResourceType** *(string) --* The resource type for the route attachment. * **Explanations** *(list) --* The explanation codes. * *(dict) --* Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes. * **Acl** *(dict) --* The network ACL. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **AclRule** *(dict) --* The network ACL rule. * **Cidr** *(string) --* The IPv4 address range, in CIDR notation. * **Egress** *(boolean) --* Indicates whether the rule is an outbound rule. * **PortRange** *(dict) --* The range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **RuleAction** *(string) --* Indicates whether to allow or deny traffic that matches the rule. * **RuleNumber** *(integer) --* The rule number. * **Address** *(string) --* The IPv4 address, in CIDR notation. * **Addresses** *(list) --* The IPv4 addresses, in CIDR notation. * *(string) --* * **AttachedTo** *(dict) --* The resource to which the component is attached. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **AvailabilityZones** *(list) --* The Availability Zones. * *(string) --* * **AvailabilityZoneIds** *(list) --* The IDs of the Availability Zones. * *(string) --* * **Cidrs** *(list) --* The CIDR ranges. * *(string) --* * **Component** *(dict) --* The component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **CustomerGateway** *(dict) --* The customer gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Destination** *(dict) --* The destination. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **DestinationVpc** *(dict) --* The destination VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Direction** *(string) --* The direction. The following are the possible values: * egress * ingress * **ExplanationCode** *(string) --* The explanation code. * **IngressRouteTable** *(dict) --* The route table. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **InternetGateway** *(dict) --* The internet gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **LoadBalancerArn** *(string) --* The Amazon Resource Name (ARN) of the load balancer. * **ClassicLoadBalancerListener** *(dict) --* The listener for a Classic Load Balancer. * **LoadBalancerPort** *(integer) --* The port on which the load balancer is listening. * **InstancePort** *(integer) --* [Classic Load Balancers] The back-end port for the listener. * **LoadBalancerListenerPort** *(integer) --* The listener port of the load balancer. * **LoadBalancerTarget** *(dict) --* The target. * **Address** *(string) --* The IP address. * **AvailabilityZone** *(string) --* The Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. * **Instance** *(dict) --* Information about the instance. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Port** *(integer) --* The port on which the target is listening. * **LoadBalancerTargetGroup** *(dict) --* The target group. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **LoadBalancerTargetGroups** *(list) --* The target groups. * *(dict) --* Describes a path component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **LoadBalancerTargetPort** *(integer) --* The target port. * **ElasticLoadBalancerListener** *(dict) --* The load balancer listener. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **MissingComponent** *(string) --* The missing component. * **NatGateway** *(dict) --* The NAT gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **NetworkInterface** *(dict) --* The network interface. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **PacketField** *(string) --* The packet field. * **VpcPeeringConnection** *(dict) --* The VPC peering connection. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Port** *(integer) --* The port. * **PortRanges** *(list) --* The port ranges. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **PrefixList** *(dict) --* The prefix list. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Protocols** *(list) --* The protocols. * *(string) --* * **RouteTableRoute** *(dict) --* The route table route. * **DestinationCidr** *(string) --* The destination IPv4 address, in CIDR notation. * **DestinationPrefixListId** *(string) --* The prefix of the Amazon Web Services service. * **EgressOnlyInternetGatewayId** *(string) --* The ID of an egress-only internet gateway. * **GatewayId** *(string) --* The ID of the gateway, such as an internet gateway or virtual private gateway. * **InstanceId** *(string) --* The ID of the instance, such as a NAT instance. * **NatGatewayId** *(string) --* The ID of a NAT gateway. * **NetworkInterfaceId** *(string) --* The ID of a network interface. * **Origin** *(string) --* Describes how the route was created. The following are the possible values: * CreateRouteTable - The route was automatically created when the route table was created. * CreateRoute - The route was manually added to the route table. * EnableVgwRoutePropagation - The route was propagated by route propagation. * **TransitGatewayId** *(string) --* The ID of a transit gateway. * **VpcPeeringConnectionId** *(string) --* The ID of a VPC peering connection. * **State** *(string) --* The state. The following are the possible values: * active * blackhole * **CarrierGatewayId** *(string) --* The ID of a carrier gateway. * **CoreNetworkArn** *(string) --* The Amazon Resource Name (ARN) of a core network. * **LocalGatewayId** *(string) --* The ID of a local gateway. * **RouteTable** *(dict) --* The route table. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **SecurityGroup** *(dict) --* The security group. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **SecurityGroupRule** *(dict) --* The security group rule. * **Cidr** *(string) --* The IPv4 address range, in CIDR notation. * **Direction** *(string) --* The direction. The following are the possible values: * egress * ingress * **SecurityGroupId** *(string) --* The security group ID. * **PortRange** *(dict) --* The port range. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **PrefixListId** *(string) --* The prefix list ID. * **Protocol** *(string) --* The protocol name. * **SecurityGroups** *(list) --* The security groups. * *(dict) --* Describes a path component. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **SourceVpc** *(dict) --* The source VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **State** *(string) --* The state. * **Subnet** *(dict) --* The subnet. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **SubnetRouteTable** *(dict) --* The route table for the subnet. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **Vpc** *(dict) --* The component VPC. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **VpcEndpoint** *(dict) --* The VPC endpoint. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **VpnConnection** *(dict) --* The VPN connection. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **VpnGateway** *(dict) --* The VPN gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **TransitGateway** *(dict) --* The transit gateway. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **TransitGatewayRouteTable** *(dict) --* The transit gateway route table. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **TransitGatewayRouteTableRoute** *(dict) --* The transit gateway route table route. * **DestinationCidr** *(string) --* The CIDR block used for destination matches. * **State** *(string) --* The state of the route. * **RouteOrigin** *(string) --* The route origin. The following are the possible values: * static * propagated * **PrefixListId** *(string) --* The ID of the prefix list. * **AttachmentId** *(string) --* The ID of the route attachment. * **ResourceId** *(string) --* The ID of the resource for the route attachment. * **ResourceType** *(string) --* The resource type for the route attachment. * **TransitGatewayAttachment** *(dict) --* The transit gateway attachment. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **ComponentAccount** *(string) --* The Amazon Web Services account for the component. * **ComponentRegion** *(string) --* The Region for the component. * **FirewallStatelessRule** *(dict) --* The Network Firewall stateless rule. * **RuleGroupArn** *(string) --* The ARN of the stateless rule group. * **Sources** *(list) --* The source IP addresses, in CIDR notation. * *(string) --* * **Destinations** *(list) --* The destination IP addresses, in CIDR notation. * *(string) --* * **SourcePorts** *(list) --* The source ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **DestinationPorts** *(list) --* The destination ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocols** *(list) --* The protocols. * *(integer) --* * **RuleAction** *(string) --* The rule action. The possible values are "pass", "drop", and "forward_to_site". * **Priority** *(integer) --* The rule priority. * **FirewallStatefulRule** *(dict) --* The Network Firewall stateful rule. * **RuleGroupArn** *(string) --* The ARN of the stateful rule group. * **Sources** *(list) --* The source IP addresses, in CIDR notation. * *(string) --* * **Destinations** *(list) --* The destination IP addresses, in CIDR notation. * *(string) --* * **SourcePorts** *(list) --* The source ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **DestinationPorts** *(list) --* The destination ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **RuleAction** *(string) --* The rule action. The possible values are "pass", "drop", and "alert". * **Direction** *(string) --* The direction. The possible values are "FORWARD" and "ANY". * **ElasticLoadBalancerListener** *(dict) --* The load balancer listener. * **Id** *(string) --* The ID of the component. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the component. * **Name** *(string) --* The name of the analysis component. * **FirewallStatelessRule** *(dict) --* The Network Firewall stateless rule. * **RuleGroupArn** *(string) --* The ARN of the stateless rule group. * **Sources** *(list) --* The source IP addresses, in CIDR notation. * *(string) --* * **Destinations** *(list) --* The destination IP addresses, in CIDR notation. * *(string) --* * **SourcePorts** *(list) --* The source ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **DestinationPorts** *(list) --* The destination ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocols** *(list) --* The protocols. * *(integer) --* * **RuleAction** *(string) --* The rule action. The possible values are "pass", "drop", and "forward_to_site". * **Priority** *(integer) --* The rule priority. * **FirewallStatefulRule** *(dict) --* The Network Firewall stateful rule. * **RuleGroupArn** *(string) --* The ARN of the stateful rule group. * **Sources** *(list) --* The source IP addresses, in CIDR notation. * *(string) --* * **Destinations** *(list) --* The destination IP addresses, in CIDR notation. * *(string) --* * **SourcePorts** *(list) --* The source ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **DestinationPorts** *(list) --* The destination ports. * *(dict) --* Describes a range of ports. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol. * **RuleAction** *(string) --* The rule action. The possible values are "pass", "drop", and "alert". * **Direction** *(string) --* The direction. The possible values are "FORWARD" and "ANY". * **ServiceName** *(string) --* The name of the VPC endpoint service. EC2 / Paginator / DescribeRouteServerEndpoints DescribeRouteServerEndpoints **************************** class EC2.Paginator.DescribeRouteServerEndpoints paginator = client.get_paginator('describe_route_server_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_route_server_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RouteServerEndpointIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RouteServerEndpointIds** (*list*) -- The IDs of the route server endpoints to describe. * *(string) --* * **Filters** (*list*) -- One or more filters to apply to the describe request. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RouteServerEndpoints': [ { 'RouteServerId': 'string', 'RouteServerEndpointId': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'EniId': 'string', 'EniAddress': 'string', 'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed', 'FailureReason': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **RouteServerEndpoints** *(list) --* Information about the described route server endpoints. * *(dict) --* Describes a route server endpoint and its properties. A route server endpoint is an Amazon Web Services- managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. * **RouteServerId** *(string) --* The ID of the route server associated with this endpoint. * **RouteServerEndpointId** *(string) --* The unique identifier of the route server endpoint. * **VpcId** *(string) --* The ID of the VPC containing the endpoint. * **SubnetId** *(string) --* The ID of the subnet to place the route server endpoint into. * **EniId** *(string) --* The ID of the Elastic network interface for the endpoint. * **EniAddress** *(string) --* The IP address of the Elastic network interface for the endpoint. * **State** *(string) --* The current state of the route server endpoint. * **FailureReason** *(string) --* The reason for any failure in endpoint creation or operation. * **Tags** *(list) --* Any tags assigned to the route server endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeLocalGatewayVirtualInterfaces DescribeLocalGatewayVirtualInterfaces ************************************* class EC2.Paginator.DescribeLocalGatewayVirtualInterfaces paginator = client.get_paginator('describe_local_gateway_virtual_interfaces') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_local_gateway_virtual_interfaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayVirtualInterfaceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayVirtualInterfaceIds** (*list*) -- The IDs of the virtual interfaces. * *(string) --* * **Filters** (*list*) -- One or more filters. * "local-address" - The local address. * "local-bgp-asn" - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. * "local-gateway-id" - The ID of the local gateway. * "local-gateway-virtual-interface-id" - The ID of the virtual interface. * "owner-id" - The ID of the Amazon Web Services account that owns the local gateway virtual interface. * "peer-address" - The peer address. * "peer-bgp-asn" - The peer BGP ASN. * "vlan" - The ID of the VLAN. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LocalGatewayVirtualInterfaces': [ { 'LocalGatewayVirtualInterfaceId': 'string', 'LocalGatewayId': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayVirtualInterfaceArn': 'string', 'OutpostLagId': 'string', 'Vlan': 123, 'LocalAddress': 'string', 'PeerAddress': 'string', 'LocalBgpAsn': 123, 'PeerBgpAsn': 123, 'PeerBgpAsnExtended': 123, 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConfigurationState': 'pending'|'available'|'deleting'|'deleted' }, ], } **Response Structure** * *(dict) --* * **LocalGatewayVirtualInterfaces** *(list) --* Information about the virtual interfaces. * *(dict) --* Describes a local gateway virtual interface. * **LocalGatewayVirtualInterfaceId** *(string) --* The ID of the virtual interface. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the local gateway virtual interface group. * **LocalGatewayVirtualInterfaceArn** *(string) --* The Amazon Resource Number (ARN) of the local gateway virtual interface. * **OutpostLagId** *(string) --* The Outpost LAG ID. * **Vlan** *(integer) --* The ID of the VLAN. * **LocalAddress** *(string) --* The local address. * **PeerAddress** *(string) --* The peer address. * **LocalBgpAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. * **PeerBgpAsn** *(integer) --* The peer BGP ASN. * **PeerBgpAsnExtended** *(integer) --* The extended 32-bit ASN of the BGP peer for use with larger ASN values. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface. * **Tags** *(list) --* The tags assigned to the virtual interface. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConfigurationState** *(string) --* The current state of the local gateway virtual interface. EC2 / Paginator / DescribeTransitGatewayConnectPeers DescribeTransitGatewayConnectPeers ********************************** class EC2.Paginator.DescribeTransitGatewayConnectPeers paginator = client.get_paginator('describe_transit_gateway_connect_peers') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_connect_peers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayConnectPeerIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayConnectPeerIds** (*list*) -- The IDs of the Connect peers. * *(string) --* * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayConnectPeers': [ { 'TransitGatewayAttachmentId': 'string', 'TransitGatewayConnectPeerId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'ConnectPeerConfiguration': { 'TransitGatewayAddress': 'string', 'PeerAddress': 'string', 'InsideCidrBlocks': [ 'string', ], 'Protocol': 'gre', 'BgpConfigurations': [ { 'TransitGatewayAsn': 123, 'PeerAsn': 123, 'TransitGatewayAddress': 'string', 'PeerAddress': 'string', 'BgpStatus': 'up'|'down' }, ] }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayConnectPeers** *(list) --* Information about the Connect peers. * *(dict) --* Describes a transit gateway Connect peer. * **TransitGatewayAttachmentId** *(string) --* The ID of the Connect attachment. * **TransitGatewayConnectPeerId** *(string) --* The ID of the Connect peer. * **State** *(string) --* The state of the Connect peer. * **CreationTime** *(datetime) --* The creation time. * **ConnectPeerConfiguration** *(dict) --* The Connect peer details. * **TransitGatewayAddress** *(string) --* The Connect peer IP address on the transit gateway side of the tunnel. * **PeerAddress** *(string) --* The Connect peer IP address on the appliance side of the tunnel. * **InsideCidrBlocks** *(list) --* The range of interior BGP peer IP addresses. * *(string) --* * **Protocol** *(string) --* The tunnel protocol. * **BgpConfigurations** *(list) --* The BGP configuration details. * *(dict) --* The BGP configuration information. * **TransitGatewayAsn** *(integer) --* The transit gateway Autonomous System Number (ASN). * **PeerAsn** *(integer) --* The peer Autonomous System Number (ASN). * **TransitGatewayAddress** *(string) --* The interior BGP peer IP address for the transit gateway. * **PeerAddress** *(string) --* The interior BGP peer IP address for the appliance. * **BgpStatus** *(string) --* The BGP status. * **Tags** *(list) --* The tags for the Connect peer. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeVpcClassicLinkDnsSupport DescribeVpcClassicLinkDnsSupport ******************************** class EC2.Paginator.DescribeVpcClassicLinkDnsSupport paginator = client.get_paginator('describe_vpc_classic_link_dns_support') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_classic_link_dns_support()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VpcIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VpcIds** (*list*) -- The IDs of the VPCs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Vpcs': [ { 'ClassicLinkDnsSupported': True|False, 'VpcId': 'string' }, ] } **Response Structure** * *(dict) --* * **Vpcs** *(list) --* Information about the ClassicLink DNS support status of the VPCs. * *(dict) --* Note: Deprecated. Describes the ClassicLink DNS support status of a VPC. * **ClassicLinkDnsSupported** *(boolean) --* Indicates whether ClassicLink DNS support is enabled for the VPC. * **VpcId** *(string) --* The ID of the VPC. EC2 / Paginator / GetIpamPoolCidrs GetIpamPoolCidrs **************** class EC2.Paginator.GetIpamPoolCidrs paginator = client.get_paginator('get_ipam_pool_cidrs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_ipam_pool_cidrs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, IpamPoolId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamPoolId** (*string*) -- **[REQUIRED]** The ID of the IPAM pool you want the CIDR for. * **Filters** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamPoolCidrs': [ { 'Cidr': 'string', 'State': 'pending-provision'|'provisioned'|'failed-provision'|'pending-deprovision'|'deprovisioned'|'failed-deprovision'|'pending-import'|'failed-import', 'FailureReason': { 'Code': 'cidr-not-available'|'limit-exceeded', 'Message': 'string' }, 'IpamPoolCidrId': 'string', 'NetmaskLength': 123 }, ], } **Response Structure** * *(dict) --* * **IpamPoolCidrs** *(list) --* Information about the CIDRs provisioned to an IPAM pool. * *(dict) --* A CIDR provisioned to an IPAM pool. * **Cidr** *(string) --* The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is "10.24.34.0/23". An IPv6 CIDR example is "2001:DB8::/32". * **State** *(string) --* The state of the CIDR. * **FailureReason** *(dict) --* Details related to why an IPAM pool CIDR failed to be provisioned. * **Code** *(string) --* An error code related to why an IPAM pool CIDR failed to be provisioned. * **Message** *(string) --* A message related to why an IPAM pool CIDR failed to be provisioned. * **IpamPoolCidrId** *(string) --* The IPAM pool CIDR ID. * **NetmaskLength** *(integer) --* The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required. EC2 / Paginator / DescribeNatGateways DescribeNatGateways ******************* class EC2.Paginator.DescribeNatGateways paginator = client.get_paginator('describe_nat_gateways') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_nat_gateways()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NatGatewayIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "nat-gateway-id" - The ID of the NAT gateway. * "state" - The state of the NAT gateway ( "pending" | "failed" | "available" | "deleting" | "deleted"). * "subnet-id" - The ID of the subnet in which the NAT gateway resides. * "tag" - 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 in which the NAT gateway resides. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NatGatewayIds** (*list*) -- The IDs of the NAT gateways. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NatGateways': [ { 'CreateTime': datetime(2015, 1, 1), 'DeleteTime': datetime(2015, 1, 1), 'FailureCode': 'string', 'FailureMessage': 'string', 'NatGatewayAddresses': [ { 'AllocationId': 'string', 'NetworkInterfaceId': 'string', 'PrivateIp': 'string', 'PublicIp': 'string', 'AssociationId': 'string', 'IsPrimary': True|False, 'FailureMessage': 'string', 'Status': 'assigning'|'unassigning'|'associating'|'disassociating'|'succeeded'|'failed' }, ], 'NatGatewayId': 'string', 'ProvisionedBandwidth': { 'ProvisionTime': datetime(2015, 1, 1), 'Provisioned': 'string', 'RequestTime': datetime(2015, 1, 1), 'Requested': 'string', 'Status': 'string' }, 'State': 'pending'|'failed'|'available'|'deleting'|'deleted', 'SubnetId': 'string', 'VpcId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConnectivityType': 'private'|'public' }, ], } **Response Structure** * *(dict) --* * **NatGateways** *(list) --* Information about the NAT gateways. * *(dict) --* Describes a NAT gateway. * **CreateTime** *(datetime) --* The date and time the NAT gateway was created. * **DeleteTime** *(datetime) --* The date and time the NAT gateway was deleted, if applicable. * **FailureCode** *(string) --* If the NAT gateway could not be created, specifies the error code for the failure. ( "InsufficientFreeAddressesInSubnet" | "Gateway.NotAttached" | "InvalidAllocationID.NotFound" | "Resource.AlreadyAssociated" | "InternalError" | "InvalidSubnetID.NotFound") * **FailureMessage** *(string) --* If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code. * For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway" * For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached" * For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway" * For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated" * For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again." * For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found." * **NatGatewayAddresses** *(list) --* Information about the IP addresses and network interface associated with the NAT gateway. * *(dict) --* Describes the IP addresses and network interface associated with a NAT gateway. * **AllocationId** *(string) --* [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. * **NetworkInterfaceId** *(string) --* The ID of the network interface associated with the NAT gateway. * **PrivateIp** *(string) --* The private IP address associated with the NAT gateway. * **PublicIp** *(string) --* [Public NAT gateway only] The Elastic IP address associated with the NAT gateway. * **AssociationId** *(string) --* [Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway. * **IsPrimary** *(boolean) --* Defines if the IP address is the primary address. * **FailureMessage** *(string) --* The address failure message. * **Status** *(string) --* The address status. * **NatGatewayId** *(string) --* The ID of the NAT gateway. * **ProvisionedBandwidth** *(dict) --* Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support. * **ProvisionTime** *(datetime) --* Reserved. * **Provisioned** *(string) --* Reserved. * **RequestTime** *(datetime) --* Reserved. * **Requested** *(string) --* Reserved. * **Status** *(string) --* Reserved. * **State** *(string) --* The state of the NAT gateway. * "pending": The NAT gateway is being created and is not ready to process traffic. * "failed": The NAT gateway could not be created. Check the "failureCode" and "failureMessage" fields for the reason. * "available": The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. * "deleting": The NAT gateway is in the process of being terminated and may still be processing traffic. * "deleted": The NAT gateway has been terminated and is no longer processing traffic. * **SubnetId** *(string) --* The ID of the subnet in which the NAT gateway is located. * **VpcId** *(string) --* The ID of the VPC in which the NAT gateway is located. * **Tags** *(list) --* The tags for the NAT gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConnectivityType** *(string) --* Indicates whether the NAT gateway supports public or private connectivity. EC2 / Paginator / DescribeIpamResourceDiscoveries DescribeIpamResourceDiscoveries ******************************* class EC2.Paginator.DescribeIpamResourceDiscoveries paginator = client.get_paginator('describe_ipam_resource_discoveries') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipam_resource_discoveries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, IpamResourceDiscoveryIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryIds** (*list*) -- The IPAM resource discovery IDs. * *(string) --* * **Filters** (*list*) -- The resource discovery filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamResourceDiscoveries': [ { 'OwnerId': 'string', 'IpamResourceDiscoveryId': 'string', 'IpamResourceDiscoveryArn': 'string', 'IpamResourceDiscoveryRegion': 'string', 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'IsDefault': True|False, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OrganizationalUnitExclusions': [ { 'OrganizationsEntityPath': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **IpamResourceDiscoveries** *(list) --* The resource discoveries. * *(dict) --* A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. * **OwnerId** *(string) --* The ID of the owner. * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **IpamResourceDiscoveryArn** *(string) --* The resource discovery Amazon Resource Name (ARN). * **IpamResourceDiscoveryRegion** *(string) --* The resource discovery Region. * **Description** *(string) --* The resource discovery description. * **OperatingRegions** *(list) --* The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **IsDefault** *(boolean) --* Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM. * **State** *(string) --* The lifecycle state of the resource discovery. * "create-in-progress" - Resource discovery is being created. * "create-complete" - Resource discovery creation is complete. * "create-failed" - Resource discovery creation has failed. * "modify-in-progress" - Resource discovery is being modified. * "modify-complete" - Resource discovery modification is complete. * "modify-failed" - Resource discovery modification has failed. * "delete-in-progress" - Resource discovery is being deleted. * "delete-complete" - Resource discovery deletion is complete. * "delete-failed" - Resource discovery deletion has failed. * "isolate-in-progress" - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. * "isolate-complete" - Resource discovery isolation is complete. * "restore-in-progress" - Amazon Web Services account that created the resource discovery and was isolated has been restored. * **Tags** *(list) --* A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OrganizationalUnitExclusions** *(list) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * *(dict) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * **OrganizationsEntityPath** *(string) --* An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the *Amazon Web Services Identity and Access Management User Guide*. EC2 / Paginator / DescribeSpotInstanceRequests DescribeSpotInstanceRequests **************************** class EC2.Paginator.DescribeSpotInstanceRequests paginator = client.get_paginator('describe_spot_instance_requests') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_spot_instance_requests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, SpotInstanceRequestIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotInstanceRequestIds** (*list*) -- The IDs of the Spot Instance requests. * *(string) --* * **Filters** (*list*) -- The 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" or "gp3" for General Purpose SSD, "io1" or "io2" for Provisioned IOPS SSD, "st1" for Throughput Optimized HDD, "sc1" for 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*. * "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:" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SpotInstanceRequests': [ { 'ActualBlockHourlyPrice': 'string', 'AvailabilityZoneGroup': 'string', 'BlockDurationMinutes': 123, 'CreateTime': datetime(2015, 1, 1), 'Fault': { 'Code': 'string', 'Message': 'string' }, 'InstanceId': 'string', 'LaunchGroup': 'string', 'LaunchSpecification': { 'UserData': 'string', 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SubnetId': 'string', 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Monitoring': { 'Enabled': True|False } }, 'LaunchedAvailabilityZone': 'string', 'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)', 'SpotInstanceRequestId': 'string', 'SpotPrice': 'string', 'State': 'open'|'active'|'closed'|'cancelled'|'failed'|'disabled', 'Status': { 'Code': 'string', 'Message': 'string', 'UpdateTime': datetime(2015, 1, 1) }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Type': 'one-time'|'persistent', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' }, ], } **Response Structure** * *(dict) --* Contains the output of DescribeSpotInstanceRequests. * **SpotInstanceRequests** *(list) --* The Spot Instance requests. * *(dict) --* Describes a Spot Instance request. * **ActualBlockHourlyPrice** *(string) --* Deprecated. * **AvailabilityZoneGroup** *(string) --* The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. * **BlockDurationMinutes** *(integer) --* Deprecated. * **CreateTime** *(datetime) --* The date and time when the Spot Instance request was created, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInterfaces': [ { 'Association': { 'AllocationId': 'string', 'AssociationId': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string', 'CustomerOwnedIp': 'string', 'CarrierIp': 'string' }, 'Attachment': { 'AttachTime': datetime(2015, 1, 1), 'AttachmentId': 'string', 'DeleteOnTermination': True|False, 'DeviceIndex': 123, 'NetworkCardIndex': 123, 'InstanceId': 'string', 'InstanceOwnerId': 'string', 'Status': 'attaching'|'attached'|'detaching'|'detached', 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'EnaQueueCount': 123 }, 'AvailabilityZone': 'string', 'ConnectionTrackingConfiguration': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'Description': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed', 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'PublicIpv6DnsName': 'string', 'IsPrimaryIpv6': True|False }, ], 'MacAddress': 'string', 'NetworkInterfaceId': 'string', 'OutpostArn': 'string', 'OwnerId': 'string', 'PrivateDnsName': 'string', 'PublicDnsName': 'string', 'PublicIpDnsNameOptions': { 'DnsHostnameType': 'string', 'PublicIpv4DnsName': 'string', 'PublicIpv6DnsName': 'string', 'PublicDualStackDnsName': 'string' }, 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Association': { 'AllocationId': 'string', 'AssociationId': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string', 'CustomerOwnedIp': 'string', 'CarrierIp': 'string' }, 'Primary': True|False, 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string' }, ], 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'RequesterId': 'string', 'RequesterManaged': True|False, 'SourceDestCheck': True|False, 'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching', 'SubnetId': 'string', 'TagSet': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'DenyAllIgwTraffic': True|False, 'Ipv6Native': True|False, 'Ipv6Address': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'AssociatedSubnets': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **NetworkInterfaces** *(list) --* Information about the network interfaces. * *(dict) --* Describes a network interface. * **Association** *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. * **Attachment** *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The timestamp indicating when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The device index of the network interface attachment on the instance. * **NetworkCardIndex** *(integer) --* The index of the network card. * **InstanceId** *(string) --* The ID of the instance. * **InstanceOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the instance. * **Status** *(string) --* The attachment state. * **EnaSrdSpecification** *(dict) --* Configures ENA Express for the network interface that this action attaches to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **AvailabilityZone** *(string) --* The Availability Zone. * **ConnectionTrackingConfiguration** *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request- response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Description** *(string) --* A description. * **Groups** *(list) --* Any security groups for the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **InterfaceType** *(string) --* The type of network interface. * **Ipv6Addresses** *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address associated with a network interface. * **Ipv6Address** *(string) --* The IPv6 address. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute. * **MacAddress** *(string) --* The MAC address. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the network interface. * **PrivateDnsName** *(string) --* The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicDnsName** *(string) --* A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicIpDnsNameOptions** *(dict) --* Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **DnsHostnameType** *(string) --* The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicIpv4DnsName** *(string) --* An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. * **PublicDualStackDnsName** *(string) --* A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes the private IPv4 address of a network interface. * **Association** *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **Ipv4Prefixes** *(list) --* The IPv4 prefixes that are assigned to the network interface. * *(dict) --* Describes an IPv4 prefix. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv6Prefixes** *(list) --* The IPv6 prefixes that are assigned to the network interface. * *(dict) --* Describes the IPv6 prefix. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **RequesterId** *(string) --* The alias or Amazon Web Services account ID of the principal or service that created the network interface. * **RequesterManaged** *(boolean) --* Indicates whether the network interface is being managed by Amazon Web Services. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **Status** *(string) --* The status of the network interface. * **SubnetId** *(string) --* The ID of the subnet. * **TagSet** *(list) --* Any tags assigned to the network interface. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC. * **DenyAllIgwTraffic** *(boolean) --* Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is "true", inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on- premises networks. * **Ipv6Native** *(boolean) --* Indicates whether this is an IPv6 only network interface. * **Ipv6Address** *(string) --* The IPv6 globally unique address associated with the network interface. * **Operator** *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **AssociatedSubnets** *(list) --* The subnets associated with this network interface. * *(string) --* EC2 / Paginator / DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations *************************************************************** class EC2.Paginator.DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations paginator = client.get_paginator('describe_local_gateway_route_table_virtual_interface_group_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " EC2.Client.describe_local_gateway_route_table_virtual_interface _group_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayRouteTableVirtualInterfaceGroupAssociationId s** (*list*) -- The IDs of the associations. * *(string) --* * **Filters** (*list*) -- One or more filters. * "local-gateway-id" - The ID of a local gateway. * "local-gateway-route-table-arn" - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. * "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. * "owner-id" - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. * "state" - The state of the association. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTableVirtualInterfaceGroupAssociations': [ { 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayId': 'string', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **LocalGatewayRouteTableVirtualInterfaceGroupAssociation s** *(list) --* Information about the associations. * *(dict) --* Describes an association between a local gateway route table and a virtual interface group. * **LocalGatewayRouteTableVirtualInterfaceGroupAssocia tionId** *(string) --* The ID of the association. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. * **State** *(string) --* The state of the association. * **Tags** *(list) --* The tags assigned to the association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeIpamResourceDiscoveryAssociations DescribeIpamResourceDiscoveryAssociations ***************************************** class EC2.Paginator.DescribeIpamResourceDiscoveryAssociations paginator = client.get_paginator('describe_ipam_resource_discovery_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipam_resource_discovery_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, IpamResourceDiscoveryAssociationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryAssociationIds** (*list*) -- The resource discovery association IDs. * *(string) --* * **Filters** (*list*) -- The resource discovery association filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamResourceDiscoveryAssociations': [ { 'OwnerId': 'string', 'IpamResourceDiscoveryAssociationId': 'string', 'IpamResourceDiscoveryAssociationArn': 'string', 'IpamResourceDiscoveryId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'IsDefault': True|False, 'ResourceDiscoveryStatus': 'active'|'not-found', 'State': 'associate-in-progress'|'associate-complete'|'associate-failed'|'disassociate-in-progress'|'disassociate-complete'|'disassociate-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **IpamResourceDiscoveryAssociations** *(list) --* The resource discovery associations. * *(dict) --* An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery. * **OwnerId** *(string) --* The Amazon Web Services account ID of the resource discovery owner. * **IpamResourceDiscoveryAssociationId** *(string) --* The resource discovery association ID. * **IpamResourceDiscoveryAssociationArn** *(string) --* The resource discovery association Amazon Resource Name (ARN). * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **IpamId** *(string) --* The IPAM ID. * **IpamArn** *(string) --* The IPAM ARN. * **IpamRegion** *(string) --* The IPAM home Region. * **IsDefault** *(boolean) --* Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM. * **ResourceDiscoveryStatus** *(string) --* The resource discovery status. * "active" - Connection or permissions required to read the results of the resource discovery are intact. * "not-found" - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact. * **State** *(string) --* The lifecycle state of the association when you associate or disassociate a resource discovery. * "associate-in-progress" - Resource discovery is being associated. * "associate-complete" - Resource discovery association is complete. * "associate-failed" - Resource discovery association has failed. * "disassociate-in-progress" - Resource discovery is being disassociated. * "disassociate-complete" - Resource discovery disassociation is complete. * "disassociate-failed" - Resource discovery disassociation has failed. * "isolate-in-progress" - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated. * "isolate-complete" - Resource discovery isolation is complete.. * "restore-in-progress" - Resource discovery is being restored. * **Tags** *(list) --* A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeLaunchTemplates DescribeLaunchTemplates *********************** class EC2.Paginator.DescribeLaunchTemplates paginator = client.get_paginator('describe_launch_templates') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_launch_templates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, LaunchTemplateIds=[ 'string', ], LaunchTemplateNames=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **LaunchTemplateIds** (*list*) -- One or more launch template IDs. * *(string) --* * **LaunchTemplateNames** (*list*) -- One or more launch template names. * *(string) --* * **Filters** (*list*) -- One or more filters. * "create-time" - The time the launch template was created. * "launch-template-name" - The name of the launch template. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LaunchTemplates': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersionNumber': 123, 'LatestVersionNumber': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], } **Response Structure** * *(dict) --* * **LaunchTemplates** *(list) --* Information about the launch templates. * *(dict) --* Describes a launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **CreateTime** *(datetime) --* The time launch template was created. * **CreatedBy** *(string) --* The principal that created the launch template. * **DefaultVersionNumber** *(integer) --* The version number of the default version of the launch template. * **LatestVersionNumber** *(integer) --* The version number of the latest version of the launch template. * **Tags** *(list) --* The tags for the launch template. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. EC2 / Paginator / DescribeSpotFleetRequests DescribeSpotFleetRequests ************************* class EC2.Paginator.DescribeSpotFleetRequests paginator = client.get_paginator('describe_spot_fleet_requests') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_spot_fleet_requests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, SpotFleetRequestIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotFleetRequestIds** (*list*) -- The IDs of the Spot Fleet requests. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SpotFleetRequestConfigs': [ { 'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled', 'CreateTime': datetime(2015, 1, 1), 'SpotFleetRequestConfig': { 'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized'|'priceCapacityOptimized', 'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized', 'SpotMaintenanceStrategies': { 'CapacityRebalance': { 'ReplacementStrategy': 'launch'|'launch-before-terminate', 'TerminationDelay': 123 } }, 'ClientToken': 'string', 'ExcessCapacityTerminationPolicy': 'noTermination'|'default', 'FulfilledCapacity': 123.0, 'OnDemandFulfilledCapacity': 123.0, 'IamFleetRole': 'string', 'LaunchSpecifications': [ { 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SpotPrice': 'string', 'SubnetId': 'string', 'UserData': 'string', 'WeightedCapacity': 123.0, 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ] }, ], 'LaunchTemplateConfigs': [ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'SpotPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, ] }, ], 'SpotPrice': 'string', 'TargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'OnDemandMaxTotalPrice': 'string', 'SpotMaxTotalPrice': 'string', 'TerminateInstancesWithExpiration': True|False, 'Type': 'request'|'maintain'|'instant', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'ReplaceUnhealthyInstances': True|False, 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate', 'LoadBalancersConfig': { 'ClassicLoadBalancersConfig': { 'ClassicLoadBalancers': [ { 'Name': 'string' }, ] }, 'TargetGroupsConfig': { 'TargetGroups': [ { 'Arn': 'string' }, ] } }, 'InstancePoolsToUseCount': 123, 'Context': 'string', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] }, 'SpotFleetRequestId': 'string', 'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeSpotFleetRequests. * **SpotFleetRequestConfigs** *(list) --* Information about the configuration of your Spot Fleet. * *(dict) --* Describes a Spot Fleet request. * **ActivityStatus** *(string) --* The progress of the Spot Fleet request. If there is an error, the status is "error". After all requests are placed, the status is "pending_fulfillment". If the size of the fleet is equal to or greater than its target capacity, the status is "fulfilled". If the size of the fleet is decreased, the status is "pending_termination" while Spot Instances are terminating. * **CreateTime** *(datetime) --* The creation date and time of the request. * **SpotFleetRequestConfig** *(dict) --* The configuration of the Spot Fleet request. * **AllocationStrategy** *(string) --* The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the *Amazon EC2 User Guide*. priceCapacityOptimized (recommended) Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. capacityOptimized Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use "capacityOptimizedPrioritized". Set a priority for each instance type by using the "Priority" parameter for "LaunchTemplateOverrides". You can assign the same priority to different "LaunchTemplateOverrides". EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. "capacityOptimizedPrioritized" is supported only if your Spot Fleet uses a launch template. Note that if the "OnDemandAllocationStrategy" is set to "prioritized", the same priority is applied when fulfilling On-Demand capacity. diversified Spot Fleet requests instances from all of the Spot Instance pools that you specify. lowestPrice (not recommended) Warning: We don't recommend the "lowestPrice" allocation strategy because it has the highest risk of interruption for your Spot Instances. Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates. Default: "lowestPrice" * **OnDemandAllocationStrategy** *(string) --* The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify "lowestPrice", Spot Fleet uses price to determine the order, launching the lowest price first. If you specify "prioritized", Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to "lowestPrice". * **SpotMaintenanceStrategies** *(dict) --* The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. * **CapacityRebalance** *(dict) --* The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the *Amazon EC2 User Guide*. * **ReplacementStrategy** *(string) --* The replacement strategy to use. Only available for fleets of type "maintain". "launch" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running. "launch-before-terminate" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in "TerminationDelay"), terminates the instances that received a rebalance notification. * **TerminationDelay** *(integer) --* The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance. Required when "ReplacementStrategy" is set to "launch-before-terminate". Not valid when "ReplacementStrategy" is set to "launch". Valid values: Minimum value of "120" seconds. Maximum value of "7200" seconds. * **ClientToken** *(string) --* A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency. * **ExcessCapacityTerminationPolicy** *(string) --* Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. Supported only for fleets of type "maintain". * **FulfilledCapacity** *(float) --* The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. * **OnDemandFulfilledCapacity** *(float) --* The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. * **IamFleetRole** *(string) --* The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the *Amazon EC2 User Guide*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set "TerminateInstancesWithExpiration". * **LaunchSpecifications** *(list) --* The launch specifications for the Spot Fleet request. If you specify "LaunchSpecifications", you can't specify "LaunchTemplateConfigs". If you include On-Demand capacity in your request, you must use "LaunchTemplateConfigs". Note: If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type "maintain", the target capacity will not be maintained. * *(dict) --* Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use "SpotFleetLaunchSpecification"; you must use LaunchTemplateConfig. * **AddressingType** *(string) --* Deprecated. * **BlockDeviceMappings** *(list) --* One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us- east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **EbsOptimized** *(boolean) --* Indicates whether the instances are optimized for 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. Default: "false" * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **ImageId** *(string) --* The ID of the AMI. * **InstanceType** *(string) --* The instance type. * **KernelId** *(string) --* The ID of the kernel. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* Enable or disable monitoring for the instances. * **Enabled** *(boolean) --* Enables monitoring for the instance. Default: "false" * **NetworkInterfaces** *(list) --* The network interfaces. Note: "SpotFleetLaunchSpecification" does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead. * *(dict) --* Describes a network interface. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is "true". Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* If set to "true", the interface is deleted when the instance is terminated. You can specify "true" only if creating a new network interface when launching an instance. * **Description** *(string) --* The description of the network interface. Applies only if creating a network interface when launching an instance. * **DeviceIndex** *(integer) --* The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index. * **Groups** *(list) --* The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. * *(string) --* * **Ipv6AddressCount** *(integer) --* A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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. * **Ipv6Addresses** *(list) --* The IPv6 addresses to assign to the 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the "PrivateIpAddress" parameter. * **SubnetId** *(string) --* The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the *Amazon Web Services Wavelength Developer Guide*. * **InterfaceType** *(string) --* The type of network interface. If you specify "efa-only", do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Valid values: "interface" | "efa" | "efa- only" * **NetworkCardIndex** *(integer) --* 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. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances. * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv4PrefixCount" option. * *(dict) --* Describes the IPv4 prefix option for a network interface. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv4Prefix" option. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv6PrefixCount" option. * *(dict) --* Describes the IPv6 prefix option for a network interface. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv6Prefix" option. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Specifies the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Specifies whether ENA Express is enabled for the network interface when you launch an instance. * **EnaSrdUdpSpecification** *(dict) --* Contains ENA Express settings for UDP network traffic for the network interface attached to the instance. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set **EnaSrdEnabled** in the **EnaSrdSpecificationRequest** to "true". * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **Placement** *(dict) --* The placement information. * **AvailabilityZone** *(string) --* The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west- 2b". * **GroupName** *(string) --* The name of the placement group. * **Tenancy** *(string) --* The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of "dedicated" runs on single-tenant hardware. The "host" tenancy is not supported for Spot Instances. * **RamdiskId** *(string) --* The ID of the RAM disk. 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, refer to the Amazon Web Services Resource Center and search for the kernel ID. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet- 0987cdef6example2". If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter. * **UserData** *(string) --* The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **TagSpecifications** *(list) --* The tags to apply during creation. * *(dict) --* The tags for a Spot Fleet resource. * **ResourceType** *(string) --* The type of resource. Currently, the only resource type that is supported is "instance". To tag the Spot Fleet request on creation, use the "TagSpecifications" parameter in >>``<>``<<. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case- sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case- sensitive and accept a maximum of 256 Unicode characters. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemand Price" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandP rice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemand Price" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in- 24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTyp esFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SecurityGroups** *(list) --* The security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **LaunchTemplateConfigs** *(list) --* The launch template and overrides. If you specify "LaunchTemplateConfigs", you can't specify "LaunchSpecifications". If you include On-Demand capacity in your request, you must use "LaunchTemplateConfigs". * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template to use. Make sure that the launch template does not contain the "NetworkInterfaceId" parameter because you can't specify a network interface ID in a Spot Fleet. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If "OnDemandAllocationStrategy" is set to "prioritized", Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacityOptimizedPrioritized", Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides. * **InstanceRequirements** *(dict) --* The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web- services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalO nDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPr ice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web- services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDem andPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalO nDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for Ge tInstanceTypesFromInstanceRequir ements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **TargetCapacity** *(integer) --* The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandMaxTotalPrice** *(string) --* The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the "onDemandMaxTotalPrice" parameter, the "spotMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "onDemandMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "onDemandMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **SpotMaxTotalPrice** *(string) --* The maximum amount per hour for Spot Instances that you're willing to pay. You can use the "spotMaxTotalPrice" parameter, the "onDemandMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "spotMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "spotMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **TerminateInstancesWithExpiration** *(boolean) --* Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. * **Type** *(string) --* The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is "request", the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is "maintain", the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: "maintain". "instant" is listed but is not used by Spot Fleet. * **ValidFrom** *(datetime) --* The start date and time of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PublicIpv4Pools': [ { 'PoolId': 'string', 'Description': 'string', 'PoolAddressRanges': [ { 'FirstAddress': 'string', 'LastAddress': 'string', 'AddressCount': 123, 'AvailableAddressCount': 123 }, ], 'TotalAddressCount': 123, 'TotalAvailableAddressCount': 123, 'NetworkBorderGroup': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **PublicIpv4Pools** *(list) --* Information about the address pools. * *(dict) --* Describes an IPv4 address pool. * **PoolId** *(string) --* The ID of the address pool. * **Description** *(string) --* A description of the address pool. * **PoolAddressRanges** *(list) --* The address ranges. * *(dict) --* Describes an address range of an IPv4 address pool. * **FirstAddress** *(string) --* The first IP address in the range. * **LastAddress** *(string) --* The last IP address in the range. * **AddressCount** *(integer) --* The number of addresses in the range. * **AvailableAddressCount** *(integer) --* The number of available addresses in the range. * **TotalAddressCount** *(integer) --* The total number of addresses. * **TotalAvailableAddressCount** *(integer) --* The total number of available addresses. * **NetworkBorderGroup** *(string) --* The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses. * **Tags** *(list) --* Any tags for the address pool. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeSnapshots DescribeSnapshots ***************** class EC2.Paginator.DescribeSnapshots paginator = client.get_paginator('describe_snapshots') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_snapshots()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( OwnerIds=[ 'string', ], RestorableByUserIds=[ 'string', ], SnapshotIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **OwnerIds** (*list*) -- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", and "amazon". * *(string) --* * **RestorableByUserIds** (*list*) -- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. * *(string) --* * **SnapshotIds** (*list*) -- The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. * "owner-id" - The Amazon Web Services 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"). * "storage-tier" - The storage tier of the snapshot ( "archive" | "standard"). * "transfer-type" - The type of operation used to create the snapshot ( "time-based" | "standard"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Snapshots': [ { 'OwnerAlias': 'string', 'OutpostArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'StorageTier': 'archive'|'standard', 'RestoreExpiryTime': datetime(2015, 1, 1), 'SseType': 'sse-ebs'|'sse-kms'|'none', 'AvailabilityZone': 'string', 'TransferType': 'time-based'|'standard', 'CompletionDurationMinutes': 123, 'CompletionTime': datetime(2015, 1, 1), 'FullSnapshotSizeInBytes': 123, 'SnapshotId': 'string', 'VolumeId': 'string', 'State': 'pending'|'completed'|'error'|'recoverable'|'recovering', 'StateMessage': 'string', 'StartTime': datetime(2015, 1, 1), 'Progress': 'string', 'OwnerId': 'string', 'Description': 'string', 'VolumeSize': 123, 'Encrypted': True|False, 'KmsKeyId': 'string', 'DataEncryptionKeyId': 'string' }, ] } **Response Structure** * *(dict) --* * **Snapshots** *(list) --* Information about the snapshots. * *(dict) --* Describes a snapshot. * **OwnerAlias** *(string) --* The Amazon Web Services owner alias, from an Amazon- maintained list ( "amazon"). This is not the user- configured Amazon Web Services account alias set using the IAM console. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the *Amazon EBS User Guide*. * **Tags** *(list) --* Any tags assigned to the snapshot. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **StorageTier** *(string) --* The storage tier in which the snapshot is stored. "standard" indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. "archive" indicates that the snapshot is currently archived and that it must be restored before it can be used. * **RestoreExpiryTime** *(datetime) --* Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. * **SseType** *(string) --* Reserved for future use. * **AvailabilityZone** *(string) --* The Availability Zone or Local Zone of the snapshot. For example, "us-west-1a" (Availability Zone) or "us- west-2-lax-1a" (Local Zone). * **TransferType** *(string) --* Note: Only for snapshot copies. Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis. * "standard" - The snapshot copy was created with a standard snapshot copy operation. * "time-based" - The snapshot copy was created with a time-based snapshot copy operation. * **CompletionDurationMinutes** *(integer) --* Note: Only for snapshot copies created with time-based snapshot copy operations. The completion duration requested for the time-based snapshot copy operation. * **CompletionTime** *(datetime) --* The time stamp when the snapshot was completed. * **FullSnapshotSizeInBytes** *(integer) --* The full size of the snapshot, in bytes. Warning: This is **not** the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created. * **SnapshotId** *(string) --* The ID of the snapshot. Each snapshot receives a unique identifier when it is created. * **VolumeId** *(string) --* The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose. * **State** *(string) --* The snapshot state. * **StateMessage** *(string) --* Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. * **StartTime** *(datetime) --* The time stamp when the snapshot was initiated. * **Progress** *(string) --* The progress of the snapshot, as a percentage. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the EBS snapshot. * **Description** *(string) --* The description for the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiB. * **Encrypted** *(boolean) --* Indicates whether the snapshot is encrypted. * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume. * **DataEncryptionKeyId** *(string) --* The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots. EC2 / Paginator / GetGroupsForCapacityReservation GetGroupsForCapacityReservation ******************************* class EC2.Paginator.GetGroupsForCapacityReservation paginator = client.get_paginator('get_groups_for_capacity_reservation') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_groups_for_capacity_reservation()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CapacityReservationId='string', DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityReservationGroups': [ { 'GroupArn': 'string', 'OwnerId': 'string' }, ] } **Response Structure** * *(dict) --* * **CapacityReservationGroups** *(list) --* Information about the resource groups to which the Capacity Reservation has been added. * *(dict) --* Describes a resource group to which a Capacity Reservation has been added. * **GroupArn** *(string) --* The ARN of the resource group. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the resource group. EC2 / Paginator / DescribeCapacityReservationBillingRequests DescribeCapacityReservationBillingRequests ****************************************** class EC2.Paginator.DescribeCapacityReservationBillingRequests paginator = client.get_paginator('describe_capacity_reservation_billing_requests') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_capacity_reservation_billing_requests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CapacityReservationIds=[ 'string', ], Role='odcr-owner'|'unused-reservation-billing-owner', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CapacityReservationIds** (*list*) -- The ID of the Capacity Reservation. * *(string) --* * **Role** (*string*) -- **[REQUIRED]** Specify one of the following: * "odcr-owner" - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the "requested-by" filter. * "unused-reservation-billing-owner" - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the "unused-reservation-billing-owner" filter. * **Filters** (*list*) -- One or more filters. * "status" - The state of the request ( "pending" | "accepted" | "rejected" | "cancelled" | "revoked" | "expired"). * "requested-by" - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify "requested-by" for **Role**. * "unused-reservation-billing-owner" - The ID of the consumer account to which the request was sent. Not supported if you specify "unused-reservation-billing- owner" for **Role**. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityReservationBillingRequests': [ { 'CapacityReservationId': 'string', 'RequestedBy': 'string', 'UnusedReservationBillingOwnerId': 'string', 'LastUpdateTime': datetime(2015, 1, 1), 'Status': 'pending'|'accepted'|'rejected'|'cancelled'|'revoked'|'expired', 'StatusMessage': 'string', 'CapacityReservationInfo': { 'InstanceType': 'string', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'AvailabilityZoneId': 'string' } }, ] } **Response Structure** * *(dict) --* * **CapacityReservationBillingRequests** *(list) --* Information about the request. * *(dict) --* Information about a request to assign billing of the unused capacity of a Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **RequestedBy** *(string) --* The ID of the Amazon Web Services account that initiated the request. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which the request was sent. * **LastUpdateTime** *(datetime) --* The date and time, in UTC time format, at which the request was initiated. * **Status** *(string) --* The status of the request. For more information, see View billing assignment requests for a shared Amazon EC2 Capacity Reservation. * **StatusMessage** *(string) --* Information about the status. * **CapacityReservationInfo** *(dict) --* Information about the Capacity Reservation. * **InstanceType** *(string) --* The instance type for the Capacity Reservation. * **AvailabilityZone** *(string) --* The Availability Zone for the Capacity Reservation. * **Tenancy** *(string) --* The tenancy of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. EC2 / Paginator / DescribeInstanceTypes DescribeInstanceTypes ********************* class EC2.Paginator.DescribeInstanceTypes paginator = client.get_paginator('describe_instance_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, InstanceTypes=[ 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceTypes** (*list*) -- The instance types. * *(string) --* * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * "auto-recovery-supported" - Indicates whether Amazon CloudWatch action based recovery is supported ( "true" | "false"). * "bare-metal" - Indicates whether it is a bare metal instance type ( "true" | "false"). * "burstable-performance-supported" - Indicates whether the instance type is a burstable performance T instance type ( "true" | "false"). * "current-generation" - Indicates whether this instance type is the latest generation instance type of an instance family ( "true" | "false"). * "dedicated-hosts-supported" - Indicates whether the instance type supports Dedicated Hosts. ( "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" | "unsupported"). * "ebs-info.nvme-support" - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes ( "required" | "supported" | "unsupported"). * "free-tier-eligible" - A Boolean that indicates whether this instance type can be used under the Amazon Web Services Free Tier ( "true" | "false"). * "hibernation-supported" - Indicates whether On-Demand hibernation is supported ( "true" | "false"). * "hypervisor" - The hypervisor ( "nitro" | "xen"). * "instance-storage-info.disk.count" - The number of local disks. * "instance-storage-info.disk.size-in-gb" - The storage size of each instance storage disk, in GB. * "instance-storage-info.disk.type" - The storage technology for the local instance storage disks ( "hdd" | "ssd"). * "instance-storage-info.encryption-support" - Indicates whether data is encrypted at rest ( "required" | "supported" | "unsupported"). * "instance-storage-info.nvme-support" - Indicates whether non-volatile memory express (NVMe) is supported for instance store ( "required" | "supported" | "unsupported"). * "instance-storage-info.total-size-in-gb" - The total amount of storage available from all local instance storage, in GB. * "instance-storage-supported" - Indicates whether the instance type has local instance storage ( "true" | "false"). * "instance-type" - The instance type (for example "c5.2xlarge" or c5*). * "memory-info.size-in-mib" - The memory size. * "network-info.bandwidth-weightings" - For instances that support bandwidth weighting to boost performance ( "default", "vpc-1", "ebs-1"). * "network-info.efa-info.maximum-efa-interfaces" - The maximum number of Elastic Fabric Adapters (EFAs) per instance. * "network-info.efa-supported" - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) ( "true" | "false"). * "network-info.ena-support" - Indicates whether Elastic Network Adapter (ENA) is supported or required ( "required" | "supported" | "unsupported"). * "network-info.flexible-ena-queues-support" - Indicates whether an instance supports flexible ENA queues ( "supported" | "unsupported"). * "network-info.encryption-in-transit-supported" - Indicates whether the instance type automatically encrypts in-transit traffic between instances ( "true" | "false"). * "network-info.ipv4-addresses-per-interface" - The maximum number of private IPv4 addresses per network interface. * "network-info.ipv6-addresses-per-interface" - The maximum number of private IPv6 addresses per network interface. * "network-info.ipv6-supported" - Indicates whether the instance type supports IPv6 ( "true" | "false"). * "network-info.maximum-network-cards" - The maximum number of network cards per instance. * "network-info.maximum-network-interfaces" - The maximum number of network interfaces per instance. * "network-info.network-performance" - The network performance (for example, "25 Gigabit"). * "nitro-enclaves-support" - Indicates whether Nitro Enclaves is supported ( "supported" | "unsupported"). * "nitro-tpm-support" - Indicates whether NitroTPM is supported ( "supported" | "unsupported"). * "nitro-tpm-info.supported-versions" - The supported NitroTPM version ( "2.0"). * "processor-info.supported-architecture" - The CPU architecture ( "arm64" | "i386" | "x86_64"). * "processor-info.sustained-clock-speed-in-ghz" - The CPU clock speed, in GHz. * "processor-info.supported-features" - The supported CPU features ( "amd-sev-snp"). * "reboot-migration-support" - Indicates whether enabling reboot migration is supported ( "supported" | "unsupported"). * "supported-boot-mode" - The boot mode ( "legacy-bios" | "uefi"). * "supported-root-device-type" - The root device type ( "ebs" | "instance-store"). * "supported-usage-class" - The usage class ( "on-demand" | "spot" | "capacity-block"). * "supported-virtualization-type" - The virtualization type ( "hvm" | "paravirtual"). * "vcpu-info.default-cores" - The default number of cores for the instance type. * "vcpu-info.default-threads-per-core" - The default number of threads per core for the instance type. * "vcpu-info.default-vcpus" - The default number of vCPUs for the instance type. * "vcpu-info.valid-cores" - The number of cores that can be configured for the instance type. * "vcpu-info.valid-threads-per-core" - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'CurrentGeneration': True|False, 'FreeTierEligible': True|False, 'SupportedUsageClasses': [ 'spot'|'on-demand'|'capacity-block', ], 'SupportedRootDeviceTypes': [ 'ebs'|'instance-store', ], 'SupportedVirtualizationTypes': [ 'hvm'|'paravirtual', ], 'BareMetal': True|False, 'Hypervisor': 'nitro'|'xen', 'ProcessorInfo': { 'SupportedArchitectures': [ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], 'SustainedClockSpeedInGhz': 123.0, 'SupportedFeatures': [ 'amd-sev-snp', ], 'Manufacturer': 'string' }, 'VCpuInfo': { 'DefaultVCpus': 123, 'DefaultCores': 123, 'DefaultThreadsPerCore': 123, 'ValidCores': [ 123, ], 'ValidThreadsPerCore': [ 123, ] }, 'MemoryInfo': { 'SizeInMiB': 123 }, 'InstanceStorageSupported': True|False, 'InstanceStorageInfo': { 'TotalSizeInGB': 123, 'Disks': [ { 'SizeInGB': 123, 'Count': 123, 'Type': 'hdd'|'ssd' }, ], 'NvmeSupport': 'unsupported'|'supported'|'required', 'EncryptionSupport': 'unsupported'|'required' }, 'EbsInfo': { 'EbsOptimizedSupport': 'unsupported'|'supported'|'default', 'EncryptionSupport': 'unsupported'|'supported', 'EbsOptimizedInfo': { 'BaselineBandwidthInMbps': 123, 'BaselineThroughputInMBps': 123.0, 'BaselineIops': 123, 'MaximumBandwidthInMbps': 123, 'MaximumThroughputInMBps': 123.0, 'MaximumIops': 123 }, 'NvmeSupport': 'unsupported'|'supported'|'required' }, 'NetworkInfo': { 'NetworkPerformance': 'string', 'MaximumNetworkInterfaces': 123, 'MaximumNetworkCards': 123, 'DefaultNetworkCardIndex': 123, 'NetworkCards': [ { 'NetworkCardIndex': 123, 'NetworkPerformance': 'string', 'MaximumNetworkInterfaces': 123, 'BaselineBandwidthInGbps': 123.0, 'PeakBandwidthInGbps': 123.0, 'DefaultEnaQueueCountPerInterface': 123, 'MaximumEnaQueueCount': 123, 'MaximumEnaQueueCountPerInterface': 123 }, ], 'Ipv4AddressesPerInterface': 123, 'Ipv6AddressesPerInterface': 123, 'Ipv6Supported': True|False, 'EnaSupport': 'unsupported'|'supported'|'required', 'EfaSupported': True|False, 'EfaInfo': { 'MaximumEfaInterfaces': 123 }, 'EncryptionInTransitSupported': True|False, 'EnaSrdSupported': True|False, 'BandwidthWeightings': [ 'default'|'vpc-1'|'ebs-1', ], 'FlexibleEnaQueuesSupport': 'unsupported'|'supported' }, 'GpuInfo': { 'Gpus': [ { 'Name': 'string', 'Manufacturer': 'string', 'Count': 123, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalGpuMemoryInMiB': 123 }, 'FpgaInfo': { 'Fpgas': [ { 'Name': 'string', 'Manufacturer': 'string', 'Count': 123, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalFpgaMemoryInMiB': 123 }, 'PlacementGroupInfo': { 'SupportedStrategies': [ 'cluster'|'partition'|'spread', ] }, 'InferenceAcceleratorInfo': { 'Accelerators': [ { 'Count': 123, 'Name': 'string', 'Manufacturer': 'string', 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalInferenceMemoryInMiB': 123 }, 'HibernationSupported': True|False, 'BurstablePerformanceSupported': True|False, 'DedicatedHostsSupported': True|False, 'AutoRecoverySupported': True|False, 'SupportedBootModes': [ 'legacy-bios'|'uefi', ], 'NitroEnclavesSupport': 'unsupported'|'supported', 'NitroTpmSupport': 'unsupported'|'supported', 'NitroTpmInfo': { 'SupportedVersions': [ 'string', ] }, 'MediaAcceleratorInfo': { 'Accelerators': [ { 'Count': 123, 'Name': 'string', 'Manufacturer': 'string', 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalMediaMemoryInMiB': 123 }, 'NeuronInfo': { 'NeuronDevices': [ { 'Count': 123, 'Name': 'string', 'CoreInfo': { 'Count': 123, 'Version': 123 }, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalNeuronDeviceMemoryInMiB': 123 }, 'PhcSupport': 'unsupported'|'supported', 'RebootMigrationSupport': 'unsupported'|'supported' }, ], } **Response Structure** * *(dict) --* * **InstanceTypes** *(list) --* The instance type. * *(dict) --* Describes the instance type. * **InstanceType** *(string) --* The instance type. For more information, see Instance types in the *Amazon EC2 User Guide*. * **CurrentGeneration** *(boolean) --* Indicates whether the instance type is current generation. * **FreeTierEligible** *(boolean) --* Indicates whether the instance type is eligible for the free tier. * **SupportedUsageClasses** *(list) --* Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks. * *(string) --* * **SupportedRootDeviceTypes** *(list) --* The supported root device types. * *(string) --* * **SupportedVirtualizationTypes** *(list) --* The supported virtualization types. * *(string) --* * **BareMetal** *(boolean) --* Indicates whether the instance is a bare metal instance type. * **Hypervisor** *(string) --* The hypervisor for the instance type. * **ProcessorInfo** *(dict) --* Describes the processor. * **SupportedArchitectures** *(list) --* The architectures supported by the instance type. * *(string) --* * **SustainedClockSpeedInGhz** *(float) --* The speed of the processor, in GHz. * **SupportedFeatures** *(list) --* Indicates whether the instance type supports AMD SEV-SNP. If the request returns "amd-sev-snp", AMD SEV-SNP is supported. Otherwise, it is not supported. For more information, see AMD SEV-SNP. * *(string) --* * **Manufacturer** *(string) --* The manufacturer of the processor. * **VCpuInfo** *(dict) --* Describes the vCPU configurations for the instance type. * **DefaultVCpus** *(integer) --* The default number of vCPUs for the instance type. * **DefaultCores** *(integer) --* The default number of cores for the instance type. * **DefaultThreadsPerCore** *(integer) --* The default number of threads per core for the instance type. * **ValidCores** *(list) --* The valid number of cores that can be configured for the instance type. * *(integer) --* * **ValidThreadsPerCore** *(list) --* The valid number of threads per core that can be configured for the instance type. * *(integer) --* * **MemoryInfo** *(dict) --* Describes the memory for the instance type. * **SizeInMiB** *(integer) --* The size of the memory, in MiB. * **InstanceStorageSupported** *(boolean) --* Indicates whether instance storage is supported. * **InstanceStorageInfo** *(dict) --* Describes the instance storage for the instance type. * **TotalSizeInGB** *(integer) --* The total size of the disks, in GB. * **Disks** *(list) --* Describes the disks that are available for the instance type. * *(dict) --* Describes a disk. * **SizeInGB** *(integer) --* The size of the disk in GB. * **Count** *(integer) --* The number of disks with this configuration. * **Type** *(string) --* The type of disk. * **NvmeSupport** *(string) --* Indicates whether non-volatile memory express (NVMe) is supported. * **EncryptionSupport** *(string) --* Indicates whether data is encrypted at rest. * **EbsInfo** *(dict) --* Describes the Amazon EBS settings for the instance type. * **EbsOptimizedSupport** *(string) --* Indicates whether the instance type is Amazon EBS- optimized. For more information, see Amazon EBS- optimized instances in *Amazon EC2 User Guide*. * **EncryptionSupport** *(string) --* Indicates whether Amazon EBS encryption is supported. * **EbsOptimizedInfo** *(dict) --* Describes the optimized EBS performance for the instance type. * **BaselineBandwidthInMbps** *(integer) --* The baseline bandwidth performance for an EBS- optimized instance type, in Mbps. * **BaselineThroughputInMBps** *(float) --* The baseline throughput performance for an EBS- optimized instance type, in MB/s. * **BaselineIops** *(integer) --* The baseline input/output storage operations per seconds for an EBS-optimized instance type. * **MaximumBandwidthInMbps** *(integer) --* The maximum bandwidth performance for an EBS- optimized instance type, in Mbps. * **MaximumThroughputInMBps** *(float) --* The maximum throughput performance for an EBS- optimized instance type, in MB/s. * **MaximumIops** *(integer) --* The maximum input/output storage operations per second for an EBS-optimized instance type. * **NvmeSupport** *(string) --* Indicates whether non-volatile memory express (NVMe) is supported. * **NetworkInfo** *(dict) --* Describes the network settings for the instance type. * **NetworkPerformance** *(string) --* The network performance. * **MaximumNetworkInterfaces** *(integer) --* The maximum number of network interfaces for the instance type. * **MaximumNetworkCards** *(integer) --* The maximum number of physical network cards that can be allocated to the instance. * **DefaultNetworkCardIndex** *(integer) --* The index of the default network card, starting at 0. * **NetworkCards** *(list) --* Describes the network cards for the instance type. * *(dict) --* Describes the network card support of the instance type. * **NetworkCardIndex** *(integer) --* The index of the network card. * **NetworkPerformance** *(string) --* The network performance of the network card. * **MaximumNetworkInterfaces** *(integer) --* The maximum number of network interfaces for the network card. * **BaselineBandwidthInGbps** *(float) --* The baseline network performance of the network card, in Gbps. * **PeakBandwidthInGbps** *(float) --* The peak (burst) network performance of the network card, in Gbps. * **DefaultEnaQueueCountPerInterface** *(integer) --* The default number of the ENA queues for each interface. * **MaximumEnaQueueCount** *(integer) --* The maximum number of the ENA queues. * **MaximumEnaQueueCountPerInterface** *(integer) --* The maximum number of the ENA queues for each interface. * **Ipv4AddressesPerInterface** *(integer) --* The maximum number of IPv4 addresses per network interface. * **Ipv6AddressesPerInterface** *(integer) --* The maximum number of IPv6 addresses per network interface. * **Ipv6Supported** *(boolean) --* Indicates whether IPv6 is supported. * **EnaSupport** *(string) --* Indicates whether Elastic Network Adapter (ENA) is supported. * **EfaSupported** *(boolean) --* Indicates whether Elastic Fabric Adapter (EFA) is supported. * **EfaInfo** *(dict) --* Describes the Elastic Fabric Adapters for the instance type. * **MaximumEfaInterfaces** *(integer) --* The maximum number of Elastic Fabric Adapters for the instance type. * **EncryptionInTransitSupported** *(boolean) --* Indicates whether the instance type automatically encrypts in-transit traffic between instances. * **EnaSrdSupported** *(boolean) --* Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. * **BandwidthWeightings** *(list) --* A list of valid settings for configurable bandwidth weighting for the instance type, if supported. * *(string) --* * **FlexibleEnaQueuesSupport** *(string) --* Indicates whether changing the number of ENA queues is supported. * **GpuInfo** *(dict) --* Describes the GPU accelerator settings for the instance type. * **Gpus** *(list) --* Describes the GPU accelerators for the instance type. * *(dict) --* Describes the GPU accelerators for the instance type. * **Name** *(string) --* The name of the GPU accelerator. * **Manufacturer** *(string) --* The manufacturer of the GPU accelerator. * **Count** *(integer) --* The number of GPUs for the instance type. * **MemoryInfo** *(dict) --* Describes the memory available to the GPU accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the GPU accelerator, in MiB. * **TotalGpuMemoryInMiB** *(integer) --* The total size of the memory for the GPU accelerators for the instance type, in MiB. * **FpgaInfo** *(dict) --* Describes the FPGA accelerator settings for the instance type. * **Fpgas** *(list) --* Describes the FPGAs for the instance type. * *(dict) --* Describes the FPGA accelerator for the instance type. * **Name** *(string) --* The name of the FPGA accelerator. * **Manufacturer** *(string) --* The manufacturer of the FPGA accelerator. * **Count** *(integer) --* The count of FPGA accelerators for the instance type. * **MemoryInfo** *(dict) --* Describes the memory for the FPGA accelerator for the instance type. * **SizeInMiB** *(integer) --* The size of the memory available to the FPGA accelerator, in MiB. * **TotalFpgaMemoryInMiB** *(integer) --* The total memory of all FPGA accelerators for the instance type. * **PlacementGroupInfo** *(dict) --* Describes the placement group settings for the instance type. * **SupportedStrategies** *(list) --* The supported placement group types. * *(string) --* * **InferenceAcceleratorInfo** *(dict) --* Describes the Inference accelerator settings for the instance type. * **Accelerators** *(list) --* Describes the Inference accelerators for the instance type. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes the Inference accelerators for the instance type. * **Count** *(integer) --* The number of Inference accelerators for the instance type. * **Name** *(string) --* The name of the Inference accelerator. * **Manufacturer** *(string) --* The manufacturer of the Inference accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to the inference accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the inference accelerator, in MiB. * **TotalInferenceMemoryInMiB** *(integer) --* The total size of the memory for the inference accelerators for the instance type, in MiB. * **HibernationSupported** *(boolean) --* Indicates whether On-Demand hibernation is supported. * **BurstablePerformanceSupported** *(boolean) --* Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances. * **DedicatedHostsSupported** *(boolean) --* Indicates whether Dedicated Hosts are supported on the instance type. * **AutoRecoverySupported** *(boolean) --* Indicates whether Amazon CloudWatch action based recovery is supported. * **SupportedBootModes** *(list) --* The supported boot modes. For more information, see Boot modes in the *Amazon EC2 User Guide*. * *(string) --* * **NitroEnclavesSupport** *(string) --* Indicates whether Nitro Enclaves is supported. * **NitroTpmSupport** *(string) --* Indicates whether NitroTPM is supported. * **NitroTpmInfo** *(dict) --* Describes the supported NitroTPM versions for the instance type. * **SupportedVersions** *(list) --* Indicates the supported NitroTPM versions. * *(string) --* * **MediaAcceleratorInfo** *(dict) --* Describes the media accelerator settings for the instance type. * **Accelerators** *(list) --* Describes the media accelerators for the instance type. * *(dict) --* Describes the media accelerators for the instance type. * **Count** *(integer) --* The number of media accelerators for the instance type. * **Name** *(string) --* The name of the media accelerator. * **Manufacturer** *(string) --* The manufacturer of the media accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to the media accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to each media accelerator, in MiB. * **TotalMediaMemoryInMiB** *(integer) --* The total size of the memory for the media accelerators for the instance type, in MiB. * **NeuronInfo** *(dict) --* Describes the Neuron accelerator settings for the instance type. * **NeuronDevices** *(list) --* Describes the neuron accelerators for the instance type. * *(dict) --* Describes the neuron accelerators for the instance type. * **Count** *(integer) --* The number of neuron accelerators for the instance type. * **Name** *(string) --* The name of the neuron accelerator. * **CoreInfo** *(dict) --* Describes the cores available to each neuron accelerator. * **Count** *(integer) --* The number of cores available to the neuron accelerator. * **Version** *(integer) --* The version of the neuron accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to each neuron accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the neuron accelerator, in MiB. * **TotalNeuronDeviceMemoryInMiB** *(integer) --* The total size of the memory for the neuron accelerators for the instance type, in MiB. * **PhcSupport** *(string) --* Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported. * **RebootMigrationSupport** *(string) --* Indicates whether reboot migration during a user- initiated reboot is supported for instances that have a scheduled "system-reboot" event. For more information, see Enable or disable reboot migration in the *Amazon EC2 User Guide*. EC2 / Paginator / DescribeIpamPools DescribeIpamPools ***************** class EC2.Paginator.DescribeIpamPools paginator = client.get_paginator('describe_ipam_pools') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipam_pools()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IpamPoolIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IpamPoolIds** (*list*) -- The IDs of the IPAM pools you would like information on. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamPools': [ { 'OwnerId': 'string', 'IpamPoolId': 'string', 'SourceIpamPoolId': 'string', 'IpamPoolArn': 'string', 'IpamScopeArn': 'string', 'IpamScopeType': 'public'|'private', 'IpamArn': 'string', 'IpamRegion': 'string', 'Locale': 'string', 'PoolDepth': 123, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'StateMessage': 'string', 'Description': 'string', 'AutoImport': True|False, 'PubliclyAdvertisable': True|False, 'AddressFamily': 'ipv4'|'ipv6', 'AllocationMinNetmaskLength': 123, 'AllocationMaxNetmaskLength': 123, 'AllocationDefaultNetmaskLength': 123, 'AllocationResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AwsService': 'ec2', 'PublicIpSource': 'amazon'|'byoip', 'SourceResource': { 'ResourceId': 'string', 'ResourceType': 'vpc', 'ResourceRegion': 'string', 'ResourceOwner': 'string' } }, ] } **Response Structure** * *(dict) --* * **IpamPools** *(list) --* Information about the IPAM pools. * *(dict) --* In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM pool. * **IpamPoolId** *(string) --* The ID of the IPAM pool. * **SourceIpamPoolId** *(string) --* The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool. * **IpamPoolArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM pool. * **IpamScopeArn** *(string) --* The ARN of the scope of the IPAM pool. * **IpamScopeType** *(string) --* In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. * **IpamArn** *(string) --* The ARN of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM pool. * **Locale** *(string) --* The locale of the IPAM pool. The locale for the pool should be one of the following: * An Amazon Web Services Region where you want this IPAM pool to be available for allocations. * The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error. * **PoolDepth** *(integer) --* The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **State** *(string) --* The state of the IPAM pool. * **StateMessage** *(string) --* The state message. * **Description** *(string) --* The description of the IPAM pool. * **AutoImport** *(boolean) --* If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work. * **PubliclyAdvertisable** *(boolean) --* Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to "ipv4". * **AddressFamily** *(string) --* The address family of the pool. * **AllocationMinNetmaskLength** *(integer) --* The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationMaxNetmaskLength** *(integer) --* The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationDefaultNetmaskLength** *(integer) --* The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. * **AllocationResourceTags** *(list) --* Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AwsService** *(string) --* Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. * **PublicIpSource** *(string) --* The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is "BYOIP". For more information, see Create IPv6 pools in the *Amazon VPC IPAM User Guide*. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. * **SourceResource** *(dict) --* The resource used to provision CIDRs to a resource planning pool. * **ResourceId** *(string) --* The source resource ID. * **ResourceType** *(string) --* The source resource type. * **ResourceRegion** *(string) --* The source resource Region. * **ResourceOwner** *(string) --* The source resource owner. EC2 / Paginator / DescribeIpamScopes DescribeIpamScopes ****************** class EC2.Paginator.DescribeIpamScopes paginator = client.get_paginator('describe_ipam_scopes') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipam_scopes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IpamScopeIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IpamScopeIds** (*list*) -- The IDs of the scopes you want information on. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamScopes': [ { 'OwnerId': 'string', 'IpamScopeId': 'string', 'IpamScopeArn': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'IpamScopeType': 'public'|'private', 'IsDefault': True|False, 'Description': 'string', 'PoolCount': 123, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **IpamScopes** *(list) --* The scopes you want information on. * *(dict) --* In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. For more information, see How IPAM works in the *Amazon VPC IPAM User Guide*. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the scope. * **IpamScopeId** *(string) --* The ID of the scope. * **IpamScopeArn** *(string) --* The Amazon Resource Name (ARN) of the scope. * **IpamArn** *(string) --* The ARN of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM scope. * **IpamScopeType** *(string) --* The type of the scope. * **IsDefault** *(boolean) --* Defines if the scope is the default scope or not. * **Description** *(string) --* The description of the scope. * **PoolCount** *(integer) --* The number of pools in the scope. * **State** *(string) --* The state of the IPAM scope. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeDhcpOptions DescribeDhcpOptions ******************* class EC2.Paginator.DescribeDhcpOptions paginator = client.get_paginator('describe_dhcp_options') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_dhcp_options()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DhcpOptionsIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DhcpOptionsIds** (*list*) -- The IDs of DHCP option sets. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The 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 Amazon Web Services account that owns the DHCP options set. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DhcpOptions': [ { 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DhcpOptionsId': 'string', 'DhcpConfigurations': [ { 'Key': 'string', 'Values': [ { 'Value': 'string' }, ] }, ] }, ] } **Response Structure** * *(dict) --* * **DhcpOptions** *(list) --* Information about the DHCP options sets. * *(dict) --* The set of DHCP options. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the DHCP options set. * **Tags** *(list) --* Any tags assigned to the DHCP options set. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DhcpOptionsId** *(string) --* The ID of the set of DHCP options. * **DhcpConfigurations** *(list) --* The DHCP options in the set. * *(dict) --* Describes a DHCP configuration option. * **Key** *(string) --* The name of a DHCP option. * **Values** *(list) --* The values for the DHCP option. * *(dict) --* Describes a value for a resource attribute that is a String. * **Value** *(string) --* The attribute value. The value is case- sensitive. EC2 / Paginator / DescribeFleets DescribeFleets ************** class EC2.Paginator.DescribeFleets paginator = client.get_paginator('describe_fleets') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_fleets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, FleetIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FleetIds** (*list*) -- The IDs of the EC2 Fleets. Note: If a fleet is of type "instant", you must specify the fleet ID, otherwise it does not appear in the response. * *(string) --* * **Filters** (*list*) -- 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Fleets': [ { 'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled', 'CreateTime': datetime(2015, 1, 1), 'FleetId': 'string', 'FleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying', 'ClientToken': 'string', 'ExcessCapacityTerminationPolicy': 'no-termination'|'termination', 'FulfilledCapacity': 123.0, 'FulfilledOnDemandCapacity': 123.0, 'LaunchTemplateConfigs': [ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] }, ] }, ], 'TargetCapacitySpecification': { 'TotalTargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'SpotTargetCapacity': 123, 'DefaultTargetCapacityType': 'spot'|'on-demand'|'capacity-block', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units' }, 'TerminateInstancesWithExpiration': True|False, 'Type': 'request'|'maintain'|'instant', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'ReplaceUnhealthyInstances': True|False, 'SpotOptions': { 'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized'|'price-capacity-optimized', 'MaintenanceStrategies': { 'CapacityRebalance': { 'ReplacementStrategy': 'launch'|'launch-before-terminate', 'TerminationDelay': 123 } }, 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate', 'InstancePoolsToUseCount': 123, 'SingleInstanceType': True|False, 'SingleAvailabilityZone': True|False, 'MinTargetCapacity': 123, 'MaxTotalPrice': 'string' }, 'OnDemandOptions': { 'AllocationStrategy': 'lowest-price'|'prioritized', 'CapacityReservationOptions': { 'UsageStrategy': 'use-capacity-reservations-first' }, 'SingleInstanceType': True|False, 'SingleAvailabilityZone': True|False, 'MinTargetCapacity': 123, 'MaxTotalPrice': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Errors': [ { 'LaunchTemplateAndOverrides': { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] } }, 'Lifecycle': 'spot'|'on-demand', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'Instances': [ { 'LaunchTemplateAndOverrides': { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] } }, 'Lifecycle': 'spot'|'on-demand', 'InstanceIds': [ 'string', ], 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'Platform': 'Windows' }, ], 'Context': 'string' }, ] } **Response Structure** * *(dict) --* * **Fleets** *(list) --* Information about the EC2 Fleets. * *(dict) --* Describes an EC2 Fleet. * **ActivityStatus** *(string) --* The progress of the EC2 Fleet. If there is an error, the status is "error". After all requests are placed, the status is "pending_fulfillment". If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is "fulfilled". If the size of the EC2 Fleet is decreased, the status is "pending_termination" while instances are terminating. * **CreateTime** *(datetime) --* The creation date and time of the EC2 Fleet. * **FleetId** *(string) --* The ID of the EC2 Fleet. * **FleetState** *(string) --* The state of the EC2 Fleet. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. Constraints: Maximum 64 ASCII characters * **ExcessCapacityTerminationPolicy** *(string) --* Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type "maintain". * **FulfilledCapacity** *(float) --* The number of units fulfilled by this request compared to the set target capacity. * **FulfilledOnDemandCapacity** *(float) --* The number of units fulfilled by this request compared to the set target On-Demand capacity. * **LaunchTemplateConfigs** *(list) --* The launch template and overrides. * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. "mac1.metal" is not supported as a launch template override. Note: If you specify "InstanceType", you can't specify "InstanceRequirements". * **MaxPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowest-price" and "price-capacity- optimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If the On-Demand "AllocationStrategy" is set to "prioritized", EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacity-optimized-prioritized", EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides. * **Placement** *(dict) --* The location where the instance launched, if applicable. * **GroupName** *(string) --* The name of the placement group that the instance is in. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web- services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnD emandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPric e** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web- services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDeman dPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnD emandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetI nstanceTypesFromInstanceRequiremen ts and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **ImageId** *(string) --* The ID of the AMI in the format "ami- 17characters00000". Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter: * "resolve:ssm:public-parameter" To reference a parameter stored in the same account: * "resolve:ssm:parameter-name" * "resolve:ssm:parameter-name:version-number" * "resolve:ssm:parameter-name:label" To reference a parameter shared from another Amazon Web Services account: * "resolve:ssm:parameter-ARN" * "resolve:ssm:parameter-ARN:version-number" * "resolve:ssm:parameter-ARN:label" For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. Note: This parameter is only available for fleets of type "instant". For fleets of type "maintain" and "request", you must specify the AMI ID in the launch template. * **BlockDeviceMappings** *(list) --* The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch. Supported only for fleets of type "instant". For more information, see Block device mappings for volumes on Amazon EC2 instances in the *Amazon EC2 User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **Encrypted** *(boolean) --* Indicates whether the volume is encrypted. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Iops** *(integer) --* 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. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiBs. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **NoDevice** *(string) --* Suppresses the specified device included in the block device mapping. * **TargetCapacitySpecification** *(dict) --* The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **TotalTargetCapacity** *(integer) --* The number of units to request, filled the default target capacity type. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units. * **SpotTargetCapacity** *(integer) --* The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units. * **DefaultTargetCapacityType** *(string) --* The default target capacity type. * **TargetCapacityUnitType** *(string) --* The unit for the target capacity. * **TerminateInstancesWithExpiration** *(boolean) --* Indicates whether running instances should be terminated when the EC2 Fleet expires. * **Type** *(string) --* The type of request. Indicates whether the EC2 Fleet only "requests" the target capacity, or also attempts to "maintain" it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: "maintain". * **ValidFrom** *(datetime) --* The start date and time of the request, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecurityGroups': [ { 'GroupId': 'string', 'IpPermissionsEgress': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'SecurityGroupArn': 'string', 'OwnerId': 'string', 'GroupName': 'string', 'Description': 'string', 'IpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ] }, ] } **Response Structure** * *(dict) --* * **SecurityGroups** *(list) --* Information about the security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **IpPermissionsEgress** *(list) --* The outbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **Tags** *(list) --* Any tags assigned to the security group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC for the security group. * **SecurityGroupArn** *(string) --* The ARN of the security group. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the security group. * **GroupName** *(string) --* The name of the security group. * **Description** *(string) --* A description of the security group. * **IpPermissions** *(list) --* The inbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. EC2 / Paginator / GetTransitGatewayMulticastDomainAssociations GetTransitGatewayMulticastDomainAssociations ******************************************** class EC2.Paginator.GetTransitGatewayMulticastDomainAssociations paginator = client.get_paginator('get_transit_gateway_multicast_domain_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " EC2.Client.get_transit_gateway_multicast_domain_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayMulticastDomainId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- **[REQUIRED]** The ID of the transit gateway multicast domain. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MulticastDomainAssociations': [ { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceOwnerId': 'string', 'Subnet': { 'SubnetId': 'string', 'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed' } }, ], } **Response Structure** * *(dict) --* * **MulticastDomainAssociations** *(list) --* Information about the multicast domain associations. * *(dict) --* Describes the resources associated with the transit gateway multicast domain. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource, for example a VPC attachment. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource. * **Subnet** *(dict) --* The subnet associated with the transit gateway multicast domain. * **SubnetId** *(string) --* The ID of the subnet. * **State** *(string) --* The state of the subnet association. EC2 / Paginator / DescribeVerifiedAccessTrustProviders DescribeVerifiedAccessTrustProviders ************************************ class EC2.Paginator.DescribeVerifiedAccessTrustProviders paginator = client.get_paginator('describe_verified_access_trust_providers') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_verified_access_trust_providers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VerifiedAccessTrustProviderIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VerifiedAccessTrustProviderIds** (*list*) -- The IDs of the Verified Access trust providers. * *(string) --* * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VerifiedAccessTrustProviders': [ { 'VerifiedAccessTrustProviderId': 'string', 'Description': 'string', 'TrustProviderType': 'user'|'device', 'UserTrustProviderType': 'iam-identity-center'|'oidc', 'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud', 'OidcOptions': { 'Issuer': 'string', 'AuthorizationEndpoint': 'string', 'TokenEndpoint': 'string', 'UserInfoEndpoint': 'string', 'ClientId': 'string', 'ClientSecret': 'string', 'Scope': 'string' }, 'DeviceOptions': { 'TenantId': 'string', 'PublicSigningKeyUrl': 'string' }, 'PolicyReferenceName': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'NativeApplicationOidcOptions': { 'PublicSigningKeyEndpoint': 'string', 'Issuer': 'string', 'AuthorizationEndpoint': 'string', 'TokenEndpoint': 'string', 'UserInfoEndpoint': 'string', 'ClientId': 'string', 'Scope': 'string' } }, ], } **Response Structure** * *(dict) --* * **VerifiedAccessTrustProviders** *(list) --* Details about the Verified Access trust providers. * *(dict) --* Describes a Verified Access trust provider. * **VerifiedAccessTrustProviderId** *(string) --* The ID of the Amazon Web Services Verified Access trust provider. * **Description** *(string) --* A description for the Amazon Web Services Verified Access trust provider. * **TrustProviderType** *(string) --* The type of Verified Access trust provider. * **UserTrustProviderType** *(string) --* The type of user-based trust provider. * **DeviceTrustProviderType** *(string) --* The type of device-based trust provider. * **OidcOptions** *(dict) --* The options for an OpenID Connect-compatible user- identity trust provider. * **Issuer** *(string) --* The OIDC issuer. * **AuthorizationEndpoint** *(string) --* The OIDC authorization endpoint. * **TokenEndpoint** *(string) --* The OIDC token endpoint. * **UserInfoEndpoint** *(string) --* The OIDC user info endpoint. * **ClientId** *(string) --* The client identifier. * **ClientSecret** *(string) --* The client secret. * **Scope** *(string) --* The OpenID Connect (OIDC) scope specified. * **DeviceOptions** *(dict) --* The options for device-identity trust provider. * **TenantId** *(string) --* The ID of the tenant application with the device- identity provider. * **PublicSigningKeyUrl** *(string) --* The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens. * **PolicyReferenceName** *(string) --* The identifier to be used when working with policy rules. * **CreationTime** *(string) --* The creation time. * **LastUpdatedTime** *(string) --* The last updated time. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SseSpecification** *(dict) --* The options in use for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. * **NativeApplicationOidcOptions** *(dict) --* The OpenID Connect (OIDC) options. * **PublicSigningKeyEndpoint** *(string) --* The public signing key endpoint. * **Issuer** *(string) --* The OIDC issuer identifier of the IdP. * **AuthorizationEndpoint** *(string) --* The authorization endpoint of the IdP. * **TokenEndpoint** *(string) --* The token endpoint of the IdP. * **UserInfoEndpoint** *(string) --* The user info endpoint of the IdP. * **ClientId** *(string) --* The OAuth 2.0 client identifier. * **Scope** *(string) --* The set of user claims to be requested from the IdP. EC2 / Paginator / DescribeScheduledInstances DescribeScheduledInstances ************************** class EC2.Paginator.DescribeScheduledInstances paginator = client.get_paginator('describe_scheduled_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_scheduled_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ScheduledInstanceIds=[ 'string', ], SlotStartTimeRange={ 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "availability-zone" - The Availability Zone (for example, "us-west-2a"). * "instance-type" - The instance type (for example, "c4.large"). * "platform" - The platform ( "Linux/UNIX" or "Windows"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ScheduledInstanceIds** (*list*) -- The Scheduled Instance IDs. * *(string) --* * **SlotStartTimeRange** (*dict*) -- The time period for the first schedule to start. * **EarliestTime** *(datetime) --* The earliest date and time, in UTC, for the Scheduled Instance to start. * **LatestTime** *(datetime) --* The latest date and time, in UTC, for the Scheduled Instance to start. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ScheduledInstanceSet': [ { 'AvailabilityZone': 'string', 'CreateDate': datetime(2015, 1, 1), 'HourlyPrice': 'string', 'InstanceCount': 123, 'InstanceType': 'string', 'NetworkPlatform': 'string', 'NextSlotStartTime': datetime(2015, 1, 1), 'Platform': 'string', 'PreviousSlotEndTime': datetime(2015, 1, 1), 'Recurrence': { 'Frequency': 'string', 'Interval': 123, 'OccurrenceDaySet': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' }, 'ScheduledInstanceId': 'string', 'SlotDurationInHours': 123, 'TermEndDate': datetime(2015, 1, 1), 'TermStartDate': datetime(2015, 1, 1), 'TotalScheduledInstanceHours': 123 }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeScheduledInstances. * **ScheduledInstanceSet** *(list) --* Information about the Scheduled Instances. * *(dict) --* Describes a Scheduled Instance. * **AvailabilityZone** *(string) --* The Availability Zone. * **CreateDate** *(datetime) --* The date when the Scheduled Instance was purchased. * **HourlyPrice** *(string) --* The hourly price for a single instance. * **InstanceCount** *(integer) --* The number of instances. * **InstanceType** *(string) --* The instance type. * **NetworkPlatform** *(string) --* The network platform. * **NextSlotStartTime** *(datetime) --* The time for the next schedule to start. * **Platform** *(string) --* The platform ( "Linux/UNIX" or "Windows"). * **PreviousSlotEndTime** *(datetime) --* The time that the previous schedule ended or will end. * **Recurrence** *(dict) --* The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDaySet** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. * **OccurrenceUnit** *(string) --* The unit for "occurrenceDaySet" ( "DayOfWeek" or "DayOfMonth"). * **ScheduledInstanceId** *(string) --* The Scheduled Instance ID. * **SlotDurationInHours** *(integer) --* The number of hours in the schedule. * **TermEndDate** *(datetime) --* The end date for the Scheduled Instance. * **TermStartDate** *(datetime) --* The start date for the Scheduled Instance. * **TotalScheduledInstanceHours** *(integer) --* The total number of hours for a single instance for the entire term. EC2 / Paginator / DescribeImportSnapshotTasks DescribeImportSnapshotTasks *************************** class EC2.Paginator.DescribeImportSnapshotTasks paginator = client.get_paginator('describe_import_snapshot_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_import_snapshot_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ImportTaskIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ImportTaskIds** (*list*) -- A list of import snapshot task IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ImportSnapshotTasks': [ { 'Description': 'string', 'ImportTaskId': 'string', 'SnapshotTaskDetail': { 'Description': 'string', 'DiskImageSize': 123.0, 'Encrypted': True|False, 'Format': 'string', 'KmsKeyId': 'string', 'Progress': 'string', 'SnapshotId': 'string', 'Status': 'string', 'StatusMessage': 'string', 'Url': 'string', 'UserBucket': { 'S3Bucket': 'string', 'S3Key': 'string' } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **ImportSnapshotTasks** *(list) --* A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. * *(dict) --* Describes an import snapshot task. * **Description** *(string) --* A description of the import snapshot task. * **ImportTaskId** *(string) --* The ID of the import snapshot task. * **SnapshotTaskDetail** *(dict) --* Describes an import snapshot task. * **Description** *(string) --* The description of the disk image being imported. * **DiskImageSize** *(float) --* The size of the disk in the snapshot, in GiB. * **Encrypted** *(boolean) --* Indicates whether the snapshot is encrypted. * **Format** *(string) --* The format of the disk image from which the snapshot is created. * **KmsKeyId** *(string) --* The identifier for the KMS key that was used to create the encrypted snapshot. * **Progress** *(string) --* The percentage of completion for the import snapshot task. * **SnapshotId** *(string) --* The snapshot ID of the disk being imported. * **Status** *(string) --* A brief status for the import snapshot task. * **StatusMessage** *(string) --* A detailed status message for the import snapshot task. * **Url** *(string) --* The URL of the disk image from which the snapshot is created. * **UserBucket** *(dict) --* The Amazon S3 bucket for the disk image. * **S3Bucket** *(string) --* The Amazon S3 bucket from which the disk image was created. * **S3Key** *(string) --* The file name of the disk image. * **Tags** *(list) --* The tags for the import snapshot task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeImages DescribeImages ************** class EC2.Paginator.DescribeImages paginator = client.get_paginator('describe_images') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_images()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ExecutableUsers=[ 'string', ], ImageIds=[ 'string', ], Owners=[ 'string', ], IncludeDeprecated=True|False, IncludeDisabled=True|False, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ExecutableUsers** (*list*) -- Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, "self" (the sender of the request), or "all" (public AMIs). * If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned. * If you specify "self" or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned. * If you specify "all", all public AMIs are returned. * *(string) --* * **ImageIds** (*list*) -- The image IDs. Default: Describes all images available to you. * *(string) --* * **Owners** (*list*) -- Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", "amazon", "aws-backup-vault", and "aws- marketplace". If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. * *(string) --* * **IncludeDeprecated** (*boolean*) -- Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. Note: If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. * **IncludeDisabled** (*boolean*) -- Specifies whether to include disabled AMIs. Default: No disabled AMIs are included in the response. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "architecture" - The image architecture ( "i386" | "x86_64" | "arm64" | "x86_64_mac" | "arm64_mac"). * "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 Amazon EBS volume. * "block-device-mapping.volume-size" - The volume size of the Amazon EBS volume, in GiB. * "block-device-mapping.volume-type" - The volume type of the Amazon EBS volume ( "io1" | "io2" | "gp2" | "gp3" | "sc1 ``| ``st1" | "standard"). * "block-device-mapping.encrypted" - A Boolean that indicates whether the Amazon EBS volume is encrypted. * "creation-date" - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2021-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2021-09-29T*", which matches an entire day. * "description" - The description of the image (provided during image creation). * "ena-support" - A Boolean that indicates whether enhanced networking with ENA is enabled. * "free-tier-eligible" - A Boolean that indicates whether this image can be used under the Amazon Web Services Free Tier ( "true" | "false"). * "hypervisor" - The hypervisor type ( "ovm" | "xen"). * "image-allowed" - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. * "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-backup- vault" | "aws-marketplace"). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the **Owner** request parameter instead of this filter. * "platform" - The platform. The only supported value is "windows". * "product-code" - The product code. * "product-code.type" - The type of the product code ( "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"). * "source-image-id" - The ID of the source AMI from which the AMI was created. * "source-image-region" - The Region of the source AMI. * "source-instance-id" - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage. * "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:" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Images': [ { 'PlatformDetails': 'string', 'UsageOperation': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'Description': 'string', 'EnaSupport': True|False, 'Hypervisor': 'ovm'|'xen', 'ImageOwnerAlias': 'string', 'Name': 'string', 'RootDeviceName': 'string', 'RootDeviceType': 'ebs'|'instance-store', 'SriovNetSupport': 'string', 'StateReason': { 'Code': 'string', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VirtualizationType': 'hvm'|'paravirtual', 'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred', 'TpmSupport': 'v2.0', 'DeprecationTime': 'string', 'ImdsSupport': 'v2.0', 'SourceInstanceId': 'string', 'DeregistrationProtection': 'string', 'LastLaunchedTime': 'string', 'ImageAllowed': True|False, 'SourceImageId': 'string', 'SourceImageRegion': 'string', 'FreeTierEligible': True|False, 'ImageId': 'string', 'ImageLocation': 'string', 'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error'|'disabled', 'OwnerId': 'string', 'CreationDate': 'string', 'Public': True|False, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', 'ImageType': 'machine'|'kernel'|'ramdisk', 'KernelId': 'string', 'RamdiskId': 'string', 'Platform': 'Windows' }, ] } **Response Structure** * *(dict) --* * **Images** *(list) --* Information about the images. * *(dict) --* Describes an image. * **PlatformDetails** *(string) --* The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the *Amazon EC2 User Guide*. * **UsageOperation** *(string) --* The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. "usageOperation" corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the **Instances** or **AMIs** pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI. * **BlockDeviceMappings** *(list) --* Any block device mapping entries. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **Description** *(string) --* The description of the AMI that was provided during image creation. * **EnaSupport** *(boolean) --* Specifies whether enhanced networking with ENA is enabled. * **Hypervisor** *(string) --* The hypervisor type of the image. Only "xen" is supported. "ovm" is not supported. * **ImageOwnerAlias** *(string) --* The owner alias ( "amazon" | "aws-backup-vault" | "aws-marketplace"). * **Name** *(string) --* The name of the AMI that was provided during image creation. * **RootDeviceName** *(string) --* The device name of the root device volume (for example, "/dev/sda1"). * **RootDeviceType** *(string) --* The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume. * **SriovNetSupport** *(string) --* Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **StateReason** *(dict) --* The reason for the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. * **Tags** *(list) --* Any tags assigned to the image. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VirtualizationType** *(string) --* The type of virtualization of the AMI. * **BootMode** *(string) --* The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the *Amazon EC2 User Guide*. * **TpmSupport** *(string) --* If the image is configured for NitroTPM support, the value is "v2.0". For more information, see NitroTPM in the *Amazon EC2 User Guide*. * **DeprecationTime** *(string) --* The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Reservations': [ { 'ReservationId': 'string', 'OwnerId': 'string', 'RequesterId': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Instances': [ { 'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'Ebs': { 'AttachTime': datetime(2015, 1, 1), 'DeleteOnTermination': True|False, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'VolumeId': 'string', 'AssociatedResource': 'string', 'VolumeOwnerId': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' } } }, ], 'ClientToken': 'string', 'EbsOptimized': True|False, 'EnaSupport': True|False, 'Hypervisor': 'ovm'|'xen', 'IamInstanceProfile': { 'Arn': 'string', 'Id': 'string' }, 'InstanceLifecycle': 'spot'|'scheduled'|'capacity-block', 'ElasticGpuAssociations': [ { 'ElasticGpuId': 'string', 'ElasticGpuAssociationId': 'string', 'ElasticGpuAssociationState': 'string', 'ElasticGpuAssociationTime': 'string' }, ], 'ElasticInferenceAcceleratorAssociations': [ { 'ElasticInferenceAcceleratorArn': 'string', 'ElasticInferenceAcceleratorAssociationId': 'string', 'ElasticInferenceAcceleratorAssociationState': 'string', 'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1) }, ], 'NetworkInterfaces': [ { 'Association': { 'CarrierIp': 'string', 'CustomerOwnedIp': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string' }, 'Attachment': { 'AttachTime': datetime(2015, 1, 1), 'AttachmentId': 'string', 'DeleteOnTermination': True|False, 'DeviceIndex': 123, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'NetworkCardIndex': 123, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'EnaQueueCount': 123 }, 'Description': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'MacAddress': 'string', 'NetworkInterfaceId': 'string', 'OwnerId': 'string', 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Association': { 'CarrierIp': 'string', 'CustomerOwnedIp': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string' }, 'Primary': True|False, 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string' }, ], 'SourceDestCheck': True|False, 'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching', 'SubnetId': 'string', 'VpcId': 'string', 'InterfaceType': 'string', 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'ConnectionTrackingConfiguration': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], 'OutpostArn': 'string', 'RootDeviceName': 'string', 'RootDeviceType': 'ebs'|'instance-store', 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'SourceDestCheck': True|False, 'SpotInstanceRequestId': 'string', 'SriovNetSupport': 'string', 'StateReason': { 'Code': 'string', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VirtualizationType': 'hvm'|'paravirtual', 'CpuOptions': { 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, 'CapacityBlockId': 'string', 'CapacityReservationId': 'string', 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'HibernationOptions': { 'Configured': True|False }, 'Licenses': [ { 'LicenseConfigurationArn': 'string' }, ], 'MetadataOptions': { 'State': 'pending'|'applied', 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, 'EnclaveOptions': { 'Enabled': True|False }, 'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred', 'PlatformDetails': 'string', 'UsageOperation': 'string', 'UsageOperationUpdateTime': datetime(2015, 1, 1), 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'Ipv6Address': 'string', 'TpmSupport': 'string', 'MaintenanceOptions': { 'AutoRecovery': 'disabled'|'default', 'RebootMigration': 'disabled'|'default' }, 'CurrentInstanceBootMode': 'legacy-bios'|'uefi', 'NetworkPerformanceOptions': { 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' }, 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'InstanceId': 'string', 'ImageId': 'string', 'State': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PrivateDnsName': 'string', 'PublicDnsName': 'string', 'StateTransitionReason': 'string', 'KeyName': 'string', 'AmiLaunchIndex': 123, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'LaunchTime': datetime(2015, 1, 1), 'Placement': { 'Affinity': 'string', 'GroupName': 'string', 'PartitionNumber': 123, 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'GroupId': 'string', 'AvailabilityZone': 'string' }, 'KernelId': 'string', 'RamdiskId': 'string', 'Platform': 'Windows', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' }, 'SubnetId': 'string', 'VpcId': 'string', 'PrivateIpAddress': 'string', 'PublicIpAddress': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **Reservations** *(list) --* Information about the reservations. * *(dict) --* Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request. * **ReservationId** *(string) --* The ID of the reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the reservation. * **RequesterId** *(string) --* The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling). * **Groups** *(list) --* Not supported. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **Instances** *(list) --* The instances. * *(dict) --* Describes an instance. * **Architecture** *(string) --* The architecture of the image. * **BlockDeviceMappings** *(list) --* Any block device mapping entries for the instance. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Status** *(string) --* The attachment state. * **VolumeId** *(string) --* The ID of the EBS volume. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **VolumeOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the volume. This parameter is returned only for volumes that are attached to Amazon Web Services- managed resources. * **Operator** *(dict) --* The service provider that manages the EBS volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **ClientToken** *(string) --* The idempotency token you provided when you launched the instance, if applicable. * **EbsOptimized** *(boolean) --* 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 I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. * **EnaSupport** *(boolean) --* Specifies whether enhanced networking with ENA is enabled. * **Hypervisor** *(string) --* The hypervisor type of the instance. The value "xen" is used for both Xen and Nitro hypervisors. * **IamInstanceProfile** *(dict) --* The IAM instance profile associated with the instance, if applicable. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. * **InstanceLifecycle** *(string) --* Indicates whether this is a Spot Instance or a Scheduled Instance. * **ElasticGpuAssociations** *(list) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. Describes the association between an instance and an Elastic Graphics accelerator. * **ElasticGpuId** *(string) --* The ID of the Elastic Graphics accelerator. * **ElasticGpuAssociationId** *(string) --* The ID of the association. * **ElasticGpuAssociationState** *(string) --* The state of the association between the instance and the Elastic Graphics accelerator. * **ElasticGpuAssociationTime** *(string) --* The time the Elastic Graphics accelerator was associated with the instance. * **ElasticInferenceAcceleratorAssociations** *(list) --* Deprecated Note: Amazon Elastic Inference is no longer available. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes the association between an instance and an elastic inference accelerator. * **ElasticInferenceAcceleratorArn** *(string) --* The Amazon Resource Name (ARN) of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationId** *(string) --* The ID of the association. * **ElasticInferenceAcceleratorAssociationStat e** *(string) --* The state of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationTime ** *(datetime) --* The time at which the elastic inference accelerator is associated with an instance. * **NetworkInterfaces** *(list) --* The network interfaces for the instance. * *(dict) --* Describes a network interface. * **Association** *(dict) --* The association information for an Elastic IPv4 associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Attachment** *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The index of the device on the instance for the network interface attachment. * **Status** *(string) --* The attachment state. * **NetworkCardIndex** *(integer) --* The index of the network card. * **EnaSrdSpecification** *(dict) --* Contains the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **Description** *(string) --* The description. * **Groups** *(list) --* The security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **Ipv6Addresses** *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **MacAddress** *(string) --* The MAC address. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that created the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes a private IPv4 address. * **Association** *(dict) --* The association information for an Elastic IP address for the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IP address of the network interface. * **PrivateDnsName** *(string) --* The private IPv4 DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **Status** *(string) --* The status of the network interface. * **SubnetId** *(string) --* The ID of the subnet. * **VpcId** *(string) --* The ID of the VPC. * **InterfaceType** *(string) --* The type of network interface. Valid values: "interface" | "efa" | "efa- only" | "evs" | "trunk" * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv4 prefix. * **Ipv4Prefix** *(string) --* One or more IPv4 prefixes assigned to the network interface. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv6 prefix. * **Ipv6Prefix** *(string) --* One or more IPv6 prefixes assigned to the network interface. * **ConnectionTrackingConfiguration** *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Operator** *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **RootDeviceName** *(string) --* The device name of the root device volume (for example, "/dev/sda1"). * **RootDeviceType** *(string) --* The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. * **SecurityGroups** *(list) --* The security groups for the instance. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **SpotInstanceRequestId** *(string) --* If the request is a Spot Instance request, the ID of the request. * **SriovNetSupport** *(string) --* Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **StateReason** *(dict) --* The reason for the most recent state transition. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. * **Tags** *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VirtualizationType** *(string) --* The virtualization type of the instance. * **CpuOptions** *(dict) --* The CPU options for the instance. * **CoreCount** *(integer) --* The number of CPU cores for the instance. * **ThreadsPerCore** *(integer) --* The number of threads per CPU core. * **AmdSevSnp** *(string) --* Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV- SNP. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. Note: For P5 instances, a Capacity Block ID refers to a group of instances. For Trn2u instances, a capacity block ID refers to an EC2 UltraServer. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **CapacityReservationSpecification** *(dict) --* Information about the Capacity Reservation targeting option. * **CapacityReservationPreference** *(string) --* Describes the instance's Capacity Reservation preferences. Possible preferences include: * "open" - The instance can run in any "open" Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * "none" - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. * **CapacityReservationTarget** *(dict) --* Information about the targeted Capacity Reservation or Capacity Reservation group. * **CapacityReservationId** *(string) --* The ID of the targeted Capacity Reservation. * **CapacityReservationResourceGroupArn** *(string) --* The ARN of the targeted Capacity Reservation group. * **HibernationOptions** *(dict) --* Indicates whether the instance is enabled for hibernation. * **Configured** *(boolean) --* If "true", your instance is enabled for hibernation; otherwise, it is not enabled for hibernation. * **Licenses** *(list) --* The license configurations for the instance. * *(dict) --* Describes a license configuration. * **LicenseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the license configuration. * **MetadataOptions** *(dict) --* The metadata options for the instance. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. * "required" - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. * **HttpPutResponseHopLimit** *(integer) --* The maximum number of hops that the metadata token can travel. Possible values: Integers from "1" to "64" * **HttpEndpoint** *(string) --* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is "disabled", you cannot access your instance metadata. * **HttpProtocolIpv6** *(string) --* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Default: "disabled" * **InstanceMetadataTags** *(string) --* Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata. * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **BootMode** *(string) --* The boot mode that was specified by the AMI. If the value is "uefi-preferred", the AMI supports both UEFI and Legacy BIOS. The "currentInstanceBootMode" parameter is the boot mode that is used to boot the instance at launch or start. Note: The operating system contained in the AMI must be configured to support the specified boot mode. For more information, see Boot modes in the *Amazon EC2 User Guide*. * **PlatformDetails** *(string) --* The platform details value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. * **UsageOperation** *(string) --* The usage operation value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. * **UsageOperationUpdateTime** *(datetime) --* The time that the usage operation was last updated. * **PrivateDnsNameOptions** *(dict) --* The options for the instance hostname. * **HostnameType** *(string) --* The type of hostname to assign to an instance. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * **Ipv6Address** *(string) --* The IPv6 address assigned to the instance. * **TpmSupport** *(string) --* If the instance is configured for NitroTPM support, the value is "v2.0". For more information, see NitroTPM in the *Amazon EC2 User Guide*. * **MaintenanceOptions** *(dict) --* Provides information on the recovery and maintenance options of your instance. * **AutoRecovery** *(string) --* Provides information on the current automatic recovery behavior of your instance. * **RebootMigration** *(string) --* Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled "system-reboot" event: * "default" - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the "system- reboot" event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled. * "disabled" - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The "system-reboot" event remains scheduled. This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the *Amazon EC2 User Guide*. * **CurrentInstanceBootMode** *(string) --* The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the *Amazon EC2 User Guide*. * **NetworkPerformanceOptions** *(dict) --* Contains settings for the network performance options for your instance. * **BandwidthWeighting** *(string) --* When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type. * **Operator** *(dict) --* The service provider that manages the instance. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **InstanceId** *(string) --* The ID of the instance. * **ImageId** *(string) --* The ID of the AMI used to launch the instance. * **State** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PrivateDnsName** *(string) --* [IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the "running" state. The Amazon-provided DNS server resolves Amazon- provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate. * **PublicDnsName** *(string) --* The public DNS name assigned to the instance. This name is not available until the instance enters the "running" state. This name is only available if you've enabled DNS hostnames for your VPC. The format of this name depends on the public hostname type. * **StateTransitionReason** *(string) --* The reason for the most recent state transition. This might be an empty string. * **KeyName** *(string) --* The name of the key pair, if this instance was launched with an associated key pair. * **AmiLaunchIndex** *(integer) --* The AMI launch index, which can be used to find this instance in the launch group. * **ProductCodes** *(list) --* The product codes attached to this instance, if applicable. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **InstanceType** *(string) --* The instance type. * **LaunchTime** *(datetime) --* The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface. * **Placement** *(dict) --* The location where the instance launched, if applicable. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. * **KernelId** *(string) --* The kernel associated with this instance, if applicable. * **RamdiskId** *(string) --* The RAM disk associated with this instance, if applicable. * **Platform** *(string) --* The platform. This value is "windows" for Windows instances; otherwise, it is empty. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **SubnetId** *(string) --* The ID of the subnet in which the instance is running. * **VpcId** *(string) --* The ID of the VPC in which the instance is running. * **PrivateIpAddress** *(string) --* The private IPv4 address assigned to the instance. * **PublicIpAddress** *(string) --* The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone. EC2 / Paginator / GetIpamDiscoveredAccounts GetIpamDiscoveredAccounts ************************* class EC2.Paginator.GetIpamDiscoveredAccounts paginator = client.get_paginator('get_ipam_discovered_accounts') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_ipam_discovered_accounts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, IpamResourceDiscoveryId='string', DiscoveryRegion='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** A resource discovery ID. * **DiscoveryRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region that the account information is returned from. * **Filters** (*list*) -- Discovered account filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamDiscoveredAccounts': [ { 'AccountId': 'string', 'DiscoveryRegion': 'string', 'FailureReason': { 'Code': 'assume-role-failure'|'throttling-failure'|'unauthorized-failure', 'Message': 'string' }, 'LastAttemptedDiscoveryTime': datetime(2015, 1, 1), 'LastSuccessfulDiscoveryTime': datetime(2015, 1, 1), 'OrganizationalUnitId': 'string' }, ], } **Response Structure** * *(dict) --* * **IpamDiscoveredAccounts** *(list) --* Discovered accounts. * *(dict) --* An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. * **AccountId** *(string) --* The account ID. * **DiscoveryRegion** *(string) --* The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region. * **FailureReason** *(dict) --* The resource discovery failure reason. * **Code** *(string) --* The discovery failure code. * "assume-role-failure" - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following: * SLR has not been created yet and IPAM is still creating it. * You have opted-out of the IPAM home Region. * Account you are using as your IPAM account has been suspended. * "throttling-failure" - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR. * "unauthorized-failure" - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the *Amazon Elastic Compute Cloud API Reference*. * **Message** *(string) --* The discovery failure message. * **LastAttemptedDiscoveryTime** *(datetime) --* The last attempted resource discovery time. * **LastSuccessfulDiscoveryTime** *(datetime) --* The last successful resource discovery time. * **OrganizationalUnitId** *(string) --* The ID of an Organizational Unit in Amazon Web Services Organizations. EC2 / Paginator / DescribeTransitGatewayMulticastDomains DescribeTransitGatewayMulticastDomains ************************************** class EC2.Paginator.DescribeTransitGatewayMulticastDomains paginator = client.get_paginator('describe_transit_gateway_multicast_domains') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_multicast_domains()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayMulticastDomainIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayMulticastDomainIds** (*list*) -- The ID of the transit gateway multicast domain. * *(string) --* * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayMulticastDomains': [ { 'TransitGatewayMulticastDomainId': 'string', 'TransitGatewayId': 'string', 'TransitGatewayMulticastDomainArn': 'string', 'OwnerId': 'string', 'Options': { 'Igmpv2Support': 'enable'|'disable', 'StaticSourcesSupport': 'enable'|'disable', 'AutoAcceptSharedAssociations': 'enable'|'disable' }, 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayMulticastDomains** *(list) --* Information about the transit gateway multicast domains. * *(dict) --* Describes the transit gateway multicast domain. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **TransitGatewayMulticastDomainArn** *(string) --* The Amazon Resource Name (ARN) of the transit gateway multicast domain. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway multicast domain. * **Options** *(dict) --* The options for the transit gateway multicast domain. * **Igmpv2Support** *(string) --* Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. * **StaticSourcesSupport** *(string) --* Indicates whether support for statically configuring transit gateway multicast group sources is turned on. * **AutoAcceptSharedAssociations** *(string) --* Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. * **State** *(string) --* The state of the transit gateway multicast domain. * **CreationTime** *(datetime) --* The time the transit gateway multicast domain was created. * **Tags** *(list) --* The tags for the transit gateway multicast domain. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeTrafficMirrorSessions DescribeTrafficMirrorSessions ***************************** class EC2.Paginator.DescribeTrafficMirrorSessions paginator = client.get_paginator('describe_traffic_mirror_sessions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_traffic_mirror_sessions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TrafficMirrorSessionIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TrafficMirrorSessionIds** (*list*) -- The ID of the Traffic Mirror session. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrafficMirrorSessions': [ { 'TrafficMirrorSessionId': 'string', 'TrafficMirrorTargetId': 'string', 'TrafficMirrorFilterId': 'string', 'NetworkInterfaceId': 'string', 'OwnerId': 'string', 'PacketLength': 123, 'SessionNumber': 123, 'VirtualNetworkId': 123, 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TrafficMirrorSessions** *(list) --* Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. * *(dict) --* Describes a Traffic Mirror session. * **TrafficMirrorSessionId** *(string) --* The ID for the Traffic Mirror session. * **TrafficMirrorTargetId** *(string) --* The ID of the Traffic Mirror target. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter. * **NetworkInterfaceId** *(string) --* The ID of the Traffic Mirror session's network interface. * **OwnerId** *(string) --* The ID of the account that owns the Traffic Mirror session. * **PacketLength** *(integer) --* The number of bytes in each packet to mirror. These are the 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 * **SessionNumber** *(integer) --* 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. * **VirtualNetworkId** *(integer) --* The virtual network ID associated with the Traffic Mirror session. * **Description** *(string) --* The description of the Traffic Mirror session. * **Tags** *(list) --* The tags assigned to the Traffic Mirror session. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeSubnets DescribeSubnets *************** class EC2.Paginator.DescribeSubnets paginator = client.get_paginator('describe_subnets') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_subnets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SubnetIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- The 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. * "customer-owned-ipv4-pool" - The customer-owned IPv4 address pool associated with the subnet. * "default-for-az" - Indicates whether this is the default subnet for the Availability Zone ( "true" | "false"). You can also use "defaultForAz" as the filter name. * "enable-dns64" - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. * "enable-lni-at-device-index" - Indicates the device position for local network interfaces in this subnet. For example, "1" indicates local network interfaces in this subnet are the secondary network interface (eth1). * "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. * "ipv6-native" - Indicates whether this is an IPv6 only subnet ( "true" | "false"). * "map-customer-owned-ip-on-launch" - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. * "map-public-ip-on-launch" - Indicates whether instances launched in this subnet receive a public IPv4 address. * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The ID of the Amazon Web Services account that owns the subnet. * "private-dns-name-options-on-launch.hostname-type" - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name). * "private-dns-name-options-on-launch.enable-resource-name- dns-a-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * "private-dns-name-options-on-launch.enable-resource-name- dns-aaaa-record" - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * "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" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SubnetIds** (*list*) -- The IDs of the subnets. Default: Describes all your subnets. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Subnets': [ { 'AvailabilityZoneId': 'string', 'EnableLniAtDeviceIndex': 123, 'MapCustomerOwnedIpOnLaunch': True|False, 'CustomerOwnedIpv4Pool': 'string', 'OwnerId': 'string', 'AssignIpv6AddressOnCreation': True|False, 'Ipv6CidrBlockAssociationSet': [ { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SubnetArn': 'string', 'OutpostArn': 'string', 'EnableDns64': True|False, 'Ipv6Native': True|False, 'PrivateDnsNameOptionsOnLaunch': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'BlockPublicAccessStates': { 'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress' }, 'Type': 'string', 'SubnetId': 'string', 'State': 'pending'|'available'|'unavailable'|'failed'|'failed-insufficient-capacity', 'VpcId': 'string', 'CidrBlock': 'string', 'AvailableIpAddressCount': 123, 'AvailabilityZone': 'string', 'DefaultForAz': True|False, 'MapPublicIpOnLaunch': True|False }, ] } **Response Structure** * *(dict) --* * **Subnets** *(list) --* Information about the subnets. * *(dict) --* Describes a subnet. * **AvailabilityZoneId** *(string) --* The AZ ID of the subnet. * **EnableLniAtDeviceIndex** *(integer) --* Indicates the device position for local network interfaces in this subnet. For example, "1" indicates local network interfaces in this subnet are the secondary network interface (eth1). * **MapCustomerOwnedIpOnLaunch** *(boolean) --* Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. * **CustomerOwnedIpv4Pool** *(string) --* The customer-owned IPv4 address pool associated with the subnet. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the subnet. * **AssignIpv6AddressOnCreation** *(boolean) --* Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address. * **Ipv6CidrBlockAssociationSet** *(list) --* Information about the IPv6 CIDR blocks associated with the subnet. * *(dict) --* Describes an association between a subnet and an IPv6 CIDR block. * **AssociationId** *(string) --* The ID of the association. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* The state of the CIDR block. * **State** *(string) --* The state of a CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **Tags** *(list) --* Any tags assigned to the subnet. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SubnetArn** *(string) --* The Amazon Resource Name (ARN) of the subnet. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **EnableDns64** *(boolean) --* Indicates whether DNS queries made to the Amazon- provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. * **Ipv6Native** *(boolean) --* Indicates whether this is an IPv6 only subnet. * **PrivateDnsNameOptionsOnLaunch** *(dict) --* The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance. * **HostnameType** *(string) --* The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records. * **BlockPublicAccessStates** *(dict) --* The state of VPC Block Public Access (BPA). * **InternetGatewayBlockMode** *(string) --* The mode of VPC BPA. * "off": VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress- only internet gateways in this Region. * "block-bidirectional": Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets). * "block-ingress": Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established. * **Type** *(string) --* Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are "Elastic VMware Service" or no value. For more information about Amazon EVS, see Amazon Elastic VMware Service API Reference. * **SubnetId** *(string) --* The ID of the subnet. * **State** *(string) --* The current state of the subnet. * "failed": The underlying infrastructure to support the subnet failed to provision as expected. * "failed-insufficient-capacity": The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity. * **VpcId** *(string) --* The ID of the VPC the subnet is in. * **CidrBlock** *(string) --* The IPv4 CIDR block assigned to the subnet. * **AvailableIpAddressCount** *(integer) --* The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. * **AvailabilityZone** *(string) --* The Availability Zone of the subnet. * **DefaultForAz** *(boolean) --* Indicates whether this is the default subnet for the Availability Zone. * **MapPublicIpOnLaunch** *(boolean) --* Indicates whether instances launched in this subnet receive a public IPv4 address. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. EC2 / Paginator / DescribeCapacityBlockExtensionOfferings DescribeCapacityBlockExtensionOfferings *************************************** class EC2.Paginator.DescribeCapacityBlockExtensionOfferings paginator = client.get_paginator('describe_capacity_block_extension_offerings') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_capacity_block_extension_offerings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, CapacityBlockExtensionDurationHours=123, CapacityReservationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **CapacityBlockExtensionDurationHours** (*integer*) -- **[REQUIRED]** The duration of the Capacity Block extension offering in hours. * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity reservation to be extended. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityBlockExtensionOfferings': [ { 'CapacityBlockExtensionOfferingId': 'string', 'InstanceType': 'string', 'InstanceCount': 123, 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'StartDate': datetime(2015, 1, 1), 'CapacityBlockExtensionStartDate': datetime(2015, 1, 1), 'CapacityBlockExtensionEndDate': datetime(2015, 1, 1), 'CapacityBlockExtensionDurationHours': 123, 'UpfrontFee': 'string', 'CurrencyCode': 'string', 'Tenancy': 'default'|'dedicated' }, ], } **Response Structure** * *(dict) --* * **CapacityBlockExtensionOfferings** *(list) --* The recommended Capacity Block extension offerings for the dates specified. * *(dict) --* The recommended Capacity Block extension that fits your search requirements. * **CapacityBlockExtensionOfferingId** *(string) --* The ID of the Capacity Block extension offering. * **InstanceType** *(string) --* The instance type of the Capacity Block that will be extended. * **InstanceCount** *(integer) --* The number of instances in the Capacity Block extension offering. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block that will be extended. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Block that will be extended. * **StartDate** *(datetime) --* The start date of the Capacity Block that will be extended. * **CapacityBlockExtensionStartDate** *(datetime) --* The date and time at which the Capacity Block extension will start. This date is also the same as the end date of the Capacity Block that will be extended. * **CapacityBlockExtensionEndDate** *(datetime) --* The date and time at which the Capacity Block extension expires. When a Capacity Block expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Block's state changes to "expired" when it reaches its end date * **CapacityBlockExtensionDurationHours** *(integer) --* The amount of time of the Capacity Block extension offering in hours. * **UpfrontFee** *(string) --* The total price of the Capacity Block extension offering, to be paid up front. * **CurrencyCode** *(string) --* The currency of the payment for the Capacity Block extension offering. * **Tenancy** *(string) --* Indicates the tenancy of the Capacity Block extension offering. A Capacity Block can have one of the following tenancy settings: * "default" - The Capacity Block is created on hardware that is shared with other Amazon Web Services accounts. * "dedicated" - The Capacity Block is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. EC2 / Paginator / DescribeNetworkInsightsAccessScopes DescribeNetworkInsightsAccessScopes *********************************** class EC2.Paginator.DescribeNetworkInsightsAccessScopes paginator = client.get_paginator('describe_network_insights_access_scopes') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_insights_access_scopes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInsightsAccessScopeIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInsightsAccessScopeIds** (*list*) -- The IDs of the Network Access Scopes. * *(string) --* * **Filters** (*list*) -- There are no supported filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAccessScopes': [ { 'NetworkInsightsAccessScopeId': 'string', 'NetworkInsightsAccessScopeArn': 'string', 'CreatedDate': datetime(2015, 1, 1), 'UpdatedDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **NetworkInsightsAccessScopes** *(list) --* The Network Access Scopes. * *(dict) --* Describes a Network Access Scope. * **NetworkInsightsAccessScopeId** *(string) --* The ID of the Network Access Scope. * **NetworkInsightsAccessScopeArn** *(string) --* The Amazon Resource Name (ARN) of the Network Access Scope. * **CreatedDate** *(datetime) --* The creation date. * **UpdatedDate** *(datetime) --* The last updated date. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeManagedPrefixLists DescribeManagedPrefixLists ************************** class EC2.Paginator.DescribeManagedPrefixLists paginator = client.get_paginator('describe_managed_prefix_lists') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_managed_prefix_lists()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PrefixListIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PrefixListIds** (*list*) -- One or more prefix list IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PrefixLists': [ { 'PrefixListId': 'string', 'AddressFamily': 'string', 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed', 'StateMessage': 'string', 'PrefixListArn': 'string', 'PrefixListName': 'string', 'MaxEntries': 123, 'Version': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OwnerId': 'string' }, ] } **Response Structure** * *(dict) --* * **PrefixLists** *(list) --* Information about the prefix lists. * *(dict) --* Describes a managed prefix list. * **PrefixListId** *(string) --* The ID of the prefix list. * **AddressFamily** *(string) --* The IP address version. * **State** *(string) --* The current state of the prefix list. * **StateMessage** *(string) --* The state message. * **PrefixListArn** *(string) --* The Amazon Resource Name (ARN) for the prefix list. * **PrefixListName** *(string) --* The name of the prefix list. * **MaxEntries** *(integer) --* The maximum number of entries for the prefix list. * **Version** *(integer) --* The version of the prefix list. * **Tags** *(list) --* The tags for the prefix list. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OwnerId** *(string) --* The ID of the owner of the prefix list. EC2 / Paginator / GetManagedPrefixListEntries GetManagedPrefixListEntries *************************** class EC2.Paginator.GetManagedPrefixListEntries paginator = client.get_paginator('get_managed_prefix_list_entries') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_managed_prefix_list_entries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, PrefixListId='string', TargetVersion=123, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list. * **TargetVersion** (*integer*) -- The version of the prefix list for which to return the entries. The default is the current version. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Entries': [ { 'Cidr': 'string', 'Description': 'string' }, ], } **Response Structure** * *(dict) --* * **Entries** *(list) --* Information about the prefix list entries. * *(dict) --* Describes a prefix list entry. * **Cidr** *(string) --* The CIDR block. * **Description** *(string) --* The description. EC2 / Paginator / GetManagedPrefixListAssociations GetManagedPrefixListAssociations ******************************** class EC2.Paginator.GetManagedPrefixListAssociations paginator = client.get_paginator('get_managed_prefix_list_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_managed_prefix_list_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, PrefixListId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PrefixListAssociations': [ { 'ResourceId': 'string', 'ResourceOwner': 'string' }, ], } **Response Structure** * *(dict) --* * **PrefixListAssociations** *(list) --* Information about the associations. * *(dict) --* Describes the resource with which a prefix list is associated. * **ResourceId** *(string) --* The ID of the resource. * **ResourceOwner** *(string) --* The owner of the resource. EC2 / Paginator / DescribeAddressTransfers DescribeAddressTransfers ************************ class EC2.Paginator.DescribeAddressTransfers paginator = client.get_paginator('describe_address_transfers') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_address_transfers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AllocationIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AllocationIds** (*list*) -- The allocation IDs of Elastic IP addresses. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AddressTransfers': [ { 'PublicIp': 'string', 'AllocationId': 'string', 'TransferAccountId': 'string', 'TransferOfferExpirationTimestamp': datetime(2015, 1, 1), 'TransferOfferAcceptedTimestamp': datetime(2015, 1, 1), 'AddressTransferStatus': 'pending'|'disabled'|'accepted' }, ], } **Response Structure** * *(dict) --* * **AddressTransfers** *(list) --* The Elastic IP address transfer. * *(dict) --* Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the *Amazon VPC User Guide*. * **PublicIp** *(string) --* The Elastic IP address being transferred. * **AllocationId** *(string) --* The allocation ID of an Elastic IP address. * **TransferAccountId** *(string) --* The ID of the account that you want to transfer the Elastic IP address to. * **TransferOfferExpirationTimestamp** *(datetime) --* The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner. * **TransferOfferAcceptedTimestamp** *(datetime) --* The timestamp when the Elastic IP address transfer was accepted. * **AddressTransferStatus** *(string) --* The Elastic IP address transfer status. EC2 / Paginator / DescribeFlowLogs DescribeFlowLogs **************** class EC2.Paginator.DescribeFlowLogs paginator = client.get_paginator('describe_flow_logs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_flow_logs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], FlowLogIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "deliver-log-status" - The status of the logs delivery ( "SUCCESS" | "FAILED"). * "log-destination-type" - The type of destination for the flow log data ( "cloud-watch-logs" | "s3" | "kinesis- data-firehose"). * "flow-log-id" - The ID of the flow log. * "log-group-name" - The name of the log group. * "resource-id" - The ID of the VPC, subnet, or network interface. * "traffic-type" - The type of traffic ( "ACCEPT" | "REJECT" | "ALL"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **FlowLogIds** (*list*) -- One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FlowLogs': [ { 'CreationTime': datetime(2015, 1, 1), 'DeliverLogsErrorMessage': 'string', 'DeliverLogsPermissionArn': 'string', 'DeliverCrossAccountRole': 'string', 'DeliverLogsStatus': 'string', 'FlowLogId': 'string', 'FlowLogStatus': 'string', 'LogGroupName': 'string', 'ResourceId': 'string', 'TrafficType': 'ACCEPT'|'REJECT'|'ALL', 'LogDestinationType': 'cloud-watch-logs'|'s3'|'kinesis-data-firehose', 'LogDestination': 'string', 'LogFormat': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'MaxAggregationInterval': 123, 'DestinationOptions': { 'FileFormat': 'plain-text'|'parquet', 'HiveCompatiblePartitions': True|False, 'PerHourPartition': True|False } }, ], } **Response Structure** * *(dict) --* * **FlowLogs** *(list) --* Information about the flow logs. * *(dict) --* Describes a flow log. * **CreationTime** *(datetime) --* The date and time the flow log was created. * **DeliverLogsErrorMessage** *(string) --* Information about the error that occurred. "Rate limited" indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. "Access error" indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. "Unknown error" indicates an internal error. * **DeliverLogsPermissionArn** *(string) --* The ARN of the IAM role allows the service to publish logs to CloudWatch Logs. * **DeliverCrossAccountRole** *(string) --* The ARN of the IAM role that allows the service to publish flow logs across accounts. * **DeliverLogsStatus** *(string) --* The status of the logs delivery ( "SUCCESS" | "FAILED"). * **FlowLogId** *(string) --* The ID of the flow log. * **FlowLogStatus** *(string) --* The status of the flow log ( "ACTIVE"). * **LogGroupName** *(string) --* The name of the flow log group. * **ResourceId** *(string) --* The ID of the resource being monitored. * **TrafficType** *(string) --* The type of traffic captured for the flow log. * **LogDestinationType** *(string) --* The type of destination for the flow log data. * **LogDestination** *(string) --* The Amazon Resource Name (ARN) of the destination for the flow log data. * **LogFormat** *(string) --* The format of the flow log record. * **Tags** *(list) --* The tags for the flow log. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **MaxAggregationInterval** *(integer) --* The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value. Valid Values: "60" | "600" * **DestinationOptions** *(dict) --* The destination options. * **FileFormat** *(string) --* The format for the flow log. * **HiveCompatiblePartitions** *(boolean) --* Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. * **PerHourPartition** *(boolean) --* Indicates whether to partition the flow log per hour. EC2 / Paginator / DescribeVpcEndpoints DescribeVpcEndpoints ******************** class EC2.Paginator.DescribeVpcEndpoints paginator = client.get_paginator('describe_vpc_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, VpcEndpointIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcEndpointIds** (*list*) -- The IDs of the VPC endpoints. * *(string) --* * **Filters** (*list*) -- The filters. * "ip-address-type" - The IP address type ( "ipv4" | "ipv6"). * "service-name" - The name of the service. * "service-region" - The Region of the service. * "tag": - 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 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" | "Resource" | "ServiceNetwork"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork', 'VpcId': 'string', 'ServiceName': 'string', 'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial', 'PolicyDocument': 'string', 'RouteTableIds': [ 'string', ], 'SubnetIds': [ 'string', ], 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'IpAddressType': 'ipv4'|'dualstack'|'ipv6', 'DnsOptions': { 'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined', 'PrivateDnsOnlyForInboundResolverEndpoint': True|False }, 'PrivateDnsEnabled': True|False, 'RequesterManaged': True|False, 'NetworkInterfaceIds': [ 'string', ], 'DnsEntries': [ { 'DnsName': 'string', 'HostedZoneId': 'string' }, ], 'CreationTimestamp': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OwnerId': 'string', 'LastError': { 'Message': 'string', 'Code': 'string' }, 'Ipv4Prefixes': [ { 'SubnetId': 'string', 'IpPrefixes': [ 'string', ] }, ], 'Ipv6Prefixes': [ { 'SubnetId': 'string', 'IpPrefixes': [ 'string', ] }, ], 'FailureReason': 'string', 'ServiceNetworkArn': 'string', 'ResourceConfigurationArn': 'string', 'ServiceRegion': 'string' }, ], } **Response Structure** * *(dict) --* * **VpcEndpoints** *(list) --* Information about the VPC endpoints. * *(dict) --* Describes a VPC endpoint. * **VpcEndpointId** *(string) --* The ID of the endpoint. * **VpcEndpointType** *(string) --* The type of endpoint. * **VpcId** *(string) --* The ID of the VPC to which the endpoint is associated. * **ServiceName** *(string) --* The name of the service to which the endpoint is associated. * **State** *(string) --* The state of the endpoint. * **PolicyDocument** *(string) --* The policy document associated with the endpoint, if applicable. * **RouteTableIds** *(list) --* (Gateway endpoint) The IDs of the route tables associated with the endpoint. * *(string) --* * **SubnetIds** *(list) --* (Interface endpoint) The subnets for the endpoint. * *(string) --* * **Groups** *(list) --* (Interface endpoint) Information about the security groups that are associated with the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **IpAddressType** *(string) --* The IP address type for the endpoint. * **DnsOptions** *(dict) --* The DNS options for the endpoint. * **DnsRecordIpType** *(string) --* The DNS records created for the endpoint. * **PrivateDnsOnlyForInboundResolverEndpoint** *(boolean) --* Indicates whether to enable private DNS only for inbound endpoints. * **PrivateDnsEnabled** *(boolean) --* (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. * **RequesterManaged** *(boolean) --* Indicates whether the endpoint is being managed by its service. * **NetworkInterfaceIds** *(list) --* (Interface endpoint) The network interfaces for the endpoint. * *(string) --* * **DnsEntries** *(list) --* (Interface endpoint) The DNS entries for the endpoint. * *(dict) --* Describes a DNS entry. * **DnsName** *(string) --* The DNS name. * **HostedZoneId** *(string) --* The ID of the private hosted zone. * **CreationTimestamp** *(datetime) --* The date and time that the endpoint was created. * **Tags** *(list) --* The tags assigned to the endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the endpoint. * **LastError** *(dict) --* The last error that occurred for endpoint. * **Message** *(string) --* The error message for the VPC endpoint error. * **Code** *(string) --* The error code for the VPC endpoint error. * **Ipv4Prefixes** *(list) --* Array of IPv4 prefixes. * *(dict) --* Prefixes of the subnet IP. * **SubnetId** *(string) --* ID of the subnet. * **IpPrefixes** *(list) --* Array of SubnetIpPrefixes objects. * *(string) --* * **Ipv6Prefixes** *(list) --* Array of IPv6 prefixes. * *(dict) --* Prefixes of the subnet IP. * **SubnetId** *(string) --* ID of the subnet. * **IpPrefixes** *(list) --* Array of SubnetIpPrefixes objects. * *(string) --* * **FailureReason** *(string) --* Reason for the failure. * **ServiceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **ResourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **ServiceRegion** *(string) --* The Region where the service is hosted. EC2 / Paginator / DescribeVpcs DescribeVpcs ************ class EC2.Paginator.DescribeVpcs paginator = client.get_paginator('describe_vpcs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpcs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpcIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- The 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. * "is-default" - Indicates whether the VPC is the default VPC. * "owner-id" - The ID of the Amazon Web Services account that owns the VPC. * "state" - The state of the VPC ( "pending" | "available"). * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpcIds** (*list*) -- The IDs of the VPCs. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Vpcs': [ { 'OwnerId': 'string', 'InstanceTenancy': 'default'|'dedicated'|'host', 'Ipv6CidrBlockAssociationSet': [ { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'NetworkBorderGroup': 'string', 'Ipv6Pool': 'string', 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, ], 'CidrBlockAssociationSet': [ { 'AssociationId': 'string', 'CidrBlock': 'string', 'CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' } }, ], 'IsDefault': True|False, 'EncryptionControl': { 'VpcId': 'string', 'VpcEncryptionControlId': 'string', 'Mode': 'monitor'|'enforce', 'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed', 'StateMessage': 'string', 'ResourceExclusions': { 'InternetGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'EgressOnlyInternetGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'NatGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'VirtualPrivateGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'VpcPeering': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'BlockPublicAccessStates': { 'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress' }, 'VpcId': 'string', 'State': 'pending'|'available', 'CidrBlock': 'string', 'DhcpOptionsId': 'string' }, ] } **Response Structure** * *(dict) --* * **Vpcs** *(list) --* Information about the VPCs. * *(dict) --* Describes a VPC. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **InstanceTenancy** *(string) --* The allowed tenancy of instances launched into the VPC. * **Ipv6CidrBlockAssociationSet** *(list) --* Information about the IPv6 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv6 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, "us-east-1-wl1-bos-wlz-1". * **Ipv6Pool** *(string) --* The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **CidrBlockAssociationSet** *(list) --* Information about the IPv4 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv4 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **IsDefault** *(boolean) --* Indicates whether the VPC is the default VPC. * **EncryptionControl** *(dict) --* * **VpcId** *(string) --* * **VpcEncryptionControlId** *(string) --* * **Mode** *(string) --* * **State** *(string) --* * **StateMessage** *(string) --* * **ResourceExclusions** *(dict) --* * **InternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **EgressOnlyInternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **NatGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VirtualPrivateGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VpcPeering** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **Tags** *(list) --* * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Tags** *(list) --* Any tags assigned to the VPC. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **BlockPublicAccessStates** *(dict) --* The state of VPC Block Public Access (BPA). * **InternetGatewayBlockMode** *(string) --* The mode of VPC BPA. * "off": VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress- only internet gateways in this Region. * "block-bidirectional": Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets). * "block-ingress": Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established. * **VpcId** *(string) --* The ID of the VPC. * **State** *(string) --* The current state of the VPC. * **CidrBlock** *(string) --* The primary IPv4 CIDR block for the VPC. * **DhcpOptionsId** *(string) --* The ID of the set of DHCP options you've associated with the VPC. EC2 / Paginator / DescribeHostReservations DescribeHostReservations ************************ class EC2.Paginator.DescribeHostReservations paginator = client.get_paginator('describe_host_reservations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_host_reservations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], HostReservationIdSet=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- 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:" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **HostReservationIdSet** (*list*) -- The host reservation IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HostReservationSet': [ { 'Count': 123, 'CurrencyCode': 'USD', 'Duration': 123, 'End': datetime(2015, 1, 1), 'HostIdSet': [ 'string', ], 'HostReservationId': 'string', 'HourlyPrice': 'string', 'InstanceFamily': 'string', 'OfferingId': 'string', 'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront', 'Start': datetime(2015, 1, 1), 'State': 'payment-pending'|'payment-failed'|'active'|'retired', 'UpfrontPrice': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **HostReservationSet** *(list) --* Details about the reservation's configuration. * *(dict) --* Details about the Dedicated Host Reservation and associated Dedicated Hosts. * **Count** *(integer) --* The number of Dedicated Hosts the reservation is associated with. * **CurrencyCode** *(string) --* The currency in which the "upfrontPrice" and "hourlyPrice" amounts are specified. At this time, the only supported currency is "USD". * **Duration** *(integer) --* The length of the reservation's term, specified in seconds. Can be "31536000 (1 year)" | "94608000 (3 years)". * **End** *(datetime) --* The date and time that the reservation ends. * **HostIdSet** *(list) --* The IDs of the Dedicated Hosts associated with the reservation. * *(string) --* * **HostReservationId** *(string) --* The ID of the reservation that specifies the associated Dedicated Hosts. * **HourlyPrice** *(string) --* The hourly price of the reservation. * **InstanceFamily** *(string) --* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. * **OfferingId** *(string) --* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. * **PaymentOption** *(string) --* The payment option selected for this reservation. * **Start** *(datetime) --* The date and time that the reservation started. * **State** *(string) --* The state of the reservation. * **UpfrontPrice** *(string) --* The upfront price of the reservation. * **Tags** *(list) --* Any tags assigned to the Dedicated Host Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeCarrierGateways DescribeCarrierGateways *********************** class EC2.Paginator.DescribeCarrierGateways paginator = client.get_paginator('describe_carrier_gateways') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_carrier_gateways()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CarrierGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CarrierGatewayIds** (*list*) -- One or more carrier gateway IDs. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account ID of the owner of the carrier gateway. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CarrierGateways': [ { 'CarrierGatewayId': 'string', 'VpcId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **CarrierGateways** *(list) --* Information about the carrier gateway. * *(dict) --* Describes a carrier gateway. * **CarrierGatewayId** *(string) --* The ID of the carrier gateway. * **VpcId** *(string) --* The ID of the VPC associated with the carrier gateway. * **State** *(string) --* The state of the carrier gateway. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the carrier gateway. * **Tags** *(list) --* The tags assigned to the carrier gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeInstanceCreditSpecifications DescribeInstanceCreditSpecifications ************************************ class EC2.Paginator.DescribeInstanceCreditSpecifications paginator = client.get_paginator('describe_instance_credit_specifications') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_credit_specifications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*list*) -- The filters. * "instance-id" - The ID of the instance. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceCreditSpecifications': [ { 'InstanceId': 'string', 'CpuCredits': 'string' }, ], } **Response Structure** * *(dict) --* * **InstanceCreditSpecifications** *(list) --* Information about the credit option for CPU usage of an instance. * *(dict) --* Describes the credit option for CPU usage of a burstable performance instance. * **InstanceId** *(string) --* The ID of the instance. * **CpuCredits** *(string) --* The credit option for CPU usage of the instance. Valid values: "standard" | "unlimited" EC2 / Paginator / DescribeTrafficMirrorTargets DescribeTrafficMirrorTargets **************************** class EC2.Paginator.DescribeTrafficMirrorTargets paginator = client.get_paginator('describe_traffic_mirror_targets') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_traffic_mirror_targets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TrafficMirrorTargetIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TrafficMirrorTargetIds** (*list*) -- The ID of the Traffic Mirror targets. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrafficMirrorTargets': [ { 'TrafficMirrorTargetId': 'string', 'NetworkInterfaceId': 'string', 'NetworkLoadBalancerArn': 'string', 'Type': 'network-interface'|'network-load-balancer'|'gateway-load-balancer-endpoint', 'Description': 'string', 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'GatewayLoadBalancerEndpointId': 'string' }, ], } **Response Structure** * *(dict) --* * **TrafficMirrorTargets** *(list) --* Information about one or more Traffic Mirror targets. * *(dict) --* Describes a Traffic Mirror target. * **TrafficMirrorTargetId** *(string) --* The ID of the Traffic Mirror target. * **NetworkInterfaceId** *(string) --* The network interface ID that is attached to the target. * **NetworkLoadBalancerArn** *(string) --* The Amazon Resource Name (ARN) of the Network Load Balancer. * **Type** *(string) --* The type of Traffic Mirror target. * **Description** *(string) --* Information about the Traffic Mirror target. * **OwnerId** *(string) --* The ID of the account that owns the Traffic Mirror target. * **Tags** *(list) --* The tags assigned to the Traffic Mirror target. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **GatewayLoadBalancerEndpointId** *(string) --* The ID of the Gateway Load Balancer endpoint. EC2 / Paginator / DescribeInstanceConnectEndpoints DescribeInstanceConnectEndpoints ******************************** class EC2.Paginator.DescribeInstanceConnectEndpoints paginator = client.get_paginator('describe_instance_connect_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_connect_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceConnectEndpointIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "instance-connect-endpoint-id" - The ID of the EC2 Instance Connect Endpoint. * "state" - The state of the EC2 Instance Connect Endpoint ( "create-in-progress" | "create-complete" | "create- failed" | "delete-in-progress" | "delete-complete" | "delete-failed"). * "subnet-id" - The ID of the subnet in which the EC2 Instance Connect Endpoint was created. * "tag": - 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. * "tag-value" - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key. * "vpc-id" - The ID of the VPC in which the EC2 Instance Connect Endpoint was created. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceConnectEndpointIds** (*list*) -- One or more EC2 Instance Connect Endpoint IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceConnectEndpoints': [ { 'OwnerId': 'string', 'InstanceConnectEndpointId': 'string', 'InstanceConnectEndpointArn': 'string', 'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed', 'StateMessage': 'string', 'DnsName': 'string', 'FipsDnsName': 'string', 'NetworkInterfaceIds': [ 'string', ], 'VpcId': 'string', 'AvailabilityZone': 'string', 'CreatedAt': datetime(2015, 1, 1), 'SubnetId': 'string', 'PreserveClientIp': True|False, 'SecurityGroupIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpAddressType': 'ipv4'|'dualstack'|'ipv6' }, ], } **Response Structure** * *(dict) --* * **InstanceConnectEndpoints** *(list) --* Information about the EC2 Instance Connect Endpoints. * *(dict) --* The EC2 Instance Connect Endpoint. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint. * **InstanceConnectEndpointId** *(string) --* The ID of the EC2 Instance Connect Endpoint. * **InstanceConnectEndpointArn** *(string) --* The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint. * **State** *(string) --* The current state of the EC2 Instance Connect Endpoint. * **StateMessage** *(string) --* The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message. * **DnsName** *(string) --* The DNS name of the EC2 Instance Connect Endpoint. * **FipsDnsName** *(string) --* The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint. * **NetworkInterfaceIds** *(list) --* The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint. * *(string) --* * **VpcId** *(string) --* The ID of the VPC in which the EC2 Instance Connect Endpoint was created. * **AvailabilityZone** *(string) --* The Availability Zone of the EC2 Instance Connect Endpoint. * **CreatedAt** *(datetime) --* The date and time that the EC2 Instance Connect Endpoint was created. * **SubnetId** *(string) --* The ID of the subnet in which the EC2 Instance Connect Endpoint was created. * **PreserveClientIp** *(boolean) --* Indicates whether your client's IP address is preserved as the source. The value is "true" or "false". * If "true", your client's IP address is used when you connect to a resource. * If "false", the elastic network interface IP address is used when you connect to a resource. Default: "true" * **SecurityGroupIds** *(list) --* The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint. * *(string) --* * **Tags** *(list) --* The tags assigned to the EC2 Instance Connect Endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **IpAddressType** *(string) --* The IP address type of the endpoint. EC2 / Paginator / DescribeCapacityReservations DescribeCapacityReservations **************************** class EC2.Paginator.DescribeCapacityReservations paginator = client.get_paginator('describe_capacity_reservations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_capacity_reservations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CapacityReservationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CapacityReservationIds** (*list*) -- The ID of the Capacity Reservation. * *(string) --* * **Filters** (*list*) -- One or more filters. * "instance-type" - The type of instance for which the Capacity Reservation reserves capacity. * "owner-id" - The ID of the Amazon Web Services account that owns the Capacity Reservation. * "instance-platform" - The type of operating system for which the Capacity Reservation reserves capacity. * "availability-zone" - The Availability Zone 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services 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. * "placement-group-arn" - The ARN of the cluster placement group in which the Capacity Reservation was created. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityReservations': [ { 'CapacityReservationId': 'string', 'OwnerId': 'string', 'CapacityReservationArn': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'string', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'TotalInstanceCount': 123, 'AvailableInstanceCount': 123, 'EbsOptimized': True|False, 'EphemeralStorage': True|False, 'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'unavailable', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'EndDateType': 'unlimited'|'limited', 'InstanceMatchCriteria': 'open'|'targeted', 'CreateDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OutpostArn': 'string', 'CapacityReservationFleetId': 'string', 'PlacementGroupArn': 'string', 'CapacityAllocations': [ { 'AllocationType': 'used'|'future', 'Count': 123 }, ], 'ReservationType': 'default'|'capacity-block', 'UnusedReservationBillingOwnerId': 'string', 'CommitmentInfo': { 'CommittedInstanceCount': 123, 'CommitmentEndDate': datetime(2015, 1, 1) }, 'DeliveryPreference': 'fixed'|'incremental', 'CapacityBlockId': 'string' }, ] } **Response Structure** * *(dict) --* * **CapacityReservations** *(list) --* Information about the Capacity Reservations. * *(dict) --* Describes a Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the Capacity Reservation. * **CapacityReservationArn** *(string) --* The Amazon Resource Name (ARN) of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Reservation. * **InstanceType** *(string) --* The type of instance for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the capacity is reserved. * **Tenancy** *(string) --* 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **AvailableInstanceCount** *(integer) --* The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. * **EbsOptimized** *(boolean) --* 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. * **EphemeralStorage** *(boolean) --* *Deprecated.* * **State** *(string) --* The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: * "active" - The capacity is available for use. * "expired" - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. * "cancelled" - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. * "scheduled" - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. * "payment-pending" - (*Capacity Blocks*) The upfront payment has not been processed yet. * "payment-failed" - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. * "assessing" - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. * "delayed" - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. * "unsupported" - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future- dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. * **StartDate** *(datetime) --* The date and time at which the Capacity Reservation was started. * **EndDate** *(datetime) --* 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. * **EndDateType** *(string) --* 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. * **InstanceMatchCriteria** *(string) --* 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. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Tags** *(list) --* Any tags assigned to the Capacity Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. * **PlacementGroupArn** *(string) --* The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the *Amazon EC2 User Guide*. * **CapacityAllocations** *(list) --* Information about instance capacity usage. * *(dict) --* Information about instance capacity usage for a Capacity Reservation. * **AllocationType** *(string) --* The usage type. "used" indicates that the instance capacity is in use by instances that are running in the Capacity Reservation. * **Count** *(integer) --* The amount of instance capacity associated with the usage. For example a value of "4" indicates that instance capacity for 4 instances is currently in use. * **ReservationType** *(string) --* The type of Capacity Reservation. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned. * **CommitmentInfo** *(dict) --* Information about your commitment for a future-dated Capacity Reservation. * **CommittedInstanceCount** *(integer) --* The instance capacity that you committed to when you requested the future-dated Capacity Reservation. * **CommitmentEndDate** *(datetime) --* The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). You can't decrease the instance count or cancel the Capacity Reservation before this date and time. * **DeliveryPreference** *(string) --* The delivery method for a future-dated Capacity Reservation. "incremental" indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. EC2 / Paginator / DescribeAddressesAttribute DescribeAddressesAttribute ************************** class EC2.Paginator.DescribeAddressesAttribute paginator = client.get_paginator('describe_addresses_attribute') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_addresses_attribute()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AllocationIds=[ 'string', ], Attribute='domain-name', DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AllocationIds** (*list*) -- [EC2-VPC] The allocation IDs. * *(string) --* * **Attribute** (*string*) -- The attribute of the IP address. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Addresses': [ { 'PublicIp': 'string', 'AllocationId': 'string', 'PtrRecord': 'string', 'PtrRecordUpdate': { 'Value': 'string', 'Status': 'string', 'Reason': 'string' } }, ], } **Response Structure** * *(dict) --* * **Addresses** *(list) --* Information about the IP addresses. * *(dict) --* The attributes associated with an Elastic IP address. * **PublicIp** *(string) --* The public IP address. * **AllocationId** *(string) --* [EC2-VPC] The allocation ID. * **PtrRecord** *(string) --* The pointer (PTR) record for the IP address. * **PtrRecordUpdate** *(dict) --* The updated PTR record for the IP address. * **Value** *(string) --* The value for the PTR record update. * **Status** *(string) --* The status of the PTR record update. * **Reason** *(string) --* The reason for the PTR record update. EC2 / Paginator / DescribeFastLaunchImages DescribeFastLaunchImages ************************ class EC2.Paginator.DescribeFastLaunchImages paginator = client.get_paginator('describe_fast_launch_images') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_fast_launch_images()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ImageIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ImageIds** (*list*) -- Specify one or more Windows AMI image IDs for the request. * *(string) --* * **Filters** (*list*) -- Use the following filters to streamline results. * "resource-type" - The resource type for pre-provisioning. * "owner-id" - The owner ID for the pre-provisioning resource. * "state" - The current state of fast launching for the Windows AMI. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FastLaunchImages': [ { 'ImageId': 'string', 'ResourceType': 'snapshot', 'SnapshotConfiguration': { 'TargetResourceCount': 123 }, 'LaunchTemplate': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'MaxParallelLaunches': 123, 'OwnerId': 'string', 'State': 'enabling'|'enabling-failed'|'enabled'|'enabled-failed'|'disabling'|'disabling-failed', 'StateTransitionReason': 'string', 'StateTransitionTime': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **FastLaunchImages** *(list) --* A collection of details about the fast-launch enabled Windows images that meet the requested criteria. * *(dict) --* Describe details about a Windows image with Windows fast launch enabled that meets the requested criteria. Criteria are defined by the "DescribeFastLaunchImages" action filters. * **ImageId** *(string) --* The image ID that identifies the Windows fast launch enabled image. * **ResourceType** *(string) --* The resource type that Amazon EC2 uses for pre- provisioning the Windows AMI. Supported values include: "snapshot". * **SnapshotConfiguration** *(dict) --* A group of parameters that are used for pre- provisioning the associated Windows AMI using snapshots. * **TargetResourceCount** *(integer) --* The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch enabled AMI. * **LaunchTemplate** *(dict) --* The launch template that the Windows fast launch enabled AMI uses when it launches Windows instances from pre-provisioned snapshots. * **LaunchTemplateId** *(string) --* The ID of the launch template that the AMI uses for Windows fast launch. * **LaunchTemplateName** *(string) --* The name of the launch template that the AMI uses for Windows fast launch. * **Version** *(string) --* The version of the launch template that the AMI uses for Windows fast launch. * **MaxParallelLaunches** *(integer) --* The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. * **OwnerId** *(string) --* The owner ID for the Windows fast launch enabled AMI. * **State** *(string) --* The current state of Windows fast launch for the specified Windows AMI. * **StateTransitionReason** *(string) --* The reason that Windows fast launch for the AMI changed to the current state. * **StateTransitionTime** *(datetime) --* The time that Windows fast launch for the AMI changed to the current state. EC2 / Paginator / DescribeIamInstanceProfileAssociations DescribeIamInstanceProfileAssociations ************************************** class EC2.Paginator.DescribeIamInstanceProfileAssociations paginator = client.get_paginator('describe_iam_instance_profile_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_iam_instance_profile_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AssociationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AssociationIds** (*list*) -- The IAM instance profile associations. * *(string) --* * **Filters** (*list*) -- The filters. * "instance-id" - The ID of the instance. * "state" - The state of the association ( "associating" | "associated" | "disassociating"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IamInstanceProfileAssociations': [ { 'AssociationId': 'string', 'InstanceId': 'string', 'IamInstanceProfile': { 'Arn': 'string', 'Id': 'string' }, 'State': 'associating'|'associated'|'disassociating'|'disassociated', 'Timestamp': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **IamInstanceProfileAssociations** *(list) --* Information about the IAM instance profile associations. * *(dict) --* Describes an association between an IAM instance profile and an instance. * **AssociationId** *(string) --* The ID of the association. * **InstanceId** *(string) --* The ID of the instance. * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. * **State** *(string) --* The state of the association. * **Timestamp** *(datetime) --* The time the IAM instance profile was associated with the instance. EC2 / Paginator / DescribeSpotPriceHistory DescribeSpotPriceHistory ************************ class EC2.Paginator.DescribeSpotPriceHistory paginator = client.get_paginator('describe_spot_price_history') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_spot_price_history()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), InstanceTypes=[ 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', ], ProductDescriptions=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], AvailabilityZone='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **StartTime** (*datetime*) -- 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*-*DD*T*HH*:*MM*:>>*<>*<>*<" - The key/value combination of a tag assigned to the event window. 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 "CMX", specify "tag:Owner" for the filter name and "CMX" for the filter value. * "tag-key" - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value. * "tag-value" - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceEventWindows': [ { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **InstanceEventWindows** *(list) --* Information about the event windows. * *(dict) --* The event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeSecurityGroupVpcAssociations DescribeSecurityGroupVpcAssociations ************************************ class EC2.Paginator.DescribeSecurityGroupVpcAssociations paginator = client.get_paginator('describe_security_group_vpc_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_security_group_vpc_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- Security group VPC association filters. * "group-id": The security group ID. * "group-owner-id": The group owner ID. * "vpc-id": The ID of the associated VPC. * "vpc-owner-id": The account ID of the VPC owner. * "state": The state of the association. * "tag:": 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SecurityGroupVpcAssociations': [ { 'GroupId': 'string', 'VpcId': 'string', 'VpcOwnerId': 'string', 'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed', 'StateReason': 'string', 'GroupOwnerId': 'string' }, ], } **Response Structure** * *(dict) --* * **SecurityGroupVpcAssociations** *(list) --* The security group VPC associations. * *(dict) --* A security group association with a VPC that you made with AssociateSecurityGroupVpc. * **GroupId** *(string) --* The association's security group ID. * **VpcId** *(string) --* The association's VPC ID. * **VpcOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the VPC. * **State** *(string) --* The association's state. * **StateReason** *(string) --* The association's state reason. * **GroupOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the security group. EC2 / Paginator / GetIpamPoolAllocations GetIpamPoolAllocations ********************** class EC2.Paginator.GetIpamPoolAllocations paginator = client.get_paginator('get_ipam_pool_allocations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_ipam_pool_allocations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, IpamPoolId='string', IpamPoolAllocationId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamPoolId** (*string*) -- **[REQUIRED]** The ID of the IPAM pool you want to see the allocations for. * **IpamPoolAllocationId** (*string*) -- The ID of the allocation. * **Filters** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'IpamPoolAllocations': [ { 'Cidr': 'string', 'IpamPoolAllocationId': 'string', 'Description': 'string', 'ResourceId': 'string', 'ResourceType': 'ipam-pool'|'vpc'|'ec2-public-ipv4-pool'|'custom'|'subnet'|'eip', 'ResourceRegion': 'string', 'ResourceOwner': 'string' }, ], } **Response Structure** * *(dict) --* * **IpamPoolAllocations** *(list) --* The IPAM pool allocations you want information on. * *(dict) --* In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. * **Cidr** *(string) --* The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is "10.24.34.0/23". An IPv6 CIDR example is "2001:DB8::/32". * **IpamPoolAllocationId** *(string) --* The ID of an allocation. * **Description** *(string) --* A description of the pool allocation. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of the resource. * **ResourceRegion** *(string) --* The Amazon Web Services Region of the resource. * **ResourceOwner** *(string) --* The owner of the resource. EC2 / Paginator / DescribeClientVpnConnections DescribeClientVpnConnections **************************** class EC2.Paginator.DescribeClientVpnConnections paginator = client.get_paginator('describe_client_vpn_connections') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_client_vpn_connections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClientVpnEndpointId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Connections': [ { 'ClientVpnEndpointId': 'string', 'Timestamp': 'string', 'ConnectionId': 'string', 'Username': 'string', 'ConnectionEstablishedTime': 'string', 'IngressBytes': 'string', 'EgressBytes': 'string', 'IngressPackets': 'string', 'EgressPackets': 'string', 'ClientIp': 'string', 'CommonName': 'string', 'Status': { 'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated', 'Message': 'string' }, 'ConnectionEndTime': 'string', 'PostureComplianceStatuses': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **Connections** *(list) --* Information about the active and terminated client connections. * *(dict) --* Describes a client connection. * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint to which the client is connected. * **Timestamp** *(string) --* The current date and time. * **ConnectionId** *(string) --* The ID of the client connection. * **Username** *(string) --* The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used. * **ConnectionEstablishedTime** *(string) --* The date and time the client connection was established. * **IngressBytes** *(string) --* The number of bytes sent by the client. * **EgressBytes** *(string) --* The number of bytes received by the client. * **IngressPackets** *(string) --* The number of packets sent by the client. * **EgressPackets** *(string) --* The number of packets received by the client. * **ClientIp** *(string) --* The IP address of the client. * **CommonName** *(string) --* The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name. * **Status** *(dict) --* The current state of the client connection. * **Code** *(string) --* The state of the client connection. * **Message** *(string) --* A message about the status of the client connection, if applicable. * **ConnectionEndTime** *(string) --* The date and time the client connection was terminated. * **PostureComplianceStatuses** *(list) --* The statuses returned by the client connect handler for posture compliance, if applicable. * *(string) --* EC2 / Paginator / DescribeLaunchTemplateVersions DescribeLaunchTemplateVersions ****************************** class EC2.Paginator.DescribeLaunchTemplateVersions paginator = client.get_paginator('describe_launch_template_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_launch_template_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, LaunchTemplateId='string', LaunchTemplateName='string', Versions=[ 'string', ], MinVersion='string', MaxVersion='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ResolveAlias=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- 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, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. * **LaunchTemplateName** (*string*) -- The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. * **Versions** (*list*) -- 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 request. You cannot specify numbers. * *(string) --* * **MinVersion** (*string*) -- The version number after which to describe launch template versions. * **MaxVersion** (*string*) -- The version number up to which to describe launch template versions. * **Filters** (*list*) -- 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. * "http-endpoint" - Indicates whether the HTTP metadata endpoint on your instances is enabled ( "enabled" | "disabled"). * "http-protocol-ipv4" - Indicates whether the IPv4 endpoint for the instance metadata service is enabled ( "enabled" | "disabled"). * "host-resource-group-arn" - The ARN of the host resource group in which to launch the instances. * "http-tokens" - The state of token usage for your instance metadata requests ( "optional" | "required"). * "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. * "license-configuration-arn" - The ARN of the license configuration. * "network-card-index" - The index of the network card. * "ram-disk-id" - The RAM disk ID. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ResolveAlias** (*boolean*) -- If "true", and if a Systems Manager parameter is specified for "ImageId", the AMI ID is displayed in the response for "imageId". If "false", and if a Systems Manager parameter is specified for "ImageId", the parameter is displayed in the response for "imageId". For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. Default: "false" * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LaunchTemplateVersions': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'VersionNumber': 123, 'VersionDescription': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersion': True|False, 'LaunchTemplateData': { 'KernelId': 'string', 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'Throughput': 123, 'VolumeInitializationRate': 123 }, 'NoDevice': 'string' }, ], 'NetworkInterfaces': [ { 'AssociateCarrierIpAddress': True|False, 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'InterfaceType': 'string', 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpTimeout': 123, 'UdpStreamTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'Placement': { 'AvailabilityZone': 'string', 'Affinity': 'string', 'GroupName': 'string', 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'PartitionNumber': 123, 'GroupId': 'string' }, 'RamDiskId': 'string', 'DisableApiTermination': True|False, 'InstanceInitiatedShutdownBehavior': 'stop'|'terminate', 'UserData': 'string', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'ElasticGpuSpecifications': [ { 'Type': 'string' }, ], 'ElasticInferenceAccelerators': [ { 'Type': 'string', 'Count': 123 }, ], 'SecurityGroupIds': [ 'string', ], 'SecurityGroups': [ 'string', ], 'InstanceMarketOptions': { 'MarketType': 'spot'|'capacity-block', 'SpotOptions': { 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'BlockDurationMinutes': 123, 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' } }, 'CreditSpecification': { 'CpuCredits': 'string' }, 'CpuOptions': { 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'LicenseSpecifications': [ { 'LicenseConfigurationArn': 'string' }, ], 'HibernationOptions': { 'Configured': True|False }, 'MetadataOptions': { 'State': 'pending'|'applied', 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, 'EnclaveOptions': { 'Enabled': True|False }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'MaintenanceOptions': { 'AutoRecovery': 'default'|'disabled' }, 'DisableApiStop': True|False, 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'NetworkPerformanceOptions': { 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' } }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], } **Response Structure** * *(dict) --* * **LaunchTemplateVersions** *(list) --* Information about the launch template versions. * *(dict) --* Describes a launch template version. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **VersionNumber** *(integer) --* The version number. * **VersionDescription** *(string) --* The description for the version. * **CreateTime** *(datetime) --* The time the version was created. * **CreatedBy** *(string) --* The principal that created the version. * **DefaultVersion** *(boolean) --* Indicates whether the version is the default version. * **LaunchTemplateData** *(dict) --* Information about the launch template. * **KernelId** *(string) --* The ID of the kernel, if applicable. * **EbsOptimized** *(boolean) --* Indicates whether the instance is optimized for Amazon EBS I/O. * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **BlockDeviceMappings** *(list) --* The block device mappings. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name. * **VirtualName** *(string) --* The virtual device name (ephemeralN). * **Ebs** *(dict) --* Information about the block device for an EBS volume. * **Encrypted** *(boolean) --* Indicates whether the EBS volume is encrypted. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **Iops** *(integer) --* The number of I/O operations per second (IOPS) that the volume supports. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiB. * **VolumeType** *(string) --* The volume type. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **VolumeInitializationRate** *(integer) --* The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. If no volume initialization rate was specified, the value is "null". * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. * **NetworkInterfaces** *(list) --* The network interfaces. * *(dict) --* Describes a network interface. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to associate a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP address in the *Wavelength Developer Guide*. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to associate a public IPv4 address with eth0 for a new network interface. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **Description** *(string) --* A description for the network interface. * **DeviceIndex** *(integer) --* The device index for the network interface attachment. * **Groups** *(list) --* The IDs of one or more security groups. * *(string) --* * **InterfaceType** *(string) --* The type of network interface. * **Ipv6AddressCount** *(integer) --* The number of IPv6 addresses for the network interface. * **Ipv6Addresses** *(list) --* The IPv6 addresses for the network interface. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **PrivateIpAddress** *(string) --* The primary private IPv4 address of the network interface. * **PrivateIpAddresses** *(list) --* One or more private IPv4 addresses. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses for the network interface. * **SubnetId** *(string) --* The ID of the subnet for the network interface. * **NetworkCardIndex** *(integer) --* The index of the network card. * **Ipv4Prefixes** *(list) --* One or more IPv4 prefixes assigned to the network interface. * *(dict) --* Information about the IPv4 delegated prefixes assigned to a network interface. * **Ipv4Prefix** *(string) --* The IPv4 delegated prefixes assigned to the network interface. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. * **Ipv6Prefixes** *(list) --* One or more IPv6 prefixes assigned to the network interface. * *(dict) --* Information about the IPv6 delegated prefixes assigned to a network interface. * **Ipv6Prefix** *(string) --* The IPv6 delegated prefixes assigned to the network interface. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Contains the ENA Express settings for instances launched from your launch template. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **ImageId** *(string) --* The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch. The value depends on what you specified in the request. The possible values are: * If an AMI ID was specified in the request, then this is the AMI ID. * If a Systems Manager parameter was specified in the request, and "ResolveAlias" was configured as "true", then this is the AMI ID that the parameter is mapped to in the Parameter Store. * If a Systems Manager parameter was specified in the request, and "ResolveAlias" was configured as "false", then this is the parameter value. For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. * **InstanceType** *(string) --* The instance type. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* The monitoring for the instance. * **Enabled** *(boolean) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **Placement** *(dict) --* The placement of the instance. * **AvailabilityZone** *(string) --* The Availability Zone of the instance. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. * **GroupName** *(string) --* The name of the placement group for the instance. * **HostId** *(string) --* The ID of the Dedicated Host for the instance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. * **PartitionNumber** *(integer) --* The number of the partition the instance should launch in. Valid only if the placement group strategy is set to "partition". * **GroupId** *(string) --* The Group ID of the placement group. You must specify the Placement Group **Group ID** to launch an instance in a shared placement group. * **RamDiskId** *(string) --* The ID of the RAM disk, if applicable. * **DisableApiTermination** *(boolean) --* If set to "true", indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API. * **InstanceInitiatedShutdownBehavior** *(string) --* Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). * **UserData** *(string) --* The user data for the instance. * **TagSpecifications** *(list) --* The tags that are applied to the resources that are created during instance launch. * *(dict) --* The tags specification for the launch template. * **ResourceType** *(string) --* The type of resource to tag. * **Tags** *(list) --* The tags for the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ElasticGpuSpecifications** *(list) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * **Type** *(string) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * **ElasticInferenceAccelerators** *(list) --* Note: Amazon Elastic Inference is no longer available. 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. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes an elastic inference accelerator. * **Type** *(string) --* The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. * **Count** *(integer) --* The number of elastic inference accelerators to attach to the instance. Default: 1 * **SecurityGroupIds** *(list) --* The security group IDs. * *(string) --* * **SecurityGroups** *(list) --* The security group names. * *(string) --* * **InstanceMarketOptions** *(dict) --* The market (purchasing) option for the instances. * **MarketType** *(string) --* The market type. * **SpotOptions** *(dict) --* The options for Spot Instances. * **MaxPrice** *(string) --* The maximum hourly price you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. If you do specify this parameter, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message when the launch template is used to launch an instance. * **SpotInstanceType** *(string) --* The Spot Instance request type. * **BlockDurationMinutes** *(integer) --* 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). * **ValidUntil** *(datetime) --* The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. * **InstanceInterruptionBehavior** *(string) --* The behavior when a Spot Instance is interrupted. * **CreditSpecification** *(dict) --* The credit option for CPU usage of the instance. * **CpuCredits** *(string) --* The credit option for CPU usage of a T instance. Valid values: "standard" | "unlimited" * **CpuOptions** *(dict) --* The CPU options for the instance. For more information, see CPU options for Amazon EC2 instances in the *Amazon EC2 User Guide*. * **CoreCount** *(integer) --* The number of CPU cores for the instance. * **ThreadsPerCore** *(integer) --* The number of threads per CPU core. * **AmdSevSnp** *(string) --* Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP for Amazon EC2 instances. * **CapacityReservationSpecification** *(dict) --* Information about the Capacity Reservation targeting option. * **CapacityReservationPreference** *(string) --* Indicates the instance's Capacity Reservation preferences. Possible preferences include: * "open" - The instance can run in any "open" Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * "none" - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. * **CapacityReservationTarget** *(dict) --* Information about the target Capacity Reservation or Capacity Reservation group. * **CapacityReservationId** *(string) --* The ID of the targeted Capacity Reservation. * **CapacityReservationResourceGroupArn** *(string) --* The ARN of the targeted Capacity Reservation group. * **LicenseSpecifications** *(list) --* The license configurations. * *(dict) --* Describes a license configuration. * **LicenseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the license configuration. * **HibernationOptions** *(dict) --* Indicates whether an instance is configured for hibernation. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. * **Configured** *(boolean) --* If this parameter is set to "true", the instance is enabled for hibernation; otherwise, it is not enabled for hibernation. * **MetadataOptions** *(dict) --* The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the *Amazon EC2 User Guide*. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. * "required" - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. * **HttpPutResponseHopLimit** *(integer) --* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Default: 1 Possible values: Integers from 1 to 64 * **HttpEndpoint** *(string) --* Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is "enabled". Note: If you specify a value of "disabled", you will not be able to access your instance metadata. * **HttpProtocolIpv6** *(string) --* Enables or disables the IPv6 endpoint for the instance metadata service. Default: "disabled" * **InstanceMetadataTags** *(string) --* Set to "enabled" to allow access to instance tags from the instance metadata. Set to "disabled" to turn off access to instance tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata. Default: "disabled" * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify "InstanceRequirements", you can't specify "InstanceTypes". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "Ma xSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice ** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "Ma xSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **PrivateDnsNameOptions** *(dict) --* The options for the instance hostname. * **HostnameType** *(string) --* The type of hostname to assign to an instance. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * **MaintenanceOptions** *(dict) --* The maintenance options for your instance. * **AutoRecovery** *(string) --* Disables the automatic recovery behavior of your instance or sets it to default. * **DisableApiStop** *(boolean) --* Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances in the *Amazon EC2 User Guide*. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **NetworkPerformanceOptions** *(dict) --* Contains the launch template settings for network performance options for your instance. * **BandwidthWeighting** *(string) --* When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. EC2 / Paginator / DescribeClassicLinkInstances DescribeClassicLinkInstances **************************** class EC2.Paginator.DescribeClassicLinkInstances paginator = client.get_paginator('describe_classic_link_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_classic_link_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, InstanceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceIds** (*list*) -- The instance IDs. Must be instances linked to a VPC through ClassicLink. * *(string) --* * **Filters** (*list*) -- The filters. * "group-id" - The ID of a VPC security group that's associated with the instance. * "instance-id" - The ID of the instance. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'InstanceId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string' }, ], } **Response Structure** * *(dict) --* * **Instances** *(list) --* Information about one or more linked EC2-Classic instances. * *(dict) --* Note: Deprecated. Describes a linked EC2-Classic instance. * **Groups** *(list) --* The security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **InstanceId** *(string) --* The ID of the instance. * **Tags** *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC. EC2 / Paginator / DescribeTransitGatewayConnects DescribeTransitGatewayConnects ****************************** class EC2.Paginator.DescribeTransitGatewayConnects paginator = client.get_paginator('describe_transit_gateway_connects') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_connects()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayAttachmentIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayAttachmentIds** (*list*) -- The IDs of the attachments. * *(string) --* * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayConnects': [ { 'TransitGatewayAttachmentId': 'string', 'TransportTransitGatewayAttachmentId': 'string', 'TransitGatewayId': 'string', 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'CreationTime': datetime(2015, 1, 1), 'Options': { 'Protocol': 'gre' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayConnects** *(list) --* Information about the Connect attachments. * *(dict) --* Describes a transit gateway Connect attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the Connect attachment. * **TransportTransitGatewayAttachmentId** *(string) --* The ID of the attachment from which the Connect attachment was created. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the attachment. * **CreationTime** *(datetime) --* The creation time. * **Options** *(dict) --* The Connect attachment options. * **Protocol** *(string) --* The tunnel protocol. * **Tags** *(list) --* The tags for the attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeVpcEndpointServices DescribeVpcEndpointServices *************************** class EC2.Paginator.DescribeVpcEndpointServices paginator = client.get_paginator('describe_vpc_endpoint_services') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_endpoint_services()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, ServiceNames=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ServiceRegions=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ServiceNames** (*list*) -- The service names. * *(string) --* * **Filters** (*list*) -- The filters. * "owner" - The ID or alias of the Amazon Web Services account that owns the service. * "service-name" - The name of the service. * "service-region" - The Region of the service. * "service-type" - The type of service ( "Interface" | "Gateway" | "GatewayLoadBalancer"). * "supported-ip-address-types" - The IP address type ( "ipv4" | "ipv6"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ServiceRegions** (*list*) -- The service Regions. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ServiceNames': [ 'string', ], 'ServiceDetails': [ { 'ServiceName': 'string', 'ServiceId': 'string', 'ServiceType': [ { 'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer' }, ], 'ServiceRegion': 'string', 'AvailabilityZones': [ 'string', ], 'Owner': 'string', 'BaseEndpointDnsNames': [ 'string', ], 'PrivateDnsName': 'string', 'PrivateDnsNames': [ { 'PrivateDnsName': 'string' }, ], 'VpcEndpointPolicySupported': True|False, 'AcceptanceRequired': True|False, 'ManagesVpcEndpoints': True|False, 'PayerResponsibility': 'ServiceOwner', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed', 'SupportedIpAddressTypes': [ 'ipv4'|'ipv6', ] }, ], } **Response Structure** * *(dict) --* * **ServiceNames** *(list) --* The supported services. * *(string) --* * **ServiceDetails** *(list) --* Information about the service. * *(dict) --* Describes a VPC endpoint service. * **ServiceName** *(string) --* The name of the service. * **ServiceId** *(string) --* The ID of the endpoint service. * **ServiceType** *(list) --* The type of service. * *(dict) --* Describes the type of service for a VPC endpoint. * **ServiceType** *(string) --* The type of service. * **ServiceRegion** *(string) --* The Region where the service is hosted. * **AvailabilityZones** *(list) --* The Availability Zones in which the service is available. * *(string) --* * **Owner** *(string) --* The Amazon Web Services account ID of the service owner. * **BaseEndpointDnsNames** *(list) --* The DNS names for the service. * *(string) --* * **PrivateDnsName** *(string) --* The private DNS name for the service. * **PrivateDnsNames** *(list) --* The private DNS names assigned to the VPC endpoint service. * *(dict) --* Information about the Private DNS name for interface endpoints. * **PrivateDnsName** *(string) --* The private DNS name assigned to the VPC endpoint service. * **VpcEndpointPolicySupported** *(boolean) --* Indicates whether the service supports endpoint policies. * **AcceptanceRequired** *(boolean) --* Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. * **ManagesVpcEndpoints** *(boolean) --* Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. * **PayerResponsibility** *(string) --* The payer responsibility. * **Tags** *(list) --* The tags assigned to the service. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PrivateDnsNameVerificationState** *(string) --* The verification state of the VPC endpoint service. Consumers of the endpoint service cannot use the private name when the state is not "verified". * **SupportedIpAddressTypes** *(list) --* The supported IP address types. * *(string) --* EC2 / Paginator / DescribeClientVpnRoutes DescribeClientVpnRoutes *********************** class EC2.Paginator.DescribeClientVpnRoutes paginator = client.get_paginator('describe_client_vpn_routes') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_client_vpn_routes()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClientVpnEndpointId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Routes': [ { 'ClientVpnEndpointId': 'string', 'DestinationCidr': 'string', 'TargetSubnet': 'string', 'Type': 'string', 'Origin': 'string', 'Status': { 'Code': 'creating'|'active'|'failed'|'deleting', 'Message': 'string' }, 'Description': 'string' }, ], } **Response Structure** * *(dict) --* * **Routes** *(list) --* Information about the Client VPN endpoint routes. * *(dict) --* Information about a Client VPN endpoint route. * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint with which the route is associated. * **DestinationCidr** *(string) --* The IPv4 address range, in CIDR notation, of the route destination. * **TargetSubnet** *(string) --* The ID of the subnet through which traffic is routed. * **Type** *(string) --* The route type. * **Origin** *(string) --* Indicates how the route was associated with the Client VPN endpoint. "associate" indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. "add- route" indicates that the route was manually added using the **CreateClientVpnRoute** action. * **Status** *(dict) --* The current state of the route. * **Code** *(string) --* The state of the Client VPN endpoint route. * **Message** *(string) --* A message about the status of the Client VPN endpoint route, if applicable. * **Description** *(string) --* A brief description of the route. EC2 / Paginator / DescribeNetworkInsightsAccessScopeAnalyses DescribeNetworkInsightsAccessScopeAnalyses ****************************************** class EC2.Paginator.DescribeNetworkInsightsAccessScopeAnalyses paginator = client.get_paginator('describe_network_insights_access_scope_analyses') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_insights_access_scope_analyses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInsightsAccessScopeAnalysisIds=[ 'string', ], NetworkInsightsAccessScopeId='string', AnalysisStartTimeBegin=datetime(2015, 1, 1), AnalysisStartTimeEnd=datetime(2015, 1, 1), Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInsightsAccessScopeAnalysisIds** (*list*) -- The IDs of the Network Access Scope analyses. * *(string) --* * **NetworkInsightsAccessScopeId** (*string*) -- The ID of the Network Access Scope. * **AnalysisStartTimeBegin** (*datetime*) -- Filters the results based on the start time. The analysis must have started on or after this time. * **AnalysisStartTimeEnd** (*datetime*) -- Filters the results based on the start time. The analysis must have started on or before this time. * **Filters** (*list*) -- There are no supported filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAccessScopeAnalyses': [ { 'NetworkInsightsAccessScopeAnalysisId': 'string', 'NetworkInsightsAccessScopeAnalysisArn': 'string', 'NetworkInsightsAccessScopeId': 'string', 'Status': 'running'|'succeeded'|'failed', 'StatusMessage': 'string', 'WarningMessage': 'string', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'FindingsFound': 'true'|'false'|'unknown', 'AnalyzedEniCount': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **NetworkInsightsAccessScopeAnalyses** *(list) --* The Network Access Scope analyses. * *(dict) --* Describes a Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisId** *(string) --* The ID of the Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisArn** *(string) --* The Amazon Resource Name (ARN) of the Network Access Scope analysis. * **NetworkInsightsAccessScopeId** *(string) --* The ID of the Network Access Scope. * **Status** *(string) --* The status. * **StatusMessage** *(string) --* The status message. * **WarningMessage** *(string) --* The warning message. * **StartDate** *(datetime) --* The analysis start date. * **EndDate** *(datetime) --* The analysis end date. * **FindingsFound** *(string) --* Indicates whether there are findings. * **AnalyzedEniCount** *(integer) --* The number of network interfaces analyzed. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeClientVpnAuthorizationRules DescribeClientVpnAuthorizationRules *********************************** class EC2.Paginator.DescribeClientVpnAuthorizationRules paginator = client.get_paginator('describe_client_vpn_authorization_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_client_vpn_authorization_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ClientVpnEndpointId='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AuthorizationRules': [ { 'ClientVpnEndpointId': 'string', 'Description': 'string', 'GroupId': 'string', 'AccessAll': True|False, 'DestinationCidr': 'string', 'Status': { 'Code': 'authorizing'|'active'|'failed'|'revoking', 'Message': 'string' } }, ], } **Response Structure** * *(dict) --* * **AuthorizationRules** *(list) --* Information about the authorization rules. * *(dict) --* Information about an authorization rule. * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint with which the authorization rule is associated. * **Description** *(string) --* A brief description of the authorization rule. * **GroupId** *(string) --* The ID of the Active Directory group to which the authorization rule grants access. * **AccessAll** *(boolean) --* Indicates whether the authorization rule grants access to all clients. * **DestinationCidr** *(string) --* The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. * **Status** *(dict) --* The current state of the authorization rule. * **Code** *(string) --* The state of the authorization rule. * **Message** *(string) --* A message about the status of the authorization rule, if applicable. EC2 / Paginator / DescribeTransitGatewayPeeringAttachments DescribeTransitGatewayPeeringAttachments **************************************** class EC2.Paginator.DescribeTransitGatewayPeeringAttachments paginator = client.get_paginator('describe_transit_gateway_peering_attachments') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_peering_attachments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayAttachmentIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayAttachmentIds** (*list*) -- One or more IDs of the transit gateway peering attachments. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account. * "remote-owner-id" - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway. * "state" - The state of the peering attachment. Valid values are "available" | "deleted" | "deleting" | "failed" | "failing" | "initiatingRequest" | "modifying" | "pendingAcceptance" | "pending" | "rollingBack" | "rejected" | "rejecting"). * "tag": - 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. * "transit-gateway-id" - The ID of the transit gateway. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayPeeringAttachments': [ { 'TransitGatewayAttachmentId': 'string', 'AccepterTransitGatewayAttachmentId': 'string', 'RequesterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'AccepterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'Options': { 'DynamicRouting': 'enable'|'disable' }, 'Status': { 'Code': 'string', 'Message': 'string' }, 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayPeeringAttachments** *(list) --* The transit gateway peering attachments. * *(dict) --* Describes the transit gateway peering attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway peering attachment. * **AccepterTransitGatewayAttachmentId** *(string) --* The ID of the accepter transit gateway attachment. * **RequesterTgwInfo** *(dict) --* Information about the requester transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **AccepterTgwInfo** *(dict) --* Information about the accepter transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **Options** *(dict) --* Details about the transit gateway peering attachment. * **DynamicRouting** *(string) --* Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment. * **Status** *(dict) --* The status of the transit gateway peering attachment. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message, if applicable. * **State** *(string) --* The state of the transit gateway peering attachment. Note that the "initiating" state has been deprecated. * **CreationTime** *(datetime) --* The time the transit gateway peering attachment was created. * **Tags** *(list) --* The tags for the transit gateway peering attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeStoreImageTasks DescribeStoreImageTasks *********************** class EC2.Paginator.DescribeStoreImageTasks paginator = client.get_paginator('describe_store_image_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_store_image_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ImageIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ImageIds** (*list*) -- The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. Note: When you specify the "ImageIds" parameter, any filters that you specify are ignored. To use the filters, you must remove the "ImageIds" parameter. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'StoreImageTaskResults': [ { 'AmiId': 'string', 'TaskStartTime': datetime(2015, 1, 1), 'Bucket': 'string', 'S3objectKey': 'string', 'ProgressPercentage': 123, 'StoreTaskState': 'string', 'StoreTaskFailureReason': 'string' }, ], } **Response Structure** * *(dict) --* * **StoreImageTaskResults** *(list) --* The information about the AMI store tasks. * *(dict) --* The information about the AMI store task, including the progress of the task. * **AmiId** *(string) --* The ID of the AMI that is being stored. * **TaskStartTime** *(datetime) --* The time the task started. * **Bucket** *(string) --* The name of the Amazon S3 bucket that contains the stored AMI object. * **S3objectKey** *(string) --* The name of the stored AMI object in the bucket. * **ProgressPercentage** *(integer) --* The progress of the task as a percentage. * **StoreTaskState** *(string) --* The state of the store task ( "InProgress", "Completed", or "Failed"). * **StoreTaskFailureReason** *(string) --* If the tasks fails, the reason for the failure is returned. If the task succeeds, "null" is returned. EC2 / Paginator / DescribeVolumeStatus DescribeVolumeStatus ******************** class EC2.Paginator.DescribeVolumeStatus paginator = client.get_paginator('describe_volume_status') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_volume_status()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VolumeIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VolumeIds** (*list*) -- The IDs of the volumes. Default: Describes all your volumes. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 the instance. * "event.description" - A description of the event. * "event.event-id" - The event ID. * "event.event-type" - The event type (for "io-enabled": "passed" | "failed"; for "io-performance": "io- performance:degraded" | "io-performance:severely- degraded" | "io-performance:stalled"). * "event.not-after" - The latest end time for the event. * "event.not-before" - The earliest start time for the event. * "volume-status.details-name" - The cause for "volume- status.status" ( "io-enabled" | "io-performance"). * "volume-status.details-status" - The status of "volume- status.details-name" (for "io-enabled": "passed" | "failed"; for "io-performance": "normal" | "degraded" | "severely-degraded" | "stalled"). * "volume-status.status" - The status of the volume ( "ok" | "impaired" | "warning" | "insufficient-data"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VolumeStatuses': [ { 'Actions': [ { 'Code': 'string', 'Description': 'string', 'EventId': 'string', 'EventType': 'string' }, ], 'AvailabilityZone': 'string', 'OutpostArn': 'string', 'Events': [ { 'Description': 'string', 'EventId': 'string', 'EventType': 'string', 'NotAfter': datetime(2015, 1, 1), 'NotBefore': datetime(2015, 1, 1), 'InstanceId': 'string' }, ], 'VolumeId': 'string', 'VolumeStatus': { 'Details': [ { 'Name': 'io-enabled'|'io-performance'|'initialization-state', 'Status': 'string' }, ], 'Status': 'ok'|'impaired'|'insufficient-data' }, 'AttachmentStatuses': [ { 'IoPerformance': 'string', 'InstanceId': 'string' }, ], 'InitializationStatusDetails': { 'InitializationType': 'default'|'provisioned-rate', 'Progress': 123, 'EstimatedTimeToCompleteInSeconds': 123 }, 'AvailabilityZoneId': 'string' }, ] } **Response Structure** * *(dict) --* * **VolumeStatuses** *(list) --* Information about the status of the volumes. * *(dict) --* Describes the volume status. * **Actions** *(list) --* The details of the operation. * *(dict) --* Describes a volume status operation code. * **Code** *(string) --* The code identifying the operation, for example, "enable-volume-io". * **Description** *(string) --* A description of the operation. * **EventId** *(string) --* The ID of the event associated with this operation. * **EventType** *(string) --* The event type associated with this operation. * **AvailabilityZone** *(string) --* The Availability Zone of the volume. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **Events** *(list) --* A list of events associated with the volume. * *(dict) --* Describes a volume status event. * **Description** *(string) --* A description of the event. * **EventId** *(string) --* The ID of this event. * **EventType** *(string) --* The type of this event. * **NotAfter** *(datetime) --* The latest end time of the event. * **NotBefore** *(datetime) --* The earliest start time of the event. * **InstanceId** *(string) --* The ID of the instance associated with the event. * **VolumeId** *(string) --* The volume ID. * **VolumeStatus** *(dict) --* The volume status. * **Details** *(list) --* The details of the volume status. * *(dict) --* Describes a volume status. * **Name** *(string) --* The name of the volume status. * "io-enabled" - Indicates the volume I/O status. For more information, see Amazon EBS volume status checks. * "io-performance" - Indicates the volume performance status. For more information, see Amazon EBS volume status checks. * "initialization-state" - Indicates the status of the volume initialization process. For more information, see Initialize Amazon EBS volumes. * **Status** *(string) --* The intended status of the volume status. * **Status** *(string) --* The status of the volume. * **AttachmentStatuses** *(list) --* Information about the instances to which the volume is attached. * *(dict) --* Information about the instances to which the volume is attached. * **IoPerformance** *(string) --* The maximum IOPS supported by the attached instance. * **InstanceId** *(string) --* The ID of the attached instance. * **InitializationStatusDetails** *(dict) --* Information about the volume initialization. It can take up to 5 minutes for the volume initialization information to be updated. Only available for volumes created from snapshots. Not available for empty volumes created without a snapshot. For more information, see Initialize Amazon EBS volumes. * **InitializationType** *(string) --* The method used for volume initialization. Possible values include: * "default" - Volume initialized using the default volume initialization rate or fast snapshot restore. * "provisioned-rate" - Volume initialized using an Amazon EBS Provisioned Rate for Volume Initialization. * **Progress** *(integer) --* The current volume initialization progress as a percentage (0-100). Returns "100" when volume initialization has completed. * **EstimatedTimeToCompleteInSeconds** *(integer) --* The estimated remaining time, in seconds, for volume initialization to complete. Returns "0" when volume initialization has completed. Only available for volumes created with Amazon EBS Provisioned Rate for Volume Initialization. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. EC2 / Paginator / DescribeTrafficMirrorFilters DescribeTrafficMirrorFilters **************************** class EC2.Paginator.DescribeTrafficMirrorFilters paginator = client.get_paginator('describe_traffic_mirror_filters') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_traffic_mirror_filters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TrafficMirrorFilterIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TrafficMirrorFilterIds** (*list*) -- The ID of the Traffic Mirror filter. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TrafficMirrorFilters': [ { 'TrafficMirrorFilterId': 'string', 'IngressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'EgressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NetworkServices': [ 'amazon-dns', ], 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TrafficMirrorFilters** *(list) --* Information about one or more Traffic Mirror filters. * *(dict) --* Describes the Traffic Mirror filter. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter. * **IngressFilterRules** *(list) --* Information about the ingress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **EgressFilterRules** *(list) --* Information about the egress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NetworkServices** *(list) --* The network service traffic that is associated with the Traffic Mirror filter. * *(string) --* * **Description** *(string) --* The description of the Traffic Mirror filter. * **Tags** *(list) --* The tags assigned to the Traffic Mirror filter. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeTransitGatewayAttachments DescribeTransitGatewayAttachments ********************************* class EC2.Paginator.DescribeTransitGatewayAttachments paginator = client.get_paginator('describe_transit_gateway_attachments') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_attachments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayAttachmentIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayAttachmentIds** (*list*) -- The IDs of the attachments. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services 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 Amazon Web Services account that owns the transit gateway. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayAttachments': [ { 'TransitGatewayAttachmentId': 'string', 'TransitGatewayId': 'string', 'TransitGatewayOwnerId': 'string', 'ResourceOwnerId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceId': 'string', 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'Association': { 'TransitGatewayRouteTableId': 'string', 'State': 'associating'|'associated'|'disassociating'|'disassociated' }, 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayAttachments** *(list) --* Information about the attachments. * *(dict) --* Describes an attachment between a resource and a transit gateway. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **TransitGatewayOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **ResourceId** *(string) --* The ID of the resource. * **State** *(string) --* The attachment state. Note that the "initiating" state has been deprecated. * **Association** *(dict) --* The association. * **TransitGatewayRouteTableId** *(string) --* The ID of the route table for the transit gateway. * **State** *(string) --* The state of the association. * **CreationTime** *(datetime) --* The creation time. * **Tags** *(list) --* The tags for the attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / GetInstanceTypesFromInstanceRequirements GetInstanceTypesFromInstanceRequirements **************************************** class EC2.Paginator.GetInstanceTypesFromInstanceRequirements paginator = client.get_paginator('get_instance_types_from_instance_requirements') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_instance_types_from_instance_requirements()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, ArchitectureTypes=[ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], VirtualizationTypes=[ 'hvm'|'paravirtual', ], InstanceRequirements={ 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, Context='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ArchitectureTypes** (*list*) -- **[REQUIRED]** The processor architecture type. * *(string) --* * **VirtualizationTypes** (*list*) -- **[REQUIRED]** The virtualization type. * *(string) --* * **InstanceRequirements** (*dict*) -- **[REQUIRED]** The attributes required for the instance types. * **VCpuCount** *(dict) --* **[REQUIRED]** The minimum and maximum number of vCPUs. * **Min** *(integer) --* **[REQUIRED]** The minimum number of vCPUs. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum number of vCPUs. To specify no maximum limit, omit this parameter. * **MemoryMiB** *(dict) --* **[REQUIRED]** The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* **[REQUIRED]** The minimum amount of memory, in MiB. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance family, type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per- instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On- Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To indicate no price protection threshold, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of network interfaces. To specify no maximum limit, omit this parameter. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set "Max" to "0". * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **Context** (*string*) -- Reserved. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'string' }, ], } **Response Structure** * *(dict) --* * **InstanceTypes** *(list) --* The instance types with the specified instance attributes. * *(dict) --* The list of instance types with the specified instance attributes. * **InstanceType** *(string) --* The matching instance type. EC2 / Paginator / GetIpamAddressHistory GetIpamAddressHistory ********************* class EC2.Paginator.GetIpamAddressHistory paginator = client.get_paginator('get_ipam_address_history') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_ipam_address_history()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Cidr='string', IpamScopeId='string', VpcId='string', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Cidr** (*string*) -- **[REQUIRED]** The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR. * **IpamScopeId** (*string*) -- **[REQUIRED]** The ID of the IPAM scope that the CIDR is in. * **VpcId** (*string*) -- The ID of the VPC you want your history records filtered by. * **StartTime** (*datetime*) -- The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime. * **EndTime** (*datetime*) -- The end of the time period for which you are looking for history. If you omit this option, it will default to the current time. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'HistoryRecords': [ { 'ResourceOwnerId': 'string', 'ResourceRegion': 'string', 'ResourceType': 'eip'|'vpc'|'subnet'|'network-interface'|'instance', 'ResourceId': 'string', 'ResourceCidr': 'string', 'ResourceName': 'string', 'ResourceComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored', 'ResourceOverlapStatus': 'overlapping'|'nonoverlapping'|'ignored', 'VpcId': 'string', 'SampledStartTime': datetime(2015, 1, 1), 'SampledEndTime': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **HistoryRecords** *(list) --* A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface. * *(dict) --* The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the *Amazon VPC IPAM User Guide*. * **ResourceOwnerId** *(string) --* The ID of the resource owner. * **ResourceRegion** *(string) --* The Amazon Web Services Region of the resource. * **ResourceType** *(string) --* The type of the resource. * **ResourceId** *(string) --* The ID of the resource. * **ResourceCidr** *(string) --* The CIDR of the resource. * **ResourceName** *(string) --* The name of the resource. * **ResourceComplianceStatus** *(string) --* The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **ResourceOverlapStatus** *(string) --* The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **VpcId** *(string) --* The VPC ID of the resource. * **SampledStartTime** *(datetime) --* Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time. * **SampledEndTime** *(datetime) --* Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time. EC2 / Paginator / DescribeVerifiedAccessInstanceLoggingConfigurations DescribeVerifiedAccessInstanceLoggingConfigurations *************************************************** class EC2.Paginator.DescribeVerifiedAccessInstanceLoggingConfigurations paginator = client.get_paginator('describe_verified_access_instance_logging_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from " EC2.Client.describe_verified_access_instance_logging_configurat ions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VerifiedAccessInstanceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VerifiedAccessInstanceIds** (*list*) -- The IDs of the Verified Access instances. * *(string) --* * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LoggingConfigurations': [ { 'VerifiedAccessInstanceId': 'string', 'AccessLogs': { 'S3': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'BucketName': 'string', 'Prefix': 'string', 'BucketOwner': 'string' }, 'CloudWatchLogs': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'LogGroup': 'string' }, 'KinesisDataFirehose': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'DeliveryStream': 'string' }, 'LogVersion': 'string', 'IncludeTrustContext': True|False } }, ], } **Response Structure** * *(dict) --* * **LoggingConfigurations** *(list) --* The logging configuration for the Verified Access instances. * *(dict) --* Describes logging options for an Amazon Web Services Verified Access instance. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **AccessLogs** *(dict) --* Details about the logging options. * **S3** *(dict) --* Amazon S3 logging options. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **BucketName** *(string) --* The bucket name. * **Prefix** *(string) --* The bucket prefix. * **BucketOwner** *(string) --* The Amazon Web Services account number that owns the bucket. * **CloudWatchLogs** *(dict) --* CloudWatch Logs logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status for access logs. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **LogGroup** *(string) --* The ID of the CloudWatch Logs log group. * **KinesisDataFirehose** *(dict) --* Kinesis logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **DeliveryStream** *(string) --* The ID of the delivery stream. * **LogVersion** *(string) --* The log version. * **IncludeTrustContext** *(boolean) --* Indicates whether trust data is included in the logs. EC2 / Paginator / DescribeVpcEndpointConnectionNotifications DescribeVpcEndpointConnectionNotifications ****************************************** class EC2.Paginator.DescribeVpcEndpointConnectionNotifications paginator = client.get_paginator('describe_vpc_endpoint_connection_notifications') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_endpoint_connection_notifications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, ConnectionNotificationId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConnectionNotificationId** (*string*) -- The ID of the notification. * **Filters** (*list*) -- The 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConnectionNotificationSet': [ { 'ConnectionNotificationId': 'string', 'ServiceId': 'string', 'VpcEndpointId': 'string', 'ConnectionNotificationType': 'Topic', 'ConnectionNotificationArn': 'string', 'ConnectionEvents': [ 'string', ], 'ConnectionNotificationState': 'Enabled'|'Disabled', 'ServiceRegion': 'string' }, ], } **Response Structure** * *(dict) --* * **ConnectionNotificationSet** *(list) --* The notifications. * *(dict) --* Describes a connection notification for a VPC endpoint or VPC endpoint service. * **ConnectionNotificationId** *(string) --* The ID of the notification. * **ServiceId** *(string) --* The ID of the endpoint service. * **VpcEndpointId** *(string) --* The ID of the VPC endpoint. * **ConnectionNotificationType** *(string) --* The type of notification. * **ConnectionNotificationArn** *(string) --* The ARN of the SNS topic for the notification. * **ConnectionEvents** *(list) --* The events for the notification. Valid values are "Accept", "Connect", "Delete", and "Reject". * *(string) --* * **ConnectionNotificationState** *(string) --* The state of the notification. * **ServiceRegion** *(string) --* The Region for the endpoint service. EC2 / Paginator / DescribeScheduledInstanceAvailability DescribeScheduledInstanceAvailability ************************************* class EC2.Paginator.DescribeScheduledInstanceAvailability paginator = client.get_paginator('describe_scheduled_instance_availability') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_scheduled_instance_availability()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], FirstSlotStartTimeRange={ 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, MaxSlotDurationInHours=123, MinSlotDurationInHours=123, Recurrence={ 'Frequency': 'string', 'Interval': 123, 'OccurrenceDays': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "availability-zone" - The Availability Zone (for example, "us-west-2a"). * "instance-type" - The instance type (for example, "c4.large"). * "platform" - The platform ( "Linux/UNIX" or "Windows"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **FirstSlotStartTimeRange** (*dict*) -- **[REQUIRED]** The time period for the first schedule to start. * **EarliestTime** *(datetime) --* **[REQUIRED]** The earliest date and time, in UTC, for the Scheduled Instance to start. * **LatestTime** *(datetime) --* **[REQUIRED]** The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future. * **MaxSlotDurationInHours** (*integer*) -- The maximum available duration, in hours. This value must be greater than "MinSlotDurationInHours" and less than 1,720. * **MinSlotDurationInHours** (*integer*) -- 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. * **Recurrence** (*dict*) -- **[REQUIRED]** The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "Frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDays** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day. * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule. * **OccurrenceUnit** *(string) --* The unit for "OccurrenceDays" ( "DayOfWeek" or "DayOfMonth"). This value is required for a monthly schedule. You can't specify "DayOfWeek" with a weekly schedule. You can't specify this value with a daily schedule. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ScheduledInstanceAvailabilitySet': [ { 'AvailabilityZone': 'string', 'AvailableInstanceCount': 123, 'FirstSlotStartTime': datetime(2015, 1, 1), 'HourlyPrice': 'string', 'InstanceType': 'string', 'MaxTermDurationInDays': 123, 'MinTermDurationInDays': 123, 'NetworkPlatform': 'string', 'Platform': 'string', 'PurchaseToken': 'string', 'Recurrence': { 'Frequency': 'string', 'Interval': 123, 'OccurrenceDaySet': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' }, 'SlotDurationInHours': 123, 'TotalScheduledInstanceHours': 123 }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeScheduledInstanceAvailability. * **ScheduledInstanceAvailabilitySet** *(list) --* Information about the available Scheduled Instances. * *(dict) --* Describes a schedule that is available for your Scheduled Instances. * **AvailabilityZone** *(string) --* The Availability Zone. * **AvailableInstanceCount** *(integer) --* The number of available instances. * **FirstSlotStartTime** *(datetime) --* The time period for the first schedule to start. * **HourlyPrice** *(string) --* The hourly price for a single instance. * **InstanceType** *(string) --* The instance type. You can specify one of the C3, C4, M4, or R3 instance types. * **MaxTermDurationInDays** *(integer) --* The maximum term. The only possible value is 365 days. * **MinTermDurationInDays** *(integer) --* The minimum term. The only possible value is 365 days. * **NetworkPlatform** *(string) --* The network platform. * **Platform** *(string) --* The platform ( "Linux/UNIX" or "Windows"). * **PurchaseToken** *(string) --* The purchase token. This token expires in two hours. * **Recurrence** *(dict) --* The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDaySet** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. * **OccurrenceUnit** *(string) --* The unit for "occurrenceDaySet" ( "DayOfWeek" or "DayOfMonth"). * **SlotDurationInHours** *(integer) --* The number of hours in the schedule. * **TotalScheduledInstanceHours** *(integer) --* The total number of hours for a single instance for the entire term. EC2 / Paginator / GetSpotPlacementScores GetSpotPlacementScores ********************** class EC2.Paginator.GetSpotPlacementScores paginator = client.get_paginator('get_spot_placement_scores') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_spot_placement_scores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( InstanceTypes=[ 'string', ], TargetCapacity=123, TargetCapacityUnitType='vcpu'|'memory-mib'|'units', SingleAvailabilityZone=True|False, RegionNames=[ 'string', ], InstanceRequirementsWithMetadata={ 'ArchitectureTypes': [ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], 'VirtualizationTypes': [ 'hvm'|'paravirtual', ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **InstanceTypes** (*list*) -- The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an "m3.xlarge" with and without instance storage), the returned placement score will always be low. If you specify "InstanceTypes", you can't specify "InstanceRequirementsWithMetadata". * *(string) --* * **TargetCapacity** (*integer*) -- **[REQUIRED]** The target capacity. * **TargetCapacityUnitType** (*string*) -- The unit for the target capacity. * **SingleAvailabilityZone** (*boolean*) -- Specify "true" so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions. A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone. * **RegionNames** (*list*) -- The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, "us- east-1". * *(string) --* * **InstanceRequirementsWithMetadata** (*dict*) -- The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify "InstanceRequirementsWithMetadata", you can't specify "InstanceTypes". * **ArchitectureTypes** *(list) --* The architecture type. * *(string) --* * **VirtualizationTypes** *(list) --* The virtualization type. * *(string) --* * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. * **VCpuCount** *(dict) --* **[REQUIRED]** The minimum and maximum number of vCPUs. * **Min** *(integer) --* **[REQUIRED]** The minimum number of vCPUs. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum number of vCPUs. To specify no maximum limit, omit this parameter. * **MemoryMiB** *(dict) --* **[REQUIRED]** The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* **[REQUIRED]** The minimum amount of memory, in MiB. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance family, type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To indicate no price protection threshold, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of network interfaces. To specify no maximum limit, omit this parameter. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set "Max" to "0". * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in- 32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SpotPlacementScores': [ { 'Region': 'string', 'AvailabilityZoneId': 'string', 'Score': 123 }, ], } **Response Structure** * *(dict) --* * **SpotPlacementScores** *(list) --* The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity *at the time of the Spot placement score request*. A score of "10" means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone. If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the "capacity-optimized" allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the "capacity- optimized" allocation strategy. Different Regions or Availability Zones might return the same score. Note: The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled. * *(dict) --* The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the "capacity-optimized" allocation strategy is used and that all of the Availability Zones in the Region can be used. * **Region** *(string) --* The Region. * **AvailabilityZoneId** *(string) --* The Availability Zone. * **Score** *(integer) --* The placement score, on a scale from "1" to "10". A score of "10" indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of "1" indicates that your Spot request is not likely to succeed. EC2 / Paginator / GetTransitGatewayRouteTableAssociations GetTransitGatewayRouteTableAssociations *************************************** class EC2.Paginator.GetTransitGatewayRouteTableAssociations paginator = client.get_paginator('get_transit_gateway_route_table_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_transit_gateway_route_table_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' }, ], } **Response Structure** * *(dict) --* * **Associations** *(list) --* Information about the associations. * *(dict) --* Describes an association between a route table and a resource attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the association. EC2 / Paginator / DescribeTransitGatewayPolicyTables DescribeTransitGatewayPolicyTables ********************************** class EC2.Paginator.DescribeTransitGatewayPolicyTables paginator = client.get_paginator('describe_transit_gateway_policy_tables') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_policy_tables()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayPolicyTableIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayPolicyTableIds** (*list*) -- The IDs of the transit gateway policy tables. * *(string) --* * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayPolicyTables': [ { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayPolicyTables** *(list) --* Describes the transit gateway policy tables. * *(dict) --* Describes a transit gateway policy table. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway policy table * **CreationTime** *(datetime) --* The timestamp when the transit gateway policy table was created. * **Tags** *(list) --* he key-value pairs associated with the transit gateway policy table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribePrefixLists DescribePrefixLists ******************* class EC2.Paginator.DescribePrefixLists paginator = client.get_paginator('describe_prefix_lists') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_prefix_lists()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PrefixListIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "prefix-list-id": The ID of a prefix list. * "prefix-list-name": The name of a prefix list. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PrefixListIds** (*list*) -- One or more prefix list IDs. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'PrefixLists': [ { 'Cidrs': [ 'string', ], 'PrefixListId': 'string', 'PrefixListName': 'string' }, ] } **Response Structure** * *(dict) --* * **PrefixLists** *(list) --* All available prefix lists. * *(dict) --* Describes prefixes for Amazon Web Services services. * **Cidrs** *(list) --* The IP address range of the Amazon Web Services service. * *(string) --* * **PrefixListId** *(string) --* The ID of the prefix. * **PrefixListName** *(string) --* The name of the prefix. EC2 / Paginator / ListSnapshotsInRecycleBin ListSnapshotsInRecycleBin ************************* class EC2.Paginator.ListSnapshotsInRecycleBin paginator = client.get_paginator('list_snapshots_in_recycle_bin') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.list_snapshots_in_recycle_bin()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SnapshotIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SnapshotIds** (*list*) -- The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Snapshots': [ { 'SnapshotId': 'string', 'RecycleBinEnterTime': datetime(2015, 1, 1), 'RecycleBinExitTime': datetime(2015, 1, 1), 'Description': 'string', 'VolumeId': 'string' }, ], } **Response Structure** * *(dict) --* * **Snapshots** *(list) --* Information about the snapshots. * *(dict) --* Information about a snapshot that is currently in the Recycle Bin. * **SnapshotId** *(string) --* The ID of the snapshot. * **RecycleBinEnterTime** *(datetime) --* The date and time when the snapshot entered the Recycle Bin. * **RecycleBinExitTime** *(datetime) --* The date and time when the snapshot is to be permanently deleted from the Recycle Bin. * **Description** *(string) --* The description for the snapshot. * **VolumeId** *(string) --* The ID of the volume from which the snapshot was created. EC2 / Paginator / DescribeLocalGatewayVirtualInterfaceGroups DescribeLocalGatewayVirtualInterfaceGroups ****************************************** class EC2.Paginator.DescribeLocalGatewayVirtualInterfaceGroups paginator = client.get_paginator('describe_local_gateway_virtual_interface_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_local_gateway_virtual_interface_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayVirtualInterfaceGroupIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayVirtualInterfaceGroupIds** (*list*) -- The IDs of the virtual interface groups. * *(string) --* * **Filters** (*list*) -- One or more filters. * "local-gateway-id" - The ID of a local gateway. * "local-gateway-virtual-interface-group-id" - The ID of the virtual interface group. * "local-gateway-virtual-interface-id" - The ID of the virtual interface. * "owner-id" - The ID of the Amazon Web Services account that owns the local gateway virtual interface group. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LocalGatewayVirtualInterfaceGroups': [ { 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayVirtualInterfaceIds': [ 'string', ], 'LocalGatewayId': 'string', 'OwnerId': 'string', 'LocalBgpAsn': 123, 'LocalBgpAsnExtended': 123, 'LocalGatewayVirtualInterfaceGroupArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted' }, ], } **Response Structure** * *(dict) --* * **LocalGatewayVirtualInterfaceGroups** *(list) --* The virtual interface groups. * *(dict) --* Describes a local gateway virtual interface group. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **LocalGatewayVirtualInterfaceIds** *(list) --* The IDs of the virtual interfaces. * *(string) --* * **LocalGatewayId** *(string) --* The ID of the local gateway. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface group. * **LocalBgpAsn** *(integer) --* The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP). * **LocalBgpAsnExtended** *(integer) --* The extended 32-bit ASN for the local BGP configuration. * **LocalGatewayVirtualInterfaceGroupArn** *(string) --* The Amazon Resource Number (ARN) of the local gateway virtual interface group. * **Tags** *(list) --* The tags assigned to the virtual interface group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConfigurationState** *(string) --* The current state of the local gateway virtual interface group. EC2 / Paginator / DescribeTransitGatewayRouteTables DescribeTransitGatewayRouteTables ********************************* class EC2.Paginator.DescribeTransitGatewayRouteTables paginator = client.get_paginator('describe_transit_gateway_route_tables') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_transit_gateway_route_tables()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayRouteTableIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayRouteTableIds** (*list*) -- The IDs of the transit gateway route tables. * *(string) --* * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTables': [ { 'TransitGatewayRouteTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'DefaultAssociationRouteTable': True|False, 'DefaultPropagationRouteTable': True|False, 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **TransitGatewayRouteTables** *(list) --* Information about the transit gateway route tables. * *(dict) --* Describes a transit gateway route table. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway route table. * **DefaultAssociationRouteTable** *(boolean) --* Indicates whether this is the default association route table for the transit gateway. * **DefaultPropagationRouteTable** *(boolean) --* Indicates whether this is the default propagation route table for the transit gateway. * **CreationTime** *(datetime) --* The creation time. * **Tags** *(list) --* Any tags assigned to the route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeIpams DescribeIpams ************* class EC2.Paginator.DescribeIpams paginator = client.get_paginator('describe_ipams') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_ipams()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IpamIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **IpamIds** (*list*) -- The IDs of the IPAMs you want information on. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Ipams': [ { 'OwnerId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'PublicDefaultScopeId': 'string', 'PrivateDefaultScopeId': 'string', 'ScopeCount': 123, 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DefaultResourceDiscoveryId': 'string', 'DefaultResourceDiscoveryAssociationId': 'string', 'ResourceDiscoveryAssociationCount': 123, 'StateMessage': 'string', 'Tier': 'free'|'advanced', 'EnablePrivateGua': True|False, 'MeteredAccount': 'ipam-owner'|'resource-owner' }, ] } **Response Structure** * *(dict) --* * **Ipams** *(list) --* Information about the IPAMs. * *(dict) --* IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM. * **IpamId** *(string) --* The ID of the IPAM. * **IpamArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM. * **PublicDefaultScopeId** *(string) --* The ID of the IPAM's default public scope. * **PrivateDefaultScopeId** *(string) --* The ID of the IPAM's default private scope. * **ScopeCount** *(integer) --* The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **Description** *(string) --* The description for the IPAM. * **OperatingRegions** *(list) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **State** *(string) --* The state of the IPAM. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DefaultResourceDiscoveryId** *(string) --* The IPAM's default resource discovery ID. * **DefaultResourceDiscoveryAssociationId** *(string) --* The IPAM's default resource discovery association ID. * **ResourceDiscoveryAssociationCount** *(integer) --* The IPAM's resource discovery association count. * **StateMessage** *(string) --* The state message. * **Tier** *(string) --* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** *(boolean) --* Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** *(string) --* A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. EC2 / Paginator / GetTransitGatewayPrefixListReferences GetTransitGatewayPrefixListReferences ************************************* class EC2.Paginator.GetTransitGatewayPrefixListReferences paginator = client.get_paginator('get_transit_gateway_prefix_list_references') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_transit_gateway_prefix_list_references()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayPrefixListReferences': [ { 'TransitGatewayRouteTableId': 'string', 'PrefixListId': 'string', 'PrefixListOwnerId': 'string', 'State': 'pending'|'available'|'modifying'|'deleting', 'Blackhole': True|False, 'TransitGatewayAttachment': { 'TransitGatewayAttachmentId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceId': 'string' } }, ], } **Response Structure** * *(dict) --* * **TransitGatewayPrefixListReferences** *(list) --* Information about the prefix list references. * *(dict) --* Describes a prefix list reference. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **PrefixListId** *(string) --* The ID of the prefix list. * **PrefixListOwnerId** *(string) --* The ID of the prefix list owner. * **State** *(string) --* The state of the prefix list reference. * **Blackhole** *(boolean) --* Indicates whether traffic that matches this route is dropped. * **TransitGatewayAttachment** *(dict) --* Information about the transit gateway attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **ResourceId** *(string) --* The ID of the resource. EC2 / Paginator / DescribeCapacityBlockExtensionHistory DescribeCapacityBlockExtensionHistory ************************************* class EC2.Paginator.DescribeCapacityBlockExtensionHistory paginator = client.get_paginator('describe_capacity_block_extension_history') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_capacity_block_extension_history()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CapacityReservationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CapacityReservationIds** (*list*) -- The IDs of Capacity Block reservations that you want to display the history for. * *(string) --* * **Filters** (*list*) -- One or more filters * "availability-zone" - The Availability Zone of the extension. * "availability-zone-id" - The Availability Zone ID of the extension. * "capacity-block-extension-offering-id" - The ID of the extension offering. * "capacity-block-extension-status" - The status of the extension ( "payment-pending" | "payment-failed" | "payment-succeeded"). * "capacity-reservation-id" - The reservation ID of the extension. * "instance-type" - The instance type of the extension. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CapacityBlockExtensions': [ { 'CapacityReservationId': 'string', 'InstanceType': 'string', 'InstanceCount': 123, 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'CapacityBlockExtensionOfferingId': 'string', 'CapacityBlockExtensionDurationHours': 123, 'CapacityBlockExtensionStatus': 'payment-pending'|'payment-failed'|'payment-succeeded', 'CapacityBlockExtensionPurchaseDate': datetime(2015, 1, 1), 'CapacityBlockExtensionStartDate': datetime(2015, 1, 1), 'CapacityBlockExtensionEndDate': datetime(2015, 1, 1), 'UpfrontFee': 'string', 'CurrencyCode': 'string' }, ], } **Response Structure** * *(dict) --* * **CapacityBlockExtensions** *(list) --* Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the Amazon Web Services Region that you're currently using. * *(dict) --* Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block. * **CapacityReservationId** *(string) --* The reservation ID of the Capacity Block extension. * **InstanceType** *(string) --* The instance type of the Capacity Block extension. * **InstanceCount** *(integer) --* The number of instances in the Capacity Block extension. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block extension. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Block extension. * **CapacityBlockExtensionOfferingId** *(string) --* The ID of the Capacity Block extension offering. * **CapacityBlockExtensionDurationHours** *(integer) --* The duration of the Capacity Block extension in hours. * **CapacityBlockExtensionStatus** *(string) --* The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses: * "payment-pending" - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed. * "payment-failed" - Payment for the Capacity Block extension request was not successful. * "payment-succeeded" - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID. * **CapacityBlockExtensionPurchaseDate** *(datetime) --* The date when the Capacity Block extension was purchased. * **CapacityBlockExtensionStartDate** *(datetime) --* The start date of the Capacity Block extension. * **CapacityBlockExtensionEndDate** *(datetime) --* The end date of the Capacity Block extension. * **UpfrontFee** *(string) --* The total price to be paid up front. * **CurrencyCode** *(string) --* The currency of the payment for the Capacity Block extension. EC2 / Paginator / DescribeLocalGatewayRouteTableVpcAssociations DescribeLocalGatewayRouteTableVpcAssociations ********************************************* class EC2.Paginator.DescribeLocalGatewayRouteTableVpcAssociations paginator = client.get_paginator('describe_local_gateway_route_table_vpc_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from " EC2.Client.describe_local_gateway_route_table_vpc_associations( )". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayRouteTableVpcAssociationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayRouteTableVpcAssociationIds** (*list*) -- The IDs of the associations. * *(string) --* * **Filters** (*list*) -- One or more filters. * "local-gateway-id" - The ID of a local gateway. * "local-gateway-route-table-arn" - The Amazon Resource Name (ARN) of the local gateway route table for the association. * "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. * "owner-id" - The ID of the Amazon Web Services account that owns the local gateway route table for the association. * "state" - The state of the association. * "vpc-id" - The ID of the VPC. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTableVpcAssociations': [ { 'LocalGatewayRouteTableVpcAssociationId': 'string', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'VpcId': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **LocalGatewayRouteTableVpcAssociations** *(list) --* Information about the associations. * *(dict) --* Describes an association between a local gateway route table and a VPC. * **LocalGatewayRouteTableVpcAssociationId** *(string) --* The ID of the association. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table for the association. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **VpcId** *(string) --* The ID of the VPC. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table for the association. * **State** *(string) --* The state of the association. * **Tags** *(list) --* The tags assigned to the association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeNetworkInsightsAnalyses DescribeNetworkInsightsAnalyses ******************************* class EC2.Paginator.DescribeNetworkInsightsAnalyses paginator = client.get_paginator('describe_network_insights_analyses') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_insights_analyses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInsightsAnalysisIds=[ 'string', ], NetworkInsightsPathId='string', AnalysisStartTime=datetime(2015, 1, 1), AnalysisEndTime=datetime(2015, 1, 1), Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInsightsAnalysisIds** (*list*) -- The ID of the network insights analyses. You must specify either analysis IDs or a path ID. * *(string) --* * **NetworkInsightsPathId** (*string*) -- The ID of the path. You must specify either a path ID or analysis IDs. * **AnalysisStartTime** (*datetime*) -- The time when the network insights analyses started. * **AnalysisEndTime** (*datetime*) -- The time when the network insights analyses ended. * **Filters** (*list*) -- The filters. The following are the possible values: * path-found - A Boolean value that indicates whether a feasible path is found. * status - The status of the analysis (running | succeeded | failed). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAnalyses': [ { 'NetworkInsightsAnalysisId': 'string', 'NetworkInsightsAnalysisArn': 'string', 'NetworkInsightsPathId': 'string', 'AdditionalAccounts': [ 'string', ], 'FilterInArns': [ 'string', ], 'FilterOutArns': [ 'string', ], 'StartDate': datetime(2015, 1, 1), 'Status': 'running'|'succeeded'|'failed', 'StatusMessage': 'string', 'WarningMessage': 'string', 'NetworkPathFound': True|False, 'ForwardPathComponents': [ { 'SequenceNumber': 123, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'OutboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'InboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AdditionalDetails': [ { 'AdditionalDetailType': 'string', 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpointService': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ], 'RuleGroupTypePairs': [ { 'RuleGroupArn': 'string', 'RuleGroupType': 'string' }, ], 'RuleGroupRuleOptionsPairs': [ { 'RuleGroupArn': 'string', 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ] }, ], 'ServiceName': 'string', 'LoadBalancers': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ] }, ], 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'Explanations': [ { 'Acl': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'Address': 'string', 'Addresses': [ 'string', ], 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AvailabilityZones': [ 'string', ], 'AvailabilityZoneIds': [ 'string', ], 'Cidrs': [ 'string', ], 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'CustomerGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Destination': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Direction': 'string', 'ExplanationCode': 'string', 'IngressRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'InternetGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerArn': 'string', 'ClassicLoadBalancerListener': { 'LoadBalancerPort': 123, 'InstancePort': 123 }, 'LoadBalancerListenerPort': 123, 'LoadBalancerTarget': { 'Address': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'Instance': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123 }, 'LoadBalancerTargetGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerTargetGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'LoadBalancerTargetPort': 123, 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'MissingComponent': 'string', 'NatGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'NetworkInterface': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'PacketField': 'string', 'VpcPeeringConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123, 'PortRanges': [ { 'From': 123, 'To': 123 }, ], 'PrefixList': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Protocols': [ 'string', ], 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'RouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SecurityGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'State': 'string', 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SubnetRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpoint': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'TransitGatewayAttachment': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'ComponentAccount': 'string', 'ComponentRegion': 'string', 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' } }, ], 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' }, 'ServiceName': 'string' }, ], 'ReturnPathComponents': [ { 'SequenceNumber': 123, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'OutboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'InboundHeader': { 'DestinationAddresses': [ 'string', ], 'DestinationPortRanges': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'SourceAddresses': [ 'string', ], 'SourcePortRanges': [ { 'From': 123, 'To': 123 }, ] }, 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AdditionalDetails': [ { 'AdditionalDetailType': 'string', 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpointService': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ], 'RuleGroupTypePairs': [ { 'RuleGroupArn': 'string', 'RuleGroupType': 'string' }, ], 'RuleGroupRuleOptionsPairs': [ { 'RuleGroupArn': 'string', 'RuleOptions': [ { 'Keyword': 'string', 'Settings': [ 'string', ] }, ] }, ], 'ServiceName': 'string', 'LoadBalancers': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ] }, ], 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'Explanations': [ { 'Acl': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'Address': 'string', 'Addresses': [ 'string', ], 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AvailabilityZones': [ 'string', ], 'AvailabilityZoneIds': [ 'string', ], 'Cidrs': [ 'string', ], 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'CustomerGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Destination': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Direction': 'string', 'ExplanationCode': 'string', 'IngressRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'InternetGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerArn': 'string', 'ClassicLoadBalancerListener': { 'LoadBalancerPort': 123, 'InstancePort': 123 }, 'LoadBalancerListenerPort': 123, 'LoadBalancerTarget': { 'Address': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'Instance': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123 }, 'LoadBalancerTargetGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerTargetGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'LoadBalancerTargetPort': 123, 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'MissingComponent': 'string', 'NatGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'NetworkInterface': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'PacketField': 'string', 'VpcPeeringConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123, 'PortRanges': [ { 'From': 123, 'To': 123 }, ], 'PrefixList': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Protocols': [ 'string', ], 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'RouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SecurityGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'State': 'string', 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SubnetRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpoint': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'TransitGatewayAttachment': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'ComponentAccount': 'string', 'ComponentRegion': 'string', 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' } }, ], 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' }, 'ServiceName': 'string' }, ], 'Explanations': [ { 'Acl': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AclRule': { 'Cidr': 'string', 'Egress': True|False, 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'string', 'RuleNumber': 123 }, 'Address': 'string', 'Addresses': [ 'string', ], 'AttachedTo': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'AvailabilityZones': [ 'string', ], 'AvailabilityZoneIds': [ 'string', ], 'Cidrs': [ 'string', ], 'Component': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'CustomerGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Destination': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'DestinationVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Direction': 'string', 'ExplanationCode': 'string', 'IngressRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'InternetGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerArn': 'string', 'ClassicLoadBalancerListener': { 'LoadBalancerPort': 123, 'InstancePort': 123 }, 'LoadBalancerListenerPort': 123, 'LoadBalancerTarget': { 'Address': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'Instance': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123 }, 'LoadBalancerTargetGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'LoadBalancerTargetGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'LoadBalancerTargetPort': 123, 'ElasticLoadBalancerListener': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'MissingComponent': 'string', 'NatGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'NetworkInterface': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'PacketField': 'string', 'VpcPeeringConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Port': 123, 'PortRanges': [ { 'From': 123, 'To': 123 }, ], 'PrefixList': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Protocols': [ 'string', ], 'RouteTableRoute': { 'DestinationCidr': 'string', 'DestinationPrefixListId': 'string', 'EgressOnlyInternetGatewayId': 'string', 'GatewayId': 'string', 'InstanceId': 'string', 'NatGatewayId': 'string', 'NetworkInterfaceId': 'string', 'Origin': 'string', 'TransitGatewayId': 'string', 'VpcPeeringConnectionId': 'string', 'State': 'string', 'CarrierGatewayId': 'string', 'CoreNetworkArn': 'string', 'LocalGatewayId': 'string' }, 'RouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroup': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SecurityGroupRule': { 'Cidr': 'string', 'Direction': 'string', 'SecurityGroupId': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'PrefixListId': 'string', 'Protocol': 'string' }, 'SecurityGroups': [ { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, ], 'SourceVpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'State': 'string', 'Subnet': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'SubnetRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'Vpc': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpcEndpoint': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnConnection': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'VpnGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGateway': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTable': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'TransitGatewayRouteTableRoute': { 'DestinationCidr': 'string', 'State': 'string', 'RouteOrigin': 'string', 'PrefixListId': 'string', 'AttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'string' }, 'TransitGatewayAttachment': { 'Id': 'string', 'Arn': 'string', 'Name': 'string' }, 'ComponentAccount': 'string', 'ComponentRegion': 'string', 'FirewallStatelessRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocols': [ 123, ], 'RuleAction': 'string', 'Priority': 123 }, 'FirewallStatefulRule': { 'RuleGroupArn': 'string', 'Sources': [ 'string', ], 'Destinations': [ 'string', ], 'SourcePorts': [ { 'From': 123, 'To': 123 }, ], 'DestinationPorts': [ { 'From': 123, 'To': 123 }, ], 'Protocol': 'string', 'RuleAction': 'string', 'Direction': 'string' } }, ], 'AlternatePathHints': [ { 'ComponentId': 'string', 'ComponentArn': 'string' }, ], 'SuggestedAccounts': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** # This section is too large to render. # Please see the AWS API Documentation linked below. AWS API Documentation EC2 / Paginator / DescribeByoipCidrs DescribeByoipCidrs ****************** class EC2.Paginator.DescribeByoipCidrs paginator = client.get_paginator('describe_byoip_cidrs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_byoip_cidrs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ByoipCidrs': [ { 'Cidr': 'string', 'Description': 'string', 'AsnAssociations': [ { 'Asn': 'string', 'Cidr': 'string', 'StatusMessage': 'string', 'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated' }, ], 'StatusMessage': 'string', 'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable', 'NetworkBorderGroup': 'string' }, ], } **Response Structure** * *(dict) --* * **ByoipCidrs** *(list) --* Information about your address ranges. * *(dict) --* Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). * **Cidr** *(string) --* The address range, in CIDR notation. * **Description** *(string) --* The description of the address range. * **AsnAssociations** *(list) --* The BYOIP CIDR associations with ASNs. * *(dict) --* An Autonomous System Number (ASN) and BYOIP CIDR association. * **Asn** *(string) --* The association's ASN. * **Cidr** *(string) --* The association's CIDR. * **StatusMessage** *(string) --* The association's status message. * **State** *(string) --* The association's state. * **StatusMessage** *(string) --* Upon success, contains the ID of the address pool. Otherwise, contains an error message. * **State** *(string) --* The state of the address range. * "advertised": The address range is being advertised to the internet by Amazon Web Services. * "deprovisioned": The address range is deprovisioned. * "failed-deprovision": The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again. * "failed-provision": The request to provision the address range was unsuccessful. * "pending-deprovision": You’ve submitted a request to deprovision an address range and it's pending. * "pending-provision": You’ve submitted a request to provision an address range and it's pending. * "provisioned": The address range is provisioned and can be advertised. The range is not currently advertised. * "provisioned-not-publicly-advertisable": The address range is provisioned and cannot be advertised. * **NetworkBorderGroup** *(string) --* If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group. You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups: * us-east-1-dfw-2 * us-west-2-lax-1 * us-west-2-phx-2 Note: You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time. EC2 / Paginator / DescribeVpcEndpointServicePermissions DescribeVpcEndpointServicePermissions ************************************* class EC2.Paginator.DescribeVpcEndpointServicePermissions paginator = client.get_paginator('describe_vpc_endpoint_service_permissions') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_vpc_endpoint_service_permissions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, ServiceId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the service. * **Filters** (*list*) -- The filters. * "principal" - The ARN of the principal. * "principal-type" - The principal type ( "All" | "Service" | "OrganizationUnit" | "Account" | "User" | "Role"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'AllowedPrincipals': [ { 'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role', 'Principal': 'string', 'ServicePermissionId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ServiceId': 'string' }, ], } **Response Structure** * *(dict) --* * **AllowedPrincipals** *(list) --* Information about the allowed principals. * *(dict) --* Describes a principal. * **PrincipalType** *(string) --* The type of principal. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. * **ServicePermissionId** *(string) --* The ID of the service permission. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ServiceId** *(string) --* The ID of the service. EC2 / Paginator / DescribeInstanceTopology DescribeInstanceTopology ************************ class EC2.Paginator.DescribeInstanceTopology paginator = client.get_paginator('describe_instance_topology') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_topology()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, InstanceIds=[ 'string', ], GroupNames=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceIds** (*list*) -- The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. * *(string) --* * **GroupNames** (*list*) -- The name of the placement group that each instance is in. Constraints: Maximum 100 explicitly specified placement group names. * *(string) --* * **Filters** (*list*) -- The filters. * "availability-zone" - The name of the Availability Zone (for example, "us-west-2a") or Local Zone (for example, "us-west-2-lax-1b") that the instance is in. * "instance-type" - The instance type (for example, "p4d.24xlarge") or instance family (for example, "p4d*"). You can use the "*" wildcard to match zero or more characters, or the "?" wildcard to match zero or one character. * "zone-id" - The ID of the Availability Zone (for example, "usw2-az2") or Local Zone (for example, "usw2-lax1-az1") that the instance is in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Instances': [ { 'InstanceId': 'string', 'InstanceType': 'string', 'GroupName': 'string', 'NetworkNodes': [ 'string', ], 'AvailabilityZone': 'string', 'ZoneId': 'string', 'CapacityBlockId': 'string' }, ], } **Response Structure** * *(dict) --* * **Instances** *(list) --* Information about the topology of each instance. * *(dict) --* Information about the instance topology. * **InstanceId** *(string) --* The instance ID. * **InstanceType** *(string) --* The instance type. * **GroupName** *(string) --* The name of the placement group that the instance is in. * **NetworkNodes** *(list) --* The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings. * *(string) --* * **AvailabilityZone** *(string) --* The name of the Availability Zone or Local Zone that the instance is in. * **ZoneId** *(string) --* The ID of the Availability Zone or Local Zone that the instance is in. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. This parameter is only supported for Ultraserver instances and identifies instances within the Ultraserver domain. EC2 / Paginator / DescribeNetworkInsightsPaths DescribeNetworkInsightsPaths **************************** class EC2.Paginator.DescribeNetworkInsightsPaths paginator = client.get_paginator('describe_network_insights_paths') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_network_insights_paths()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( NetworkInsightsPathIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **NetworkInsightsPathIds** (*list*) -- The IDs of the paths. * *(string) --* * **Filters** (*list*) -- The filters. The following are the possible values: * destination - The ID of the resource. * filter-at-source.source-address - The source IPv4 address at the source. * filter-at-source.source-port-range - The source port range at the source. * filter-at-source.destination-address - The destination IPv4 address at the source. * filter-at-source.destination-port-range - The destination port range at the source. * filter-at-destination.source-address - The source IPv4 address at the destination. * filter-at-destination.source-port-range - The source port range at the destination. * filter-at-destination.destination-address - The destination IPv4 address at the destination. * filter-at-destination.destination-port-range - The destination port range at the destination. * protocol - The protocol. * source - The ID of the resource. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsPaths': [ { 'NetworkInsightsPathId': 'string', 'NetworkInsightsPathArn': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Source': 'string', 'Destination': 'string', 'SourceArn': 'string', 'DestinationArn': 'string', 'SourceIp': 'string', 'DestinationIp': 'string', 'Protocol': 'tcp'|'udp', 'DestinationPort': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FilterAtSource': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } }, 'FilterAtDestination': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } } }, ], } **Response Structure** * *(dict) --* * **NetworkInsightsPaths** *(list) --* Information about the paths. * *(dict) --* Describes a path. * **NetworkInsightsPathId** *(string) --* The ID of the path. * **NetworkInsightsPathArn** *(string) --* The Amazon Resource Name (ARN) of the path. * **CreatedDate** *(datetime) --* The time stamp when the path was created. * **Source** *(string) --* The ID of the source. * **Destination** *(string) --* The ID of the destination. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the source. * **DestinationArn** *(string) --* The Amazon Resource Name (ARN) of the destination. * **SourceIp** *(string) --* The IP address of the source. * **DestinationIp** *(string) --* The IP address of the destination. * **Protocol** *(string) --* The protocol. * **DestinationPort** *(integer) --* The destination port. * **Tags** *(list) --* The tags associated with the path. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **FilterAtSource** *(dict) --* Scopes the analysis to network paths that match specific filters at the source. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **FilterAtDestination** *(dict) --* Scopes the analysis to network paths that match specific filters at the destination. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. EC2 / Paginator / DescribeFpgaImages DescribeFpgaImages ****************** class EC2.Paginator.DescribeFpgaImages paginator = client.get_paginator('describe_fpga_images') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_fpga_images()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, FpgaImageIds=[ 'string', ], Owners=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FpgaImageIds** (*list*) -- The AFI IDs. * *(string) --* * **Owners** (*list*) -- Filters the AFI by owner. Specify an Amazon Web Services account ID, "self" (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are "amazon" | "aws-marketplace"). * *(string) --* * **Filters** (*list*) -- 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 identifier (AGFI ID). * "name" - The name of the AFI. * "owner-id" - The Amazon Web Services account ID of the AFI owner. * "product-code" - The product code. * "shell-version" - The version of the Amazon Web Services Shell that was used to create the bitstream. * "state" - The state of the AFI ( "pending" | "failed" | "available" | "unavailable"). * "tag": - 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. * "update-time" - The time of the most recent update. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'FpgaImages': [ { 'FpgaImageId': 'string', 'FpgaImageGlobalId': 'string', 'Name': 'string', 'Description': 'string', 'ShellVersion': 'string', 'PciId': { 'DeviceId': 'string', 'VendorId': 'string', 'SubsystemId': 'string', 'SubsystemVendorId': 'string' }, 'State': { 'Code': 'pending'|'failed'|'available'|'unavailable', 'Message': 'string' }, 'CreateTime': datetime(2015, 1, 1), 'UpdateTime': datetime(2015, 1, 1), 'OwnerId': 'string', 'OwnerAlias': 'string', 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Public': True|False, 'DataRetentionSupport': True|False, 'InstanceTypes': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **FpgaImages** *(list) --* Information about the FPGA images. * *(dict) --* Describes an Amazon FPGA image (AFI). * **FpgaImageId** *(string) --* The FPGA image identifier (AFI ID). * **FpgaImageGlobalId** *(string) --* The global FPGA image identifier (AGFI ID). * **Name** *(string) --* The name of the AFI. * **Description** *(string) --* The description of the AFI. * **ShellVersion** *(string) --* The version of the Amazon Web Services Shell that was used to create the bitstream. * **PciId** *(dict) --* Information about the PCI bus. * **DeviceId** *(string) --* The ID of the device. * **VendorId** *(string) --* The ID of the vendor. * **SubsystemId** *(string) --* The ID of the subsystem. * **SubsystemVendorId** *(string) --* The ID of the vendor for the subsystem. * **State** *(dict) --* Information about the state of the AFI. * **Code** *(string) --* The state. The following are the possible values: * "pending" - AFI bitstream generation is in progress. * "available" - The AFI is available for use. * "failed" - AFI bitstream generation failed. * "unavailable" - The AFI is no longer available for use. * **Message** *(string) --* If the state is "failed", this is the error message. * **CreateTime** *(datetime) --* The date and time the AFI was created. * **UpdateTime** *(datetime) --* The time of the most recent update to the AFI. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the AFI. * **OwnerAlias** *(string) --* The alias of the AFI owner. Possible values include "self", "amazon", and "aws-marketplace". * **ProductCodes** *(list) --* The product codes for the AFI. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **Tags** *(list) --* Any tags assigned to the AFI. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Public** *(boolean) --* Indicates whether the AFI is public. * **DataRetentionSupport** *(boolean) --* Indicates whether data retention support is enabled for the AFI. * **InstanceTypes** *(list) --* The instance types supported by the AFI. * *(string) --* EC2 / Paginator / DescribeCoipPools DescribeCoipPools ***************** class EC2.Paginator.DescribeCoipPools paginator = client.get_paginator('describe_coip_pools') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_coip_pools()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PoolIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **PoolIds** (*list*) -- The IDs of the address pools. * *(string) --* * **Filters** (*list*) -- One or more filters. * "coip-pool.local-gateway-route-table-id" - The ID of the local gateway route table. * "coip-pool.pool-id" - The ID of the address pool. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CoipPools': [ { 'PoolId': 'string', 'PoolCidrs': [ 'string', ], 'LocalGatewayRouteTableId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PoolArn': 'string' }, ], } **Response Structure** * *(dict) --* * **CoipPools** *(list) --* Information about the address pools. * *(dict) --* Describes a customer-owned address pool. * **PoolId** *(string) --* The ID of the address pool. * **PoolCidrs** *(list) --* The address ranges of the address pool. * *(string) --* * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PoolArn** *(string) --* The ARN of the address pool. EC2 / Paginator / DescribeLocalGatewayRouteTables DescribeLocalGatewayRouteTables ******************************* class EC2.Paginator.DescribeLocalGatewayRouteTables paginator = client.get_paginator('describe_local_gateway_route_tables') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_local_gateway_route_tables()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( LocalGatewayRouteTableIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **LocalGatewayRouteTableIds** (*list*) -- The IDs of the local gateway route tables. * *(string) --* * **Filters** (*list*) -- One or more filters. * "local-gateway-id" - The ID of a local gateway. * "local-gateway-route-table-arn" - The Amazon Resource Name (ARN) of the local gateway route table. * "local-gateway-route-table-id" - The ID of a local gateway route table. * "outpost-arn" - The Amazon Resource Name (ARN) of the Outpost. * "owner-id" - The ID of the Amazon Web Services account that owns the local gateway route table. * "state" - The state of the local gateway route table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTables': [ { 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'OutpostArn': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Mode': 'direct-vpc-routing'|'coip', 'StateReason': { 'Code': 'string', 'Message': 'string' } }, ], } **Response Structure** * *(dict) --* * **LocalGatewayRouteTables** *(list) --* Information about the local gateway route tables. * *(dict) --* Describes a local gateway route table. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table. * **State** *(string) --* The state of the local gateway route table. * **Tags** *(list) --* The tags assigned to the local gateway route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Mode** *(string) --* The mode of the local gateway route table. * **StateReason** *(dict) --* Information about the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. EC2 / Paginator / GetAssociatedIpv6PoolCidrs GetAssociatedIpv6PoolCidrs ************************** class EC2.Paginator.GetAssociatedIpv6PoolCidrs paginator = client.get_paginator('get_associated_ipv6_pool_cidrs') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_associated_ipv6_pool_cidrs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PoolId='string', DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **PoolId** (*string*) -- **[REQUIRED]** The ID of the IPv6 address pool. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Ipv6CidrAssociations': [ { 'Ipv6Cidr': 'string', 'AssociatedResource': 'string' }, ], } **Response Structure** * *(dict) --* * **Ipv6CidrAssociations** *(list) --* Information about the IPv6 CIDR block associations. * *(dict) --* Describes an IPv6 CIDR block association. * **Ipv6Cidr** *(string) --* The IPv6 CIDR block. * **AssociatedResource** *(string) --* The resource that's associated with the IPv6 CIDR block. EC2 / Paginator / GetTransitGatewayPolicyTableAssociations GetTransitGatewayPolicyTableAssociations **************************************** class EC2.Paginator.GetTransitGatewayPolicyTableAssociations paginator = client.get_paginator('get_transit_gateway_policy_table_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_transit_gateway_policy_table_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayPolicyTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayPolicyTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway policy table. * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' }, ], } **Response Structure** * *(dict) --* * **Associations** *(list) --* Returns details about the transit gateway policy table association. * *(dict) --* Describes a transit gateway policy table association. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The resource ID of the transit gateway attachment. * **ResourceType** *(string) --* The resource type for the transit gateway policy table association. * **State** *(string) --* The state of the transit gateway policy table association. EC2 / Paginator / GetVpnConnectionDeviceTypes GetVpnConnectionDeviceTypes *************************** class EC2.Paginator.GetVpnConnectionDeviceTypes paginator = client.get_paginator('get_vpn_connection_device_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_vpn_connection_device_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VpnConnectionDeviceTypes': [ { 'VpnConnectionDeviceTypeId': 'string', 'Vendor': 'string', 'Platform': 'string', 'Software': 'string' }, ], } **Response Structure** * *(dict) --* * **VpnConnectionDeviceTypes** *(list) --* List of customer gateway devices that have a sample configuration file available for use. * *(dict) --* List of customer gateway devices that have a sample configuration file available for use. You can also see the list of device types with sample configuration files available under Your customer gateway device in the *Amazon Web Services Site-to-Site VPN User Guide*. * **VpnConnectionDeviceTypeId** *(string) --* Customer gateway device identifier. * **Vendor** *(string) --* Customer gateway device vendor. * **Platform** *(string) --* Customer gateway device platform. * **Software** *(string) --* Customer gateway device software version. EC2 / Paginator / DescribeMovingAddresses DescribeMovingAddresses *********************** class EC2.Paginator.DescribeMovingAddresses paginator = client.get_paginator('describe_moving_addresses') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_moving_addresses()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, PublicIps=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PublicIps** (*list*) -- One or more Elastic IP addresses. * *(string) --* * **Filters** (*list*) -- One or more filters. * "moving-status" - The status of the Elastic IP address ( "MovingToVpc" | "RestoringToClassic"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MovingAddressStatuses': [ { 'MoveStatus': 'movingToVpc'|'restoringToClassic', 'PublicIp': 'string' }, ], } **Response Structure** * *(dict) --* * **MovingAddressStatuses** *(list) --* The status for each Elastic IP address. * *(dict) --* Note: This action is deprecated. Describes the status of a moving Elastic IP address. * **MoveStatus** *(string) --* The status of the Elastic IP address that's being moved or restored. * **PublicIp** *(string) --* The Elastic IP address. EC2 / Paginator / DescribeRouteServerPeers DescribeRouteServerPeers ************************ class EC2.Paginator.DescribeRouteServerPeers paginator = client.get_paginator('describe_route_server_peers') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_route_server_peers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RouteServerPeerIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RouteServerPeerIds** (*list*) -- The IDs of the route server peers to describe. * *(string) --* * **Filters** (*list*) -- One or more filters to apply to the describe request. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'RouteServerPeers': [ { 'RouteServerPeerId': 'string', 'RouteServerEndpointId': 'string', 'RouteServerId': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed', 'FailureReason': 'string', 'EndpointEniId': 'string', 'EndpointEniAddress': 'string', 'PeerAddress': 'string', 'BgpOptions': { 'PeerAsn': 123, 'PeerLivenessDetection': 'bfd'|'bgp-keepalive' }, 'BgpStatus': { 'Status': 'up'|'down' }, 'BfdStatus': { 'Status': 'up'|'down' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], } **Response Structure** * *(dict) --* * **RouteServerPeers** *(list) --* Information about the described route server peers. * *(dict) --* Describes a BGP peer configuration for a route server endpoint. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: * Have an elastic network interface in the VPC * Support BGP (Border Gateway Protocol) * Can initiate BGP sessions * **RouteServerPeerId** *(string) --* The unique identifier of the route server peer. * **RouteServerEndpointId** *(string) --* The ID of the route server endpoint associated with this peer. * **RouteServerId** *(string) --* The ID of the route server associated with this peer. * **VpcId** *(string) --* The ID of the VPC containing the route server peer. * **SubnetId** *(string) --* The ID of the subnet containing the route server peer. * **State** *(string) --* The current state of the route server peer. * **FailureReason** *(string) --* The reason for any failure in peer creation or operation. * **EndpointEniId** *(string) --* The ID of the Elastic network interface for the route server endpoint. * **EndpointEniAddress** *(string) --* The IP address of the Elastic network interface for the route server endpoint. * **PeerAddress** *(string) --* The IPv4 address of the peer device. * **BgpOptions** *(dict) --* The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. * **PeerAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * **PeerLivenessDetection** *(string) --* The liveness detection protocol used for the BGP peer. The requested liveness detection protocol for the BGP peer. * "bgp-keepalive": The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure. * "bfd": An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection. Defaults to "bgp-keepalive". * **BgpStatus** *(dict) --* The current status of the BGP session with this peer. * **Status** *(string) --* The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance. * **BfdStatus** *(dict) --* The current status of the BFD session with this peer. * **Status** *(string) --* The operational status of the BFD session. * **Tags** *(list) --* Any tags assigned to the route server peer. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Paginator / DescribeReservedInstancesModifications DescribeReservedInstancesModifications ************************************** class EC2.Paginator.DescribeReservedInstancesModifications paginator = client.get_paginator('describe_reserved_instances_modifications') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_reserved_instances_modifications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReservedInstancesModificationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } ) Parameters: * **ReservedInstancesModificationIds** (*list*) -- IDs for the submitted modification request. * *(string) --* * **Filters** (*list*) -- 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.availability- zone-id" - The ID of 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. * "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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ReservedInstancesModifications': [ { 'ClientToken': 'string', 'CreateDate': datetime(2015, 1, 1), 'EffectiveDate': datetime(2015, 1, 1), 'ModificationResults': [ { 'ReservedInstancesId': 'string', 'TargetConfiguration': { 'AvailabilityZone': 'string', 'InstanceCount': 123, 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'Platform': 'string', 'Scope': 'Availability Zone'|'Region', 'AvailabilityZoneId': 'string' } }, ], 'ReservedInstancesIds': [ { 'ReservedInstancesId': 'string' }, ], 'ReservedInstancesModificationId': 'string', 'Status': 'string', 'StatusMessage': 'string', 'UpdateDate': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeReservedInstancesModifications. * **ReservedInstancesModifications** *(list) --* The Reserved Instance modification information. * *(dict) --* Describes a Reserved Instance modification. * **ClientToken** *(string) --* A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency. * **CreateDate** *(datetime) --* The time when the modification request was created. * **EffectiveDate** *(datetime) --* The time for the modification to become effective. * **ModificationResults** *(list) --* Contains target configurations along with their corresponding new Reserved Instance IDs. * *(dict) --* Describes the modification request/s. * **ReservedInstancesId** *(string) --* The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled. * **TargetConfiguration** *(dict) --* The target Reserved Instances configurations supplied as part of the modification request. * **AvailabilityZone** *(string) --* The Availability Zone for the modified Reserved Instances. * **InstanceCount** *(integer) --* The number of modified Reserved Instances. Note: This is a required field for a request. * **InstanceType** *(string) --* The instance type for the modified Reserved Instances. * **Platform** *(string) --* The network platform of the modified Reserved Instances. * **Scope** *(string) --* Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. * **ReservedInstancesIds** *(list) --* The IDs of one or more Reserved Instances. * *(dict) --* Describes the ID of a Reserved Instance. * **ReservedInstancesId** *(string) --* The ID of the Reserved Instance. * **ReservedInstancesModificationId** *(string) --* A unique ID for the Reserved Instance modification. * **Status** *(string) --* The status of the Reserved Instances modification request. * **StatusMessage** *(string) --* The reason for the status. * **UpdateDate** *(datetime) --* The time when the modification request was last updated. EC2 / Paginator / DescribeMacHosts DescribeMacHosts **************** class EC2.Paginator.DescribeMacHosts paginator = client.get_paginator('describe_mac_hosts') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_mac_hosts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], HostIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- The filters. * "availability-zone" - The Availability Zone of the EC2 Mac Dedicated Host. * "instance-type" - The instance type size that the EC2 Mac Dedicated Host is configured to support. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **HostIds** (*list*) -- The IDs of the EC2 Mac Dedicated Hosts. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MacHosts': [ { 'HostId': 'string', 'MacOSLatestSupportedVersions': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **MacHosts** *(list) --* Information about the EC2 Mac Dedicated Hosts. * *(dict) --* Information about the EC2 Mac Dedicated Host. * **HostId** *(string) --* The EC2 Mac Dedicated Host ID. * **MacOSLatestSupportedVersions** *(list) --* The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded. * *(string) --* EC2 / Paginator / DescribePrincipalIdFormat DescribePrincipalIdFormat ************************* class EC2.Paginator.DescribePrincipalIdFormat paginator = client.get_paginator('describe_principal_id_format') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_principal_id_format()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DryRun=True|False, Resources=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Resources** (*list*) -- 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" * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Principals': [ { 'Arn': 'string', 'Statuses': [ { 'Deadline': datetime(2015, 1, 1), 'Resource': 'string', 'UseLongIds': True|False }, ] }, ], } **Response Structure** * *(dict) --* * **Principals** *(list) --* Information about the ID format settings for the ARN. * *(dict) --* PrincipalIdFormat description * **Arn** *(string) --* PrincipalIdFormatARN description * **Statuses** *(list) --* PrincipalIdFormatStatuses description * *(dict) --* Describes the ID format for a resource. * **Deadline** *(datetime) --* The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. * **Resource** *(string) --* The type of resource. * **UseLongIds** *(boolean) --* Indicates whether longer IDs (17-character IDs) are enabled for the resource. EC2 / Paginator / DescribeVerifiedAccessEndpoints DescribeVerifiedAccessEndpoints ******************************* class EC2.Paginator.DescribeVerifiedAccessEndpoints paginator = client.get_paginator('describe_verified_access_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_verified_access_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( VerifiedAccessEndpointIds=[ 'string', ], VerifiedAccessInstanceId='string', VerifiedAccessGroupId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **VerifiedAccessEndpointIds** (*list*) -- The ID of the Verified Access endpoint. * *(string) --* * **VerifiedAccessInstanceId** (*string*) -- The ID of the Verified Access instance. * **VerifiedAccessGroupId** (*string*) -- The ID of the Verified Access group. * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'VerifiedAccessEndpoints': [ { 'VerifiedAccessInstanceId': 'string', 'VerifiedAccessGroupId': 'string', 'VerifiedAccessEndpointId': 'string', 'ApplicationDomain': 'string', 'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr', 'AttachmentType': 'vpc', 'DomainCertificateArn': 'string', 'EndpointDomain': 'string', 'DeviceValidationDomain': 'string', 'SecurityGroupIds': [ 'string', ], 'LoadBalancerOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'LoadBalancerArn': 'string', 'SubnetIds': [ 'string', ], 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'NetworkInterfaceOptions': { 'NetworkInterfaceId': 'string', 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'Status': { 'Code': 'pending'|'active'|'updating'|'deleting'|'deleted', 'Message': 'string' }, 'Description': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'DeletionTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'RdsOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'RdsDbInstanceArn': 'string', 'RdsDbClusterArn': 'string', 'RdsDbProxyArn': 'string', 'RdsEndpoint': 'string', 'SubnetIds': [ 'string', ] }, 'CidrOptions': { 'Cidr': 'string', 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'Protocol': 'http'|'https'|'tcp', 'SubnetIds': [ 'string', ] } }, ], } **Response Structure** * *(dict) --* * **VerifiedAccessEndpoints** *(list) --* Details about the Verified Access endpoints. * *(dict) --* An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **VerifiedAccessGroupId** *(string) --* The ID of the Amazon Web Services Verified Access group. * **VerifiedAccessEndpointId** *(string) --* The ID of the Amazon Web Services Verified Access endpoint. * **ApplicationDomain** *(string) --* The DNS name for users to reach your application. * **EndpointType** *(string) --* The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. * **AttachmentType** *(string) --* The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application. * **DomainCertificateArn** *(string) --* The ARN of a public TLS/SSL certificate imported into or created with ACM. * **EndpointDomain** *(string) --* A DNS name that is generated for the endpoint. * **DeviceValidationDomain** *(string) --* Returned if endpoint has a device trust provider attached. * **SecurityGroupIds** *(list) --* The IDs of the security groups for the endpoint. * *(string) --* * **LoadBalancerOptions** *(dict) --* The load balancer details if creating the Amazon Web Services Verified Access endpoint as >>``< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'ResourceId': 'string', 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The tag key. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. * **Value** *(string) --* The tag value. EC2 / Paginator / GetTransitGatewayAttachmentPropagations GetTransitGatewayAttachmentPropagations *************************************** class EC2.Paginator.GetTransitGatewayAttachmentPropagations paginator = client.get_paginator('get_transit_gateway_attachment_propagations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_transit_gateway_attachment_propagations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayAttachmentId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the attachment. * **Filters** (*list*) -- One or more filters. The possible values are: * "transit-gateway-route-table-id" - The ID of the transit gateway route table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayAttachmentPropagations': [ { 'TransitGatewayRouteTableId': 'string', 'State': 'enabling'|'enabled'|'disabling'|'disabled' }, ], } **Response Structure** * *(dict) --* * **TransitGatewayAttachmentPropagations** *(list) --* Information about the propagation route tables. * *(dict) --* Describes a propagation route table. * **TransitGatewayRouteTableId** *(string) --* The ID of the propagation route table. * **State** *(string) --* The state of the propagation route table. EC2 / Paginator / GetTransitGatewayRouteTablePropagations GetTransitGatewayRouteTablePropagations *************************************** class EC2.Paginator.GetTransitGatewayRouteTablePropagations paginator = client.get_paginator('get_transit_gateway_route_table_propagations') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.get_transit_gateway_route_table_propagations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTablePropagations': [ { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'TransitGatewayRouteTableAnnouncementId': 'string' }, ], } **Response Structure** * *(dict) --* * **TransitGatewayRouteTablePropagations** *(list) --* Information about the route table propagations. * *(dict) --* Describes a route table propagation. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the resource. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. EC2 / Paginator / DescribeInstanceImageMetadata DescribeInstanceImageMetadata ***************************** class EC2.Paginator.DescribeInstanceImageMetadata paginator = client.get_paginator('describe_instance_image_metadata') paginate(**kwargs) Creates an iterator that will paginate through responses from "EC2.Client.describe_instance_image_metadata()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceIds=[ 'string', ], DryRun=True|False, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- The filters. * "availability-zone" - The name of the Availability Zone (for example, "us-west-2a") or Local Zone (for example, "us-west-2-lax-1b") of the instance. * "instance-id" - The ID of the instance. * "image-allowed" - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. * "instance-state-name" - The state of the instance ( "pending" | "running" | "shutting-down" | "terminated" | "stopping" | "stopped"). * "instance-type" - The type of instance (for example, "t3.micro"). * "launch-time" - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2023-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2023-09-29T*", which matches an entire day. * "owner-alias" - The owner alias ( "amazon" | "aws- marketplace" | "aws-backup-vault"). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the "Owner" request parameter instead of this filter. * "tag:" - 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. * "zone-id" - The ID of the Availability Zone (for example, "usw2-az2") or Local Zone (for example, "usw2-lax1-az1") of the instance. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceIds** (*list*) -- The instance IDs. If you don't specify an instance ID or filters, the output includes information for all instances. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'InstanceImageMetadata': [ { 'InstanceId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'LaunchTime': datetime(2015, 1, 1), 'AvailabilityZone': 'string', 'ZoneId': 'string', 'State': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ImageMetadata': { 'ImageId': 'string', 'Name': 'string', 'OwnerId': 'string', 'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error'|'disabled', 'ImageOwnerAlias': 'string', 'CreationDate': 'string', 'DeprecationTime': 'string', 'ImageAllowed': True|False, 'IsPublic': True|False }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], } **Response Structure** * *(dict) --* * **InstanceImageMetadata** *(list) --* Information about the instance and the AMI used to launch the instance. * *(dict) --* Information about the instance and the AMI used to launch the instance. * **InstanceId** *(string) --* The ID of the instance. * **InstanceType** *(string) --* The instance type. * **LaunchTime** *(datetime) --* The time the instance was launched. * **AvailabilityZone** *(string) --* The Availability Zone or Local Zone of the instance. * **ZoneId** *(string) --* The ID of the Availability Zone or Local Zone of the instance. * **State** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the instance. * **Tags** *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ImageMetadata** *(dict) --* Information about the AMI used to launch the instance. * **ImageId** *(string) --* The ID of the AMI. * **Name** *(string) --* The name of the AMI. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the AMI. * **State** *(string) --* The current state of the AMI. If the state is "available", the AMI is successfully registered and can be used to launch an instance. * **ImageOwnerAlias** *(string) --* The alias of the AMI owner. Valid values: "amazon" | "aws-backup-vault" | "aws- marketplace" * **CreationDate** *(string) --* The date and time the AMI was created. * **DeprecationTime** *(string) --* The deprecation date and time of the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<" - The key/value combination of a tag assigned to the event window. 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 "CMX", specify "tag:Owner" for the filter name and "CMX" for the filter value. * "tag-key" - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value. * "tag-value" - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call. * **NextToken** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'InstanceEventWindows': [ { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceEventWindows** *(list) --* Information about the event windows. * *(dict) --* The event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / export_verified_access_instance_client_configuration export_verified_access_instance_client_configuration **************************************************** EC2.Client.export_verified_access_instance_client_configuration(**kwargs) Exports the client configuration for a Verified Access instance. See also: AWS API Documentation **Request Syntax** response = client.export_verified_access_instance_client_configuration( VerifiedAccessInstanceId='string', DryRun=True|False ) Parameters: * **VerifiedAccessInstanceId** (*string*) -- **[REQUIRED]** The ID of the Verified Access instance. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Version': 'string', 'VerifiedAccessInstanceId': 'string', 'Region': 'string', 'DeviceTrustProviders': [ 'jamf'|'crowdstrike'|'jumpcloud', ], 'UserTrustProvider': { 'Type': 'iam-identity-center'|'oidc', 'Scopes': 'string', 'Issuer': 'string', 'AuthorizationEndpoint': 'string', 'PublicSigningKeyEndpoint': 'string', 'TokenEndpoint': 'string', 'UserInfoEndpoint': 'string', 'ClientId': 'string', 'ClientSecret': 'string', 'PkceEnabled': True|False }, 'OpenVpnConfigurations': [ { 'Config': 'string', 'Routes': [ { 'Cidr': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **Version** *(string) --* The version. * **VerifiedAccessInstanceId** *(string) --* The ID of the Verified Access instance. * **Region** *(string) --* The Region. * **DeviceTrustProviders** *(list) --* The device trust providers. * *(string) --* * **UserTrustProvider** *(dict) --* The user identity trust provider. * **Type** *(string) --* The trust provider type. * **Scopes** *(string) --* The set of user claims to be requested from the IdP. * **Issuer** *(string) --* The OIDC issuer identifier of the IdP. * **AuthorizationEndpoint** *(string) --* The authorization endpoint of the IdP. * **PublicSigningKeyEndpoint** *(string) --* The public signing key endpoint. * **TokenEndpoint** *(string) --* The token endpoint of the IdP. * **UserInfoEndpoint** *(string) --* The user info endpoint of the IdP. * **ClientId** *(string) --* The OAuth 2.0 client identifier. * **ClientSecret** *(string) --* The OAuth 2.0 client secret. * **PkceEnabled** *(boolean) --* Indicates whether Proof of Key Code Exchange (PKCE) is enabled. * **OpenVpnConfigurations** *(list) --* The Open VPN configuration. * *(dict) --* Describes a set of routes. * **Config** *(string) --* The base64-encoded Open VPN client configuration. * **Routes** *(list) --* The routes. * *(dict) --* Describes a route. * **Cidr** *(string) --* The CIDR block. EC2 / Client / delete_ipam delete_ipam *********** EC2.Client.delete_ipam(**kwargs) Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see Delete an IPAM in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_ipam( DryRun=True|False, IpamId='string', Cascade=True|False ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamId** (*string*) -- **[REQUIRED]** The ID of the IPAM to delete. * **Cascade** (*boolean*) -- Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following: * Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes. Note: No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged. * Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes. * Deletes all IPAM pools in private scopes. * Deletes all non-default private scopes in the IPAM. * Deletes the default public and private scopes and the IPAM. Return type: dict Returns: **Response Syntax** { 'Ipam': { 'OwnerId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'PublicDefaultScopeId': 'string', 'PrivateDefaultScopeId': 'string', 'ScopeCount': 123, 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DefaultResourceDiscoveryId': 'string', 'DefaultResourceDiscoveryAssociationId': 'string', 'ResourceDiscoveryAssociationCount': 123, 'StateMessage': 'string', 'Tier': 'free'|'advanced', 'EnablePrivateGua': True|False, 'MeteredAccount': 'ipam-owner'|'resource-owner' } } **Response Structure** * *(dict) --* * **Ipam** *(dict) --* Information about the results of the deletion. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM. * **IpamId** *(string) --* The ID of the IPAM. * **IpamArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM. * **PublicDefaultScopeId** *(string) --* The ID of the IPAM's default public scope. * **PrivateDefaultScopeId** *(string) --* The ID of the IPAM's default private scope. * **ScopeCount** *(integer) --* The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **Description** *(string) --* The description for the IPAM. * **OperatingRegions** *(list) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **State** *(string) --* The state of the IPAM. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DefaultResourceDiscoveryId** *(string) --* The IPAM's default resource discovery ID. * **DefaultResourceDiscoveryAssociationId** *(string) --* The IPAM's default resource discovery association ID. * **ResourceDiscoveryAssociationCount** *(integer) --* The IPAM's resource discovery association count. * **StateMessage** *(string) --* The state message. * **Tier** *(string) --* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** *(boolean) --* Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** *(string) --* A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. EC2 / Client / cancel_conversion_task cancel_conversion_task ********************** EC2.Client.cancel_conversion_task(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.cancel_conversion_task( DryRun=True|False, ConversionTaskId='string', ReasonMessage='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConversionTaskId** (*string*) -- **[REQUIRED]** The ID of the conversion task. * **ReasonMessage** (*string*) -- The reason for canceling the conversion task. Returns: None EC2 / Client / describe_carrier_gateways describe_carrier_gateways ************************* EC2.Client.describe_carrier_gateways(**kwargs) Describes one or more of your carrier gateways. See also: AWS API Documentation **Request Syntax** response = client.describe_carrier_gateways( CarrierGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **CarrierGatewayIds** (*list*) -- One or more carrier gateway IDs. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account ID of the owner of the carrier gateway. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CarrierGateways': [ { 'CarrierGatewayId': 'string', 'VpcId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CarrierGateways** *(list) --* Information about the carrier gateway. * *(dict) --* Describes a carrier gateway. * **CarrierGatewayId** *(string) --* The ID of the carrier gateway. * **VpcId** *(string) --* The ID of the VPC associated with the carrier gateway. * **State** *(string) --* The state of the carrier gateway. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the carrier gateway. * **Tags** *(list) --* The tags assigned to the carrier gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / restore_address_to_classic restore_address_to_classic ************************** EC2.Client.restore_address_to_classic(**kwargs) Note: This action is deprecated. 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. See also: AWS API Documentation **Request Syntax** response = client.restore_address_to_classic( DryRun=True|False, PublicIp='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PublicIp** (*string*) -- **[REQUIRED]** The Elastic IP address. Return type: dict Returns: **Response Syntax** { 'PublicIp': 'string', 'Status': 'MoveInProgress'|'InVpc'|'InClassic' } **Response Structure** * *(dict) --* * **PublicIp** *(string) --* The Elastic IP address. * **Status** *(string) --* The move status for the IP address. **Examples** This example restores the specified Elastic IP address to the EC2-Classic platform. response = client.restore_address_to_classic( PublicIp='198.51.100.0', ) print(response) Expected Output: { 'PublicIp': '198.51.100.0', 'Status': 'MoveInProgress', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / get_ipam_pool_cidrs get_ipam_pool_cidrs ******************* EC2.Client.get_ipam_pool_cidrs(**kwargs) Get the CIDRs provisioned to an IPAM pool. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_pool_cidrs( DryRun=True|False, IpamPoolId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamPoolId** (*string*) -- **[REQUIRED]** The ID of the IPAM pool you want the CIDR for. * **Filters** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return in the request. * **NextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'IpamPoolCidrs': [ { 'Cidr': 'string', 'State': 'pending-provision'|'provisioned'|'failed-provision'|'pending-deprovision'|'deprovisioned'|'failed-deprovision'|'pending-import'|'failed-import', 'FailureReason': { 'Code': 'cidr-not-available'|'limit-exceeded', 'Message': 'string' }, 'IpamPoolCidrId': 'string', 'NetmaskLength': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IpamPoolCidrs** *(list) --* Information about the CIDRs provisioned to an IPAM pool. * *(dict) --* A CIDR provisioned to an IPAM pool. * **Cidr** *(string) --* The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is "10.24.34.0/23". An IPv6 CIDR example is "2001:DB8::/32". * **State** *(string) --* The state of the CIDR. * **FailureReason** *(dict) --* Details related to why an IPAM pool CIDR failed to be provisioned. * **Code** *(string) --* An error code related to why an IPAM pool CIDR failed to be provisioned. * **Message** *(string) --* A message related to why an IPAM pool CIDR failed to be provisioned. * **IpamPoolCidrId** *(string) --* The IPAM pool CIDR ID. * **NetmaskLength** *(integer) --* The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / delete_local_gateway_route_table delete_local_gateway_route_table ******************************** EC2.Client.delete_local_gateway_route_table(**kwargs) Deletes a local gateway route table. See also: AWS API Documentation **Request Syntax** response = client.delete_local_gateway_route_table( LocalGatewayRouteTableId='string', DryRun=True|False ) Parameters: * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTable': { 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'OutpostArn': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Mode': 'direct-vpc-routing'|'coip', 'StateReason': { 'Code': 'string', 'Message': 'string' } } } **Response Structure** * *(dict) --* * **LocalGatewayRouteTable** *(dict) --* Information about the local gateway route table. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table. * **State** *(string) --* The state of the local gateway route table. * **Tags** *(list) --* The tags assigned to the local gateway route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Mode** *(string) --* The mode of the local gateway route table. * **StateReason** *(dict) --* Information about the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. EC2 / Client / delete_nat_gateway delete_nat_gateway ****************** EC2.Client.delete_nat_gateway(**kwargs) Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. See also: AWS API Documentation **Request Syntax** response = client.delete_nat_gateway( DryRun=True|False, NatGatewayId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NatGatewayId** (*string*) -- **[REQUIRED]** The ID of the NAT gateway. Return type: dict Returns: **Response Syntax** { 'NatGatewayId': 'string' } **Response Structure** * *(dict) --* * **NatGatewayId** *(string) --* The ID of the NAT gateway. **Examples** This example deletes the specified NAT gateway. response = client.delete_nat_gateway( NatGatewayId='nat-04ae55e711cec5680', ) print(response) Expected Output: { 'NatGatewayId': 'nat-04ae55e711cec5680', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / enable_transit_gateway_route_table_propagation enable_transit_gateway_route_table_propagation ********************************************** EC2.Client.enable_transit_gateway_route_table_propagation(**kwargs) Enables the specified attachment to propagate routes to the specified propagation route table. See also: AWS API Documentation **Request Syntax** response = client.enable_transit_gateway_route_table_propagation( TransitGatewayRouteTableId='string', TransitGatewayAttachmentId='string', DryRun=True|False, TransitGatewayRouteTableAnnouncementId='string' ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the propagation route table. * **TransitGatewayAttachmentId** (*string*) -- The ID of the attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **TransitGatewayRouteTableAnnouncementId** (*string*) -- The ID of the transit gateway route table announcement. Return type: dict Returns: **Response Syntax** { 'Propagation': { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'TransitGatewayRouteTableId': 'string', 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'TransitGatewayRouteTableAnnouncementId': 'string' } } **Response Structure** * *(dict) --* * **Propagation** *(dict) --* Information about route propagation. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **State** *(string) --* The state. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. EC2 / Client / associate_vpc_cidr_block associate_vpc_cidr_block ************************ EC2.Client.associate_vpc_cidr_block(**kwargs) Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses ( BYOIP). You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block. For more information about associating CIDR blocks with your VPC and applicable restrictions, see IP addressing for your VPCs and subnets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_vpc_cidr_block( CidrBlock='string', Ipv6CidrBlockNetworkBorderGroup='string', Ipv6Pool='string', Ipv6CidrBlock='string', Ipv4IpamPoolId='string', Ipv4NetmaskLength=123, Ipv6IpamPoolId='string', Ipv6NetmaskLength=123, VpcId='string', AmazonProvidedIpv6CidrBlock=True|False ) Parameters: * **CidrBlock** (*string*) -- An IPv4 CIDR block to associate with the VPC. * **Ipv6CidrBlockNetworkBorderGroup** (*string*) -- 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** (*string*) -- The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. * **Ipv6CidrBlock** (*string*) -- 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. * **Ipv4IpamPoolId** (*string*) -- Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv4NetmaskLength** (*integer*) -- The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv6IpamPoolId** (*string*) -- Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv6NetmaskLength** (*integer*) -- The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **AmazonProvidedIpv6CidrBlock** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'Ipv6CidrBlockAssociation': { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'NetworkBorderGroup': 'string', 'Ipv6Pool': 'string', 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, 'CidrBlockAssociation': { 'AssociationId': 'string', 'CidrBlock': 'string', 'CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' } }, 'VpcId': 'string' } **Response Structure** * *(dict) --* * **Ipv6CidrBlockAssociation** *(dict) --* Information about the IPv6 CIDR block association. * **AssociationId** *(string) --* The association ID for the IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, "us-east-1-wl1-bos- wlz-1". * **Ipv6Pool** *(string) --* The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **CidrBlockAssociation** *(dict) --* Information about the IPv4 CIDR block association. * **AssociationId** *(string) --* The association ID for the IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **VpcId** *(string) --* The ID of the VPC. EC2 / Client / create_managed_prefix_list create_managed_prefix_list ************************** EC2.Client.create_managed_prefix_list(**kwargs) Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description. See also: AWS API Documentation **Request Syntax** response = client.create_managed_prefix_list( DryRun=True|False, PrefixListName='string', Entries=[ { 'Cidr': 'string', 'Description': 'string' }, ], MaxEntries=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], AddressFamily='string', ClientToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** A name for the prefix list. Constraints: Up to 255 characters in length. The name cannot start with "com.amazonaws". * **Entries** (*list*) -- One or more entries for the prefix list. * *(dict) --* An entry for a prefix list. * **Cidr** *(string) --* **[REQUIRED]** The CIDR block. * **Description** *(string) --* A description for the entry. Constraints: Up to 255 characters in length. * **MaxEntries** (*integer*) -- **[REQUIRED]** The maximum number of entries for the prefix list. * **TagSpecifications** (*list*) -- The tags to apply to the prefix list during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AddressFamily** (*string*) -- **[REQUIRED]** The IP address type. Valid Values: "IPv4" | "IPv6" * **ClientToken** (*string*) -- 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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'PrefixList': { 'PrefixListId': 'string', 'AddressFamily': 'string', 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed', 'StateMessage': 'string', 'PrefixListArn': 'string', 'PrefixListName': 'string', 'MaxEntries': 123, 'Version': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OwnerId': 'string' } } **Response Structure** * *(dict) --* * **PrefixList** *(dict) --* Information about the prefix list. * **PrefixListId** *(string) --* The ID of the prefix list. * **AddressFamily** *(string) --* The IP address version. * **State** *(string) --* The current state of the prefix list. * **StateMessage** *(string) --* The state message. * **PrefixListArn** *(string) --* The Amazon Resource Name (ARN) for the prefix list. * **PrefixListName** *(string) --* The name of the prefix list. * **MaxEntries** *(integer) --* The maximum number of entries for the prefix list. * **Version** *(integer) --* The version of the prefix list. * **Tags** *(list) --* The tags for the prefix list. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OwnerId** *(string) --* The ID of the owner of the prefix list. EC2 / Client / disable_serial_console_access disable_serial_console_access ***************************** EC2.Client.disable_serial_console_access(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.disable_serial_console_access( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SerialConsoleAccessEnabled': True|False } **Response Structure** * *(dict) --* * **SerialConsoleAccessEnabled** *(boolean) --* If "true", access to the EC2 serial console of all instances is enabled for your account. If "false", access to the EC2 serial console of all instances is disabled for your account. EC2 / Client / describe_transit_gateway_peering_attachments describe_transit_gateway_peering_attachments ******************************************** EC2.Client.describe_transit_gateway_peering_attachments(**kwargs) Describes your transit gateway peering attachments. See also: AWS API Documentation **Request Syntax** response = client.describe_transit_gateway_peering_attachments( TransitGatewayAttachmentIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayAttachmentIds** (*list*) -- One or more IDs of the transit gateway peering attachments. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account. * "remote-owner-id" - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway. * "state" - The state of the peering attachment. Valid values are "available" | "deleted" | "deleting" | "failed" | "failing" | "initiatingRequest" | "modifying" | "pendingAcceptance" | "pending" | "rollingBack" | "rejected" | "rejecting"). * "tag": - 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. * "transit-gateway-id" - The ID of the transit gateway. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPeeringAttachments': [ { 'TransitGatewayAttachmentId': 'string', 'AccepterTransitGatewayAttachmentId': 'string', 'RequesterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'AccepterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'Options': { 'DynamicRouting': 'enable'|'disable' }, 'Status': { 'Code': 'string', 'Message': 'string' }, 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayPeeringAttachments** *(list) --* The transit gateway peering attachments. * *(dict) --* Describes the transit gateway peering attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway peering attachment. * **AccepterTransitGatewayAttachmentId** *(string) --* The ID of the accepter transit gateway attachment. * **RequesterTgwInfo** *(dict) --* Information about the requester transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **AccepterTgwInfo** *(dict) --* Information about the accepter transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **Options** *(dict) --* Details about the transit gateway peering attachment. * **DynamicRouting** *(string) --* Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment. * **Status** *(dict) --* The status of the transit gateway peering attachment. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message, if applicable. * **State** *(string) --* The state of the transit gateway peering attachment. Note that the "initiating" state has been deprecated. * **CreationTime** *(datetime) --* The time the transit gateway peering attachment was created. * **Tags** *(list) --* The tags for the transit gateway peering attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / create_snapshot create_snapshot *************** EC2.Client.create_snapshot(**kwargs) Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. The location of the source EBS volume determines where you can create the snapshot. * If the source volume is in a Region, you must create the snapshot in the same Region as the volume. * If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services Region. * If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent Amazon Web Services Region. When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is "pending". When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. For more information, see Amazon EBS encryption in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_snapshot( Description='string', OutpostArn='string', VolumeId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], Location='regional'|'local', DryRun=True|False ) Parameters: * **Description** (*string*) -- A description for the snapshot. * **OutpostArn** (*string*) -- Note: Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter. * To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume. * To create the snapshot in the parent Region of the Outpost, omit this parameter. For more information, see Create local snapshots from volumes on an Outpost in the *Amazon EBS User Guide*. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the Amazon EBS volume. * **TagSpecifications** (*list*) -- The tags to apply to the snapshot during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Location** (*string*) -- Note: Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter. * To create a local snapshot in the same Local Zone as the source volume, specify "local". * To create a regional snapshot in the parent Region of the Local Zone, specify "regional" or omit this parameter. Default value: "regional" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'OwnerAlias': 'string', 'OutpostArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'StorageTier': 'archive'|'standard', 'RestoreExpiryTime': datetime(2015, 1, 1), 'SseType': 'sse-ebs'|'sse-kms'|'none', 'AvailabilityZone': 'string', 'TransferType': 'time-based'|'standard', 'CompletionDurationMinutes': 123, 'CompletionTime': datetime(2015, 1, 1), 'FullSnapshotSizeInBytes': 123, 'SnapshotId': 'string', 'VolumeId': 'string', 'State': 'pending'|'completed'|'error'|'recoverable'|'recovering', 'StateMessage': 'string', 'StartTime': datetime(2015, 1, 1), 'Progress': 'string', 'OwnerId': 'string', 'Description': 'string', 'VolumeSize': 123, 'Encrypted': True|False, 'KmsKeyId': 'string', 'DataEncryptionKeyId': 'string' } **Response Structure** * *(dict) --* Describes a snapshot. * **OwnerAlias** *(string) --* The Amazon Web Services owner alias, from an Amazon- maintained list ( "amazon"). This is not the user-configured Amazon Web Services account alias set using the IAM console. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the *Amazon EBS User Guide*. * **Tags** *(list) --* Any tags assigned to the snapshot. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **StorageTier** *(string) --* The storage tier in which the snapshot is stored. "standard" indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. "archive" indicates that the snapshot is currently archived and that it must be restored before it can be used. * **RestoreExpiryTime** *(datetime) --* Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. * **SseType** *(string) --* Reserved for future use. * **AvailabilityZone** *(string) --* The Availability Zone or Local Zone of the snapshot. For example, "us-west-1a" (Availability Zone) or "us-west-2-lax- 1a" (Local Zone). * **TransferType** *(string) --* Note: Only for snapshot copies. Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis. * "standard" - The snapshot copy was created with a standard snapshot copy operation. * "time-based" - The snapshot copy was created with a time- based snapshot copy operation. * **CompletionDurationMinutes** *(integer) --* Note: Only for snapshot copies created with time-based snapshot copy operations. The completion duration requested for the time-based snapshot copy operation. * **CompletionTime** *(datetime) --* The time stamp when the snapshot was completed. * **FullSnapshotSizeInBytes** *(integer) --* The full size of the snapshot, in bytes. Warning: This is **not** the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created. * **SnapshotId** *(string) --* The ID of the snapshot. Each snapshot receives a unique identifier when it is created. * **VolumeId** *(string) --* The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose. * **State** *(string) --* The snapshot state. * **StateMessage** *(string) --* Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. * **StartTime** *(datetime) --* The time stamp when the snapshot was initiated. * **Progress** *(string) --* The progress of the snapshot, as a percentage. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the EBS snapshot. * **Description** *(string) --* The description for the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiB. * **Encrypted** *(boolean) --* Indicates whether the snapshot is encrypted. * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume. * **DataEncryptionKeyId** *(string) --* The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots. **Examples** This example creates a snapshot of the volume with a volume ID of "vol-1234567890abcdef0" and a short description to identify the snapshot. response = client.create_snapshot( Description='This is my root volume snapshot.', VolumeId='vol-1234567890abcdef0', ) print(response) Expected Output: { 'Description': 'This is my root volume snapshot.', 'OwnerId': '012345678910', 'SnapshotId': 'snap-066877671789bd71b', 'StartTime': datetime(2014, 2, 28, 21, 6, 1, 4, 59, 0), 'State': 'pending', 'Tags': [ ], 'VolumeId': 'vol-1234567890abcdef0', 'VolumeSize': 8, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_id_format modify_id_format **************** EC2.Client.modify_id_format(**kwargs) Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: "bundle" | "conversion- task" | "customer-gateway" | "dhcp-options" | "elastic-ip- allocation" | "elastic-ip-association" | "export-task" | "flow-log" | "image" | "import-task" | "internet-gateway" | "network-acl" | "network-acl-association" | "network-interface" | "network- interface-attachment" | "prefix-list" | "route-table" | "route- table-association" | "security-group" | "subnet" | "subnet-cidr- block-association" | "vpc" | "vpc-cidr-block-association" | "vpc- endpoint" | "vpc-peering-connection" | "vpn-connection" | "vpn- gateway". This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the *Amazon Elastic Compute Cloud User Guide*. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant "Describe" command for the resource type. See also: AWS API Documentation **Request Syntax** response = client.modify_id_format( Resource='string', UseLongIds=True|False ) Parameters: * **Resource** (*string*) -- **[REQUIRED]** 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. * **UseLongIds** (*boolean*) -- **[REQUIRED]** Indicate whether the resource should use longer IDs (17-character IDs). Returns: None EC2 / Client / describe_availability_zones describe_availability_zones *************************** EC2.Client.describe_availability_zones(**kwargs) Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the *Amazon EC2 User Guide*. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_availability_zones( ZoneNames=[ 'string', ], ZoneIds=[ 'string', ], AllAvailabilityZones=True|False, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **ZoneNames** (*list*) -- The names of the Availability Zones, Local Zones, and Wavelength Zones. * *(string) --* * **ZoneIds** (*list*) -- The IDs of the Availability Zones, Local Zones, and Wavelength Zones. * *(string) --* * **AllAvailabilityZones** (*boolean*) -- 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. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "group-long-name" - The long name of the zone group for the Availability Zone (for example, "US West (Oregon) 1"), the Local Zone (for example, for Zone group "us-west-2-lax-1", it is "US West (Los Angeles)", or the Wavelength Zone (for example, for Zone group "us-east-1-wl1", it is "US East (Verizon)". * "group-name" - The name of the zone group for the Availability Zone (for example, "us-east-1-zg-1"), the Local Zone (for example, "us-west-2-lax-1"), or the Wavelength Zone (for example, "us-east-1-wl1"). * "message" - The Zone message. * "opt-in-status" - The opt-in status ( "opted-in" | "not- opted-in" | "opt-in-not-required"). * "parent-zone-id" - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. * "parent-zone-name" - 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" | "unavailable" | "constrained"). * "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-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 ( "availability-zone" | "local-zone" | "wavelength-zone"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'AvailabilityZones': [ { 'OptInStatus': 'opt-in-not-required'|'opted-in'|'not-opted-in', 'Messages': [ { 'Message': 'string' }, ], 'RegionName': 'string', 'ZoneName': 'string', 'ZoneId': 'string', 'GroupName': 'string', 'NetworkBorderGroup': 'string', 'ZoneType': 'string', 'ParentZoneName': 'string', 'ParentZoneId': 'string', 'GroupLongName': 'string', 'State': 'available'|'information'|'impaired'|'unavailable'|'constrained' }, ] } **Response Structure** * *(dict) --* * **AvailabilityZones** *(list) --* Information about the Availability Zones, Local Zones, and Wavelength Zones. * *(dict) --* Describes Availability Zones, Local Zones, and Wavelength Zones. * **OptInStatus** *(string) --* For Availability Zones, this parameter always has the value of "opt-in-not-required". For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are "opted-in" and "not-opted-in". * **Messages** *(list) --* Any messages about the Availability Zone, Local Zone, or Wavelength Zone. * *(dict) --* Describes a message about an Availability Zone, Local Zone, or Wavelength Zone. * **Message** *(string) --* The message about the Availability Zone, Local Zone, or Wavelength Zone. * **RegionName** *(string) --* The name of the Region. * **ZoneName** *(string) --* The name of the Availability Zone, Local Zone, or Wavelength Zone. * **ZoneId** *(string) --* The ID of the Availability Zone, Local Zone, or Wavelength Zone. * **GroupName** *(string) --* The name of the zone group. For example: * Availability Zones - "us-east-1-zg-1" * Local Zones - "us-west-2-lax-1" * Wavelength Zones - "us-east-1-wl1-bos-wlz-1" * **NetworkBorderGroup** *(string) --* The name of the network border group. * **ZoneType** *(string) --* The type of zone. Valid values: "availability-zone" | "local-zone" | "wavelength-zone" * **ParentZoneName** *(string) --* The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. * **ParentZoneId** *(string) --* The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. * **GroupLongName** *(string) --* The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group. * **State** *(string) --* The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are "available", "unavailable", and "constrained". **Examples** This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region. response = client.describe_availability_zones( ) print(response) Expected Output: { 'AvailabilityZones': [ { 'Messages': [ ], 'RegionName': 'us-east-1', 'State': 'available', 'ZoneName': 'us-east-1b', }, { 'Messages': [ ], 'RegionName': 'us-east-1', 'State': 'available', 'ZoneName': 'us-east-1c', }, { 'Messages': [ ], 'RegionName': 'us-east-1', 'State': 'available', 'ZoneName': 'us-east-1d', }, { 'Messages': [ ], 'RegionName': 'us-east-1', 'State': 'available', 'ZoneName': 'us-east-1e', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / get_paginator get_paginator ************* EC2.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. EC2 / Client / reject_transit_gateway_multicast_domain_associations reject_transit_gateway_multicast_domain_associations **************************************************** EC2.Client.reject_transit_gateway_multicast_domain_associations(**kwargs) Rejects a request to associate cross-account subnets with a transit gateway multicast domain. See also: AWS API Documentation **Request Syntax** response = client.reject_transit_gateway_multicast_domain_associations( TransitGatewayMulticastDomainId='string', TransitGatewayAttachmentId='string', SubnetIds=[ 'string', ], DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- The ID of the transit gateway multicast domain. * **TransitGatewayAttachmentId** (*string*) -- The ID of the transit gateway attachment. * **SubnetIds** (*list*) -- The IDs of the subnets to associate with the transit gateway multicast domain. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Associations': { 'TransitGatewayMulticastDomainId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceOwnerId': 'string', 'Subnets': [ { 'SubnetId': 'string', 'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed' }, ] } } **Response Structure** * *(dict) --* * **Associations** *(dict) --* Information about the multicast domain associations. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource, for example a VPC attachment. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the resource. * **Subnets** *(list) --* The subnets associated with the multicast domain. * *(dict) --* Describes the subnet association with the transit gateway multicast domain. * **SubnetId** *(string) --* The ID of the subnet. * **State** *(string) --* The state of the subnet association. EC2 / Client / modify_instance_metadata_options modify_instance_metadata_options ******************************** EC2.Client.modify_instance_metadata_options(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.modify_instance_metadata_options( InstanceId='string', HttpTokens='optional'|'required', HttpPutResponseHopLimit=123, HttpEndpoint='disabled'|'enabled', DryRun=True|False, HttpProtocolIpv6='disabled'|'enabled', InstanceMetadataTags='disabled'|'enabled' ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **HttpTokens** (*string*) -- Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. * "required" - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. Default: * If the value of "ImdsSupport" for the Amazon Machine Image (AMI) for your instance is "v2.0" and the account level default is set to "no-preference", the default is "required". * If the value of "ImdsSupport" for the Amazon Machine Image (AMI) for your instance is "v2.0", but the account level default is set to "V1 or V2", the default is "optional". The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the *Amazon EC2 User Guide*. * **HttpPutResponseHopLimit** (*integer*) -- 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 * **HttpEndpoint** (*string*) -- Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained. If you specify a value of "disabled", you cannot access your instance metadata. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **HttpProtocolIpv6** (*string*) -- Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint. * **InstanceMetadataTags** (*string*) -- Set to "enabled" to allow access to instance tags from the instance metadata. Set to "disabled" to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata. Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'InstanceMetadataOptions': { 'State': 'pending'|'applied', 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' } } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The ID of the instance. * **InstanceMetadataOptions** *(dict) --* The metadata options for the instance. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. * "required" - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. * **HttpPutResponseHopLimit** *(integer) --* The maximum number of hops that the metadata token can travel. Possible values: Integers from "1" to "64" * **HttpEndpoint** *(string) --* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is "disabled", you cannot access your instance metadata. * **HttpProtocolIpv6** *(string) --* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Default: "disabled" * **InstanceMetadataTags** *(string) --* Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata. EC2 / Client / modify_volume_attribute modify_volume_attribute *********************** EC2.Client.modify_volume_attribute(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_volume_attribute( AutoEnableIO={ 'Value': True|False }, VolumeId='string', DryRun=True|False ) Parameters: * **AutoEnableIO** (*dict*) -- Indicates whether the volume should be auto-enabled for I/O operations. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the volume. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None **Examples** This example sets the "autoEnableIo" attribute of the volume with the ID "vol-1234567890abcdef0" to "true". If the command succeeds, no output is returned. response = client.modify_volume_attribute( AutoEnableIO={ 'Value': True, }, DryRun=True, VolumeId='vol-1234567890abcdef0', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_vpc_endpoint_connection_notifications delete_vpc_endpoint_connection_notifications ******************************************** EC2.Client.delete_vpc_endpoint_connection_notifications(**kwargs) Deletes the specified VPC endpoint connection notifications. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_endpoint_connection_notifications( DryRun=True|False, ConnectionNotificationIds=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConnectionNotificationIds** (*list*) -- **[REQUIRED]** The IDs of the notifications. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **Unsuccessful** *(list) --* Information about the notifications that could not be deleted successfully. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / describe_security_group_vpc_associations describe_security_group_vpc_associations **************************************** EC2.Client.describe_security_group_vpc_associations(**kwargs) Describes security group VPC associations made with AssociateSecurityGroupVpc. See also: AWS API Documentation **Request Syntax** response = client.describe_security_group_vpc_associations( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **Filters** (*list*) -- Security group VPC association filters. * "group-id": The security group ID. * "group-owner-id": The group owner ID. * "vpc-id": The ID of the associated VPC. * "vpc-owner-id": The account ID of the VPC owner. * "state": The state of the association. * "tag:": 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SecurityGroupVpcAssociations': [ { 'GroupId': 'string', 'VpcId': 'string', 'VpcOwnerId': 'string', 'State': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated'|'disassociation-failed', 'StateReason': 'string', 'GroupOwnerId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SecurityGroupVpcAssociations** *(list) --* The security group VPC associations. * *(dict) --* A security group association with a VPC that you made with AssociateSecurityGroupVpc. * **GroupId** *(string) --* The association's security group ID. * **VpcId** *(string) --* The association's VPC ID. * **VpcOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the VPC. * **State** *(string) --* The association's state. * **StateReason** *(string) --* The association's state reason. * **GroupOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the security group. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / create_nat_gateway create_nat_gateway ****************** EC2.Client.create_nat_gateway(**kwargs) Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway. With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet. With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks. For more information, see NAT gateways in the *Amazon VPC User Guide*. Warning: When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_nat_gateway( AllocationId='string', ClientToken='string', DryRun=True|False, SubnetId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ConnectivityType='private'|'public', PrivateIpAddress='string', SecondaryAllocationIds=[ 'string', ], SecondaryPrivateIpAddresses=[ 'string', ], SecondaryPrivateIpAddressCount=123 ) Parameters: * **AllocationId** (*string*) -- [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. Constraint: Maximum 64 ASCII characters. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the subnet in which to create the NAT gateway. * **TagSpecifications** (*list*) -- The tags to assign to the NAT gateway. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConnectivityType** (*string*) -- Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. * **PrivateIpAddress** (*string*) -- The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. * **SecondaryAllocationIds** (*list*) -- Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the *Amazon VPC User Guide*. * *(string) --* * **SecondaryPrivateIpAddresses** (*list*) -- Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the *Amazon VPC User Guide*. * *(string) --* * **SecondaryPrivateIpAddressCount** (*integer*) -- [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see Create a NAT gateway in the *Amazon VPC User Guide*. Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string', 'NatGateway': { 'CreateTime': datetime(2015, 1, 1), 'DeleteTime': datetime(2015, 1, 1), 'FailureCode': 'string', 'FailureMessage': 'string', 'NatGatewayAddresses': [ { 'AllocationId': 'string', 'NetworkInterfaceId': 'string', 'PrivateIp': 'string', 'PublicIp': 'string', 'AssociationId': 'string', 'IsPrimary': True|False, 'FailureMessage': 'string', 'Status': 'assigning'|'unassigning'|'associating'|'disassociating'|'succeeded'|'failed' }, ], 'NatGatewayId': 'string', 'ProvisionedBandwidth': { 'ProvisionTime': datetime(2015, 1, 1), 'Provisioned': 'string', 'RequestTime': datetime(2015, 1, 1), 'Requested': 'string', 'Status': 'string' }, 'State': 'pending'|'failed'|'available'|'deleting'|'deleted', 'SubnetId': 'string', 'VpcId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConnectivityType': 'private'|'public' } } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. * **NatGateway** *(dict) --* Information about the NAT gateway. * **CreateTime** *(datetime) --* The date and time the NAT gateway was created. * **DeleteTime** *(datetime) --* The date and time the NAT gateway was deleted, if applicable. * **FailureCode** *(string) --* If the NAT gateway could not be created, specifies the error code for the failure. ( "InsufficientFreeAddressesInSubnet" | "Gateway.NotAttached" | "InvalidAllocationID.NotFound" | "Resource.AlreadyAssociated" | "InternalError" | "InvalidSubnetID.NotFound") * **FailureMessage** *(string) --* If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code. * For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway" * For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached" * For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway" * For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated" * For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again." * For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found." * **NatGatewayAddresses** *(list) --* Information about the IP addresses and network interface associated with the NAT gateway. * *(dict) --* Describes the IP addresses and network interface associated with a NAT gateway. * **AllocationId** *(string) --* [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. * **NetworkInterfaceId** *(string) --* The ID of the network interface associated with the NAT gateway. * **PrivateIp** *(string) --* The private IP address associated with the NAT gateway. * **PublicIp** *(string) --* [Public NAT gateway only] The Elastic IP address associated with the NAT gateway. * **AssociationId** *(string) --* [Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway. * **IsPrimary** *(boolean) --* Defines if the IP address is the primary address. * **FailureMessage** *(string) --* The address failure message. * **Status** *(string) --* The address status. * **NatGatewayId** *(string) --* The ID of the NAT gateway. * **ProvisionedBandwidth** *(dict) --* Reserved. If you need to sustain traffic greater than the documented limits, contact Amazon Web Services Support. * **ProvisionTime** *(datetime) --* Reserved. * **Provisioned** *(string) --* Reserved. * **RequestTime** *(datetime) --* Reserved. * **Requested** *(string) --* Reserved. * **Status** *(string) --* Reserved. * **State** *(string) --* The state of the NAT gateway. * "pending": The NAT gateway is being created and is not ready to process traffic. * "failed": The NAT gateway could not be created. Check the "failureCode" and "failureMessage" fields for the reason. * "available": The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. * "deleting": The NAT gateway is in the process of being terminated and may still be processing traffic. * "deleted": The NAT gateway has been terminated and is no longer processing traffic. * **SubnetId** *(string) --* The ID of the subnet in which the NAT gateway is located. * **VpcId** *(string) --* The ID of the VPC in which the NAT gateway is located. * **Tags** *(list) --* The tags for the NAT gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConnectivityType** *(string) --* Indicates whether the NAT gateway supports public or private connectivity. **Examples** This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc- 37fc1a52 with the NAT gateway. response = client.create_nat_gateway( AllocationId='eipalloc-37fc1a52', SubnetId='subnet-1a2b3c4d', ) print(response) Expected Output: { 'NatGateway': { 'CreateTime': datetime(2015, 12, 17, 12, 45, 26, 3, 351, 0), 'NatGatewayAddresses': [ { 'AllocationId': 'eipalloc-37fc1a52', }, ], 'NatGatewayId': 'nat-08d48af2a8e83edfd', 'State': 'pending', 'SubnetId': 'subnet-1a2b3c4d', 'VpcId': 'vpc-1122aabb', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / purchase_scheduled_instances purchase_scheduled_instances **************************** EC2.Client.purchase_scheduled_instances(**kwargs) Note: You can no longer purchase Scheduled Instances. 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. See also: AWS API Documentation **Request Syntax** response = client.purchase_scheduled_instances( ClientToken='string', DryRun=True|False, PurchaseRequests=[ { 'InstanceCount': 123, 'PurchaseToken': 'string' }, ] ) Parameters: * **ClientToken** (*string*) -- Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PurchaseRequests** (*list*) -- **[REQUIRED]** The purchase requests. * *(dict) --* Describes a request to purchase Scheduled Instances. * **InstanceCount** *(integer) --* **[REQUIRED]** The number of instances. * **PurchaseToken** *(string) --* **[REQUIRED]** The purchase token. Return type: dict Returns: **Response Syntax** { 'ScheduledInstanceSet': [ { 'AvailabilityZone': 'string', 'CreateDate': datetime(2015, 1, 1), 'HourlyPrice': 'string', 'InstanceCount': 123, 'InstanceType': 'string', 'NetworkPlatform': 'string', 'NextSlotStartTime': datetime(2015, 1, 1), 'Platform': 'string', 'PreviousSlotEndTime': datetime(2015, 1, 1), 'Recurrence': { 'Frequency': 'string', 'Interval': 123, 'OccurrenceDaySet': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' }, 'ScheduledInstanceId': 'string', 'SlotDurationInHours': 123, 'TermEndDate': datetime(2015, 1, 1), 'TermStartDate': datetime(2015, 1, 1), 'TotalScheduledInstanceHours': 123 }, ] } **Response Structure** * *(dict) --* Contains the output of PurchaseScheduledInstances. * **ScheduledInstanceSet** *(list) --* Information about the Scheduled Instances. * *(dict) --* Describes a Scheduled Instance. * **AvailabilityZone** *(string) --* The Availability Zone. * **CreateDate** *(datetime) --* The date when the Scheduled Instance was purchased. * **HourlyPrice** *(string) --* The hourly price for a single instance. * **InstanceCount** *(integer) --* The number of instances. * **InstanceType** *(string) --* The instance type. * **NetworkPlatform** *(string) --* The network platform. * **NextSlotStartTime** *(datetime) --* The time for the next schedule to start. * **Platform** *(string) --* The platform ( "Linux/UNIX" or "Windows"). * **PreviousSlotEndTime** *(datetime) --* The time that the previous schedule ended or will end. * **Recurrence** *(dict) --* The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDaySet** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. * **OccurrenceUnit** *(string) --* The unit for "occurrenceDaySet" ( "DayOfWeek" or "DayOfMonth"). * **ScheduledInstanceId** *(string) --* The Scheduled Instance ID. * **SlotDurationInHours** *(integer) --* The number of hours in the schedule. * **TermEndDate** *(datetime) --* The end date for the Scheduled Instance. * **TermStartDate** *(datetime) --* The start date for the Scheduled Instance. * **TotalScheduledInstanceHours** *(integer) --* The total number of hours for a single instance for the entire term. **Examples** This example purchases a Scheduled Instance. response = client.purchase_scheduled_instances( PurchaseRequests=[ { 'InstanceCount': 1, 'PurchaseToken': 'eyJ2IjoiMSIsInMiOjEsImMiOi...', }, ], ) print(response) Expected Output: { 'ScheduledInstanceSet': [ { 'AvailabilityZone': 'us-west-2b', 'CreateDate': datetime(2016, 1, 25, 21, 43, 38, 0, 25, 0), 'HourlyPrice': '0.095', 'InstanceCount': 1, 'InstanceType': 'c4.large', 'NetworkPlatform': 'EC2-VPC', 'NextSlotStartTime': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0), 'Platform': 'Linux/UNIX', 'Recurrence': { 'Frequency': 'Weekly', 'Interval': 1, 'OccurrenceDaySet': [ 1, ], 'OccurrenceRelativeToEnd': False, 'OccurrenceUnit': '', }, 'ScheduledInstanceId': 'sci-1234-1234-1234-1234-123456789012', 'SlotDurationInHours': 32, 'TermEndDate': datetime(2017, 1, 31, 9, 0, 0, 1, 31, 0), 'TermStartDate': datetime(2016, 1, 31, 9, 0, 0, 6, 31, 0), 'TotalScheduledInstanceHours': 1696, }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_transit_gateway_policy_table delete_transit_gateway_policy_table *********************************** EC2.Client.delete_transit_gateway_policy_table(**kwargs) Deletes the specified transit gateway policy table. See also: AWS API Documentation **Request Syntax** response = client.delete_transit_gateway_policy_table( TransitGatewayPolicyTableId='string', DryRun=True|False ) Parameters: * **TransitGatewayPolicyTableId** (*string*) -- **[REQUIRED]** The transit gateway policy table to delete. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPolicyTable': { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayPolicyTable** *(dict) --* Provides details about the deleted transit gateway policy table. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway policy table * **CreationTime** *(datetime) --* The timestamp when the transit gateway policy table was created. * **Tags** *(list) --* he key-value pairs associated with the transit gateway policy table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_mac_modification_tasks describe_mac_modification_tasks ******************************* EC2.Client.describe_mac_modification_tasks(**kwargs) Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_mac_modification_tasks( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MacModificationTaskIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- Specifies one or more filters for the request: * "instance-id" - The ID of the instance for which the task was created. * "task-state" - The state of the task ( "successful" | "failed" | "in-progress" | "pending"). * "mac-system-integrity-protection-configuration.sip-status" - The overall SIP state requested in the task ( "enabled" | "disabled"). * "start-time" - The date and time the task was created. * "task-type" - The type of task ( "sip-modification" | "volume-ownership-delegation"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MacModificationTaskIds** (*list*) -- The ID of task. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'MacModificationTasks': [ { 'InstanceId': 'string', 'MacModificationTaskId': 'string', 'MacSystemIntegrityProtectionConfig': { 'AppleInternal': 'enabled'|'disabled', 'BaseSystem': 'enabled'|'disabled', 'DebuggingRestrictions': 'enabled'|'disabled', 'DTraceRestrictions': 'enabled'|'disabled', 'FilesystemProtections': 'enabled'|'disabled', 'KextSigning': 'enabled'|'disabled', 'NvramProtections': 'enabled'|'disabled', 'Status': 'enabled'|'disabled' }, 'StartTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'TaskState': 'successful'|'failed'|'in-progress'|'pending', 'TaskType': 'sip-modification'|'volume-ownership-delegation' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **MacModificationTasks** *(list) --* Information about the tasks. * *(dict) --* Information about a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. * **InstanceId** *(string) --* The ID of the Amazon EC2 Mac instance. * **MacModificationTaskId** *(string) --* The ID of task. * **MacSystemIntegrityProtectionConfig** *(dict) --* [SIP modification tasks only] Information about the SIP configuration. * **AppleInternal** *(string) --* Indicates whether Apple Internal was enabled or disabled by the task. * **BaseSystem** *(string) --* Indicates whether Base System was enabled or disabled by the task. * **DebuggingRestrictions** *(string) --* Indicates whether Debugging Restrictions was enabled or disabled by the task. * **DTraceRestrictions** *(string) --* Indicates whether Dtrace Restrictions was enabled or disabled by the task. * **FilesystemProtections** *(string) --* Indicates whether Filesystem Protections was enabled or disabled by the task. * **KextSigning** *(string) --* Indicates whether Kext Signing was enabled or disabled by the task. * **NvramProtections** *(string) --* Indicates whether NVRAM Protections was enabled or disabled by the task. * **Status** *(string) --* Indicates SIP was enabled or disabled by the task. * **StartTime** *(datetime) --* The date and time the task was created, in the UTC timezone ( "YYYY-MM-DDThh:mm:ss.sssZ"). * **Tags** *(list) --* The tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **TaskState** *(string) --* The state of the task. * **TaskType** *(string) --* The type of task. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_snapshots describe_snapshots ****************** EC2.Client.describe_snapshots(**kwargs) Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you. The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: * *public*: The owner of the snapshot granted create volume permissions for the snapshot to the "all" group. All Amazon Web Services accounts have create volume permissions for these snapshots. * *explicit*: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account. * *implicit*: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns. The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. If you specify one or more snapshot owners using the "OwnerIds" option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, "amazon" for snapshots owned by Amazon, or "self" for snapshots that you own. If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), "self" for snapshots for which you own or have explicit permissions, or "all" for public snapshots. If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination. For more information about EBS snapshots, see Amazon EBS snapshots in the *Amazon EBS User Guide*. Warning: We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. See also: AWS API Documentation **Request Syntax** response = client.describe_snapshots( MaxResults=123, NextToken='string', OwnerIds=[ 'string', ], RestorableByUserIds=[ 'string', ], SnapshotIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **OwnerIds** (*list*) -- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, "self", and "amazon". * *(string) --* * **RestorableByUserIds** (*list*) -- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. * *(string) --* * **SnapshotIds** (*list*) -- The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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 Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. * "owner-id" - The Amazon Web Services 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"). * "storage-tier" - The storage tier of the snapshot ( "archive" | "standard"). * "transfer-type" - The type of operation used to create the snapshot ( "time-based" | "standard"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Snapshots': [ { 'OwnerAlias': 'string', 'OutpostArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'StorageTier': 'archive'|'standard', 'RestoreExpiryTime': datetime(2015, 1, 1), 'SseType': 'sse-ebs'|'sse-kms'|'none', 'AvailabilityZone': 'string', 'TransferType': 'time-based'|'standard', 'CompletionDurationMinutes': 123, 'CompletionTime': datetime(2015, 1, 1), 'FullSnapshotSizeInBytes': 123, 'SnapshotId': 'string', 'VolumeId': 'string', 'State': 'pending'|'completed'|'error'|'recoverable'|'recovering', 'StateMessage': 'string', 'StartTime': datetime(2015, 1, 1), 'Progress': 'string', 'OwnerId': 'string', 'Description': 'string', 'VolumeSize': 123, 'Encrypted': True|False, 'KmsKeyId': 'string', 'DataEncryptionKeyId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Snapshots** *(list) --* Information about the snapshots. * *(dict) --* Describes a snapshot. * **OwnerAlias** *(string) --* The Amazon Web Services owner alias, from an Amazon- maintained list ( "amazon"). This is not the user- configured Amazon Web Services account alias set using the IAM console. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the *Amazon EBS User Guide*. * **Tags** *(list) --* Any tags assigned to the snapshot. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **StorageTier** *(string) --* The storage tier in which the snapshot is stored. "standard" indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. "archive" indicates that the snapshot is currently archived and that it must be restored before it can be used. * **RestoreExpiryTime** *(datetime) --* Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. * **SseType** *(string) --* Reserved for future use. * **AvailabilityZone** *(string) --* The Availability Zone or Local Zone of the snapshot. For example, "us-west-1a" (Availability Zone) or "us-west-2 -lax-1a" (Local Zone). * **TransferType** *(string) --* Note: Only for snapshot copies. Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time- based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis. * "standard" - The snapshot copy was created with a standard snapshot copy operation. * "time-based" - The snapshot copy was created with a time-based snapshot copy operation. * **CompletionDurationMinutes** *(integer) --* Note: Only for snapshot copies created with time-based snapshot copy operations. The completion duration requested for the time-based snapshot copy operation. * **CompletionTime** *(datetime) --* The time stamp when the snapshot was completed. * **FullSnapshotSizeInBytes** *(integer) --* The full size of the snapshot, in bytes. Warning: This is **not** the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created. * **SnapshotId** *(string) --* The ID of the snapshot. Each snapshot receives a unique identifier when it is created. * **VolumeId** *(string) --* The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose. * **State** *(string) --* The snapshot state. * **StateMessage** *(string) --* Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots. * **StartTime** *(datetime) --* The time stamp when the snapshot was initiated. * **Progress** *(string) --* The progress of the snapshot, as a percentage. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the EBS snapshot. * **Description** *(string) --* The description for the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiB. * **Encrypted** *(boolean) --* Indicates whether the snapshot is encrypted. * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume. * **DataEncryptionKeyId** *(string) --* The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots. **Examples** This example describes a snapshot with the snapshot ID of "snap- 1234567890abcdef0". response = client.describe_snapshots( SnapshotIds=[ 'snap-1234567890abcdef0', ], ) print(response) Expected Output: { 'NextToken': '', 'Snapshots': [ { 'Description': 'This is my snapshot.', 'OwnerId': '012345678910', 'Progress': '100%', 'SnapshotId': 'snap-1234567890abcdef0', 'StartTime': datetime(2014, 2, 28, 21, 28, 32, 4, 59, 0), 'State': 'completed', 'VolumeId': 'vol-049df61146c4d7901', 'VolumeSize': 8, }, ], 'ResponseMetadata': { '...': '...', }, } This example describes all snapshots owned by the ID 012345678910 that are in the "pending" status. response = client.describe_snapshots( Filters=[ { 'Name': 'status', 'Values': [ 'pending', ], }, ], OwnerIds=[ '012345678910', ], ) print(response) Expected Output: { 'NextToken': '', 'Snapshots': [ { 'Description': 'This is my copied snapshot.', 'OwnerId': '012345678910', 'Progress': '87%', 'SnapshotId': 'snap-066877671789bd71b', 'StartTime': datetime(2014, 2, 28, 21, 37, 27, 4, 59, 0), 'State': 'pending', 'VolumeId': 'vol-1234567890abcdef0', 'VolumeSize': 8, }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / associate_ipam_byoasn associate_ipam_byoasn ********************* EC2.Client.associate_ipam_byoasn(**kwargs) Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the *Amazon VPC IPAM guide*. After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr. See also: AWS API Documentation **Request Syntax** response = client.associate_ipam_byoasn( DryRun=True|False, Asn='string', Cidr='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Asn** (*string*) -- **[REQUIRED]** A public 2-byte or 4-byte ASN. * **Cidr** (*string*) -- **[REQUIRED]** The BYOIP CIDR you want to associate with an ASN. Return type: dict Returns: **Response Syntax** { 'AsnAssociation': { 'Asn': 'string', 'Cidr': 'string', 'StatusMessage': 'string', 'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated' } } **Response Structure** * *(dict) --* * **AsnAssociation** *(dict) --* The ASN and BYOIP CIDR association. * **Asn** *(string) --* The association's ASN. * **Cidr** *(string) --* The association's CIDR. * **StatusMessage** *(string) --* The association's status message. * **State** *(string) --* The association's state. EC2 / Client / describe_spot_price_history describe_spot_price_history *************************** EC2.Client.describe_spot_price_history(**kwargs) Describes the Spot price history. For more information, see Spot Instance pricing history in the *Amazon EC2 User Guide*. When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time. See also: AWS API Documentation **Request Syntax** response = client.describe_spot_price_history( DryRun=True|False, StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), InstanceTypes=[ 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', ], ProductDescriptions=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], AvailabilityZone='string', MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **StartTime** (*datetime*) -- 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*-*DD*T*HH*:*MM*:>>*<>*<>*<" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **HostReservationIdSet** (*list*) -- The host reservation IDs. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token to use to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'HostReservationSet': [ { 'Count': 123, 'CurrencyCode': 'USD', 'Duration': 123, 'End': datetime(2015, 1, 1), 'HostIdSet': [ 'string', ], 'HostReservationId': 'string', 'HourlyPrice': 'string', 'InstanceFamily': 'string', 'OfferingId': 'string', 'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront', 'Start': datetime(2015, 1, 1), 'State': 'payment-pending'|'payment-failed'|'active'|'retired', 'UpfrontPrice': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **HostReservationSet** *(list) --* Details about the reservation's configuration. * *(dict) --* Details about the Dedicated Host Reservation and associated Dedicated Hosts. * **Count** *(integer) --* The number of Dedicated Hosts the reservation is associated with. * **CurrencyCode** *(string) --* The currency in which the "upfrontPrice" and "hourlyPrice" amounts are specified. At this time, the only supported currency is "USD". * **Duration** *(integer) --* The length of the reservation's term, specified in seconds. Can be "31536000 (1 year)" | "94608000 (3 years)". * **End** *(datetime) --* The date and time that the reservation ends. * **HostIdSet** *(list) --* The IDs of the Dedicated Hosts associated with the reservation. * *(string) --* * **HostReservationId** *(string) --* The ID of the reservation that specifies the associated Dedicated Hosts. * **HourlyPrice** *(string) --* The hourly price of the reservation. * **InstanceFamily** *(string) --* The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. * **OfferingId** *(string) --* The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. * **PaymentOption** *(string) --* The payment option selected for this reservation. * **Start** *(datetime) --* The date and time that the reservation started. * **State** *(string) --* The state of the reservation. * **UpfrontPrice** *(string) --* The upfront price of the reservation. * **Tags** *(list) --* Any tags assigned to the Dedicated Host Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_ipv6_pools describe_ipv6_pools ******************* EC2.Client.describe_ipv6_pools(**kwargs) Describes your IPv6 address pools. See also: AWS API Documentation **Request Syntax** response = client.describe_ipv6_pools( PoolIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **PoolIds** (*list*) -- The IDs of the IPv6 address pools. * *(string) --* * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Ipv6Pools': [ { 'PoolId': 'string', 'Description': 'string', 'PoolCidrBlocks': [ { 'Cidr': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Ipv6Pools** *(list) --* Information about the IPv6 address pools. * *(dict) --* Describes an IPv6 address pool. * **PoolId** *(string) --* The ID of the address pool. * **Description** *(string) --* The description for the address pool. * **PoolCidrBlocks** *(list) --* The CIDR blocks for the address pool. * *(dict) --* Describes a CIDR block for an address pool. * **Cidr** *(string) --* The CIDR block. * **Tags** *(list) --* Any tags for the address pool. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / delete_network_insights_path delete_network_insights_path **************************** EC2.Client.delete_network_insights_path(**kwargs) Deletes the specified path. See also: AWS API Documentation **Request Syntax** response = client.delete_network_insights_path( DryRun=True|False, NetworkInsightsPathId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkInsightsPathId** (*string*) -- **[REQUIRED]** The ID of the path. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsPathId': 'string' } **Response Structure** * *(dict) --* * **NetworkInsightsPathId** *(string) --* The ID of the path. EC2 / Client / describe_verified_access_endpoints describe_verified_access_endpoints ********************************** EC2.Client.describe_verified_access_endpoints(**kwargs) Describes the specified Amazon Web Services Verified Access endpoints. See also: AWS API Documentation **Request Syntax** response = client.describe_verified_access_endpoints( VerifiedAccessEndpointIds=[ 'string', ], VerifiedAccessInstanceId='string', VerifiedAccessGroupId='string', MaxResults=123, NextToken='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **VerifiedAccessEndpointIds** (*list*) -- The ID of the Verified Access endpoint. * *(string) --* * **VerifiedAccessInstanceId** (*string*) -- The ID of the Verified Access instance. * **VerifiedAccessGroupId** (*string*) -- The ID of the Verified Access group. * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VerifiedAccessEndpoints': [ { 'VerifiedAccessInstanceId': 'string', 'VerifiedAccessGroupId': 'string', 'VerifiedAccessEndpointId': 'string', 'ApplicationDomain': 'string', 'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr', 'AttachmentType': 'vpc', 'DomainCertificateArn': 'string', 'EndpointDomain': 'string', 'DeviceValidationDomain': 'string', 'SecurityGroupIds': [ 'string', ], 'LoadBalancerOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'LoadBalancerArn': 'string', 'SubnetIds': [ 'string', ], 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'NetworkInterfaceOptions': { 'NetworkInterfaceId': 'string', 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'Status': { 'Code': 'pending'|'active'|'updating'|'deleting'|'deleted', 'Message': 'string' }, 'Description': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'DeletionTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'RdsOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'RdsDbInstanceArn': 'string', 'RdsDbClusterArn': 'string', 'RdsDbProxyArn': 'string', 'RdsEndpoint': 'string', 'SubnetIds': [ 'string', ] }, 'CidrOptions': { 'Cidr': 'string', 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'Protocol': 'http'|'https'|'tcp', 'SubnetIds': [ 'string', ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VerifiedAccessEndpoints** *(list) --* Details about the Verified Access endpoints. * *(dict) --* An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **VerifiedAccessGroupId** *(string) --* The ID of the Amazon Web Services Verified Access group. * **VerifiedAccessEndpointId** *(string) --* The ID of the Amazon Web Services Verified Access endpoint. * **ApplicationDomain** *(string) --* The DNS name for users to reach your application. * **EndpointType** *(string) --* The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. * **AttachmentType** *(string) --* The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application. * **DomainCertificateArn** *(string) --* The ARN of a public TLS/SSL certificate imported into or created with ACM. * **EndpointDomain** *(string) --* A DNS name that is generated for the endpoint. * **DeviceValidationDomain** *(string) --* Returned if endpoint has a device trust provider attached. * **SecurityGroupIds** *(list) --* The IDs of the security groups for the endpoint. * *(string) --* * **LoadBalancerOptions** *(dict) --* The load balancer details if creating the Amazon Web Services Verified Access endpoint as >>``<" - 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). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **OfferingType** (*string*) -- 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. Return type: dict Returns: **Response Syntax** { 'ReservedInstances': [ { 'CurrencyCode': 'USD', 'InstanceTenancy': 'default'|'dedicated'|'host', 'OfferingClass': 'standard'|'convertible', 'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront', 'RecurringCharges': [ { 'Amount': 123.0, 'Frequency': 'Hourly' }, ], 'Scope': 'Availability Zone'|'Region', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AvailabilityZoneId': 'string', 'ReservedInstancesId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'AvailabilityZone': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'Duration': 123, 'UsagePrice': ..., 'FixedPrice': ..., 'InstanceCount': 123, 'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)', 'State': 'payment-pending'|'active'|'payment-failed'|'retired'|'queued'|'queued-deleted' }, ] } **Response Structure** * *(dict) --* Contains the output for DescribeReservedInstances. * **ReservedInstances** *(list) --* A list of Reserved Instances. * *(dict) --* Describes a Reserved Instance. * **CurrencyCode** *(string) --* The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is "USD". * **InstanceTenancy** *(string) --* The tenancy of the instance. * **OfferingClass** *(string) --* The offering class of the Reserved Instance. * **OfferingType** *(string) --* The Reserved Instance offering type. * **RecurringCharges** *(list) --* The recurring charge tag assigned to the resource. * *(dict) --* Describes a recurring charge. * **Amount** *(float) --* The amount of the recurring charge. * **Frequency** *(string) --* The frequency of the recurring charge. * **Scope** *(string) --* The scope of the Reserved Instance. * **Tags** *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. * **ReservedInstancesId** *(string) --* The ID of the Reserved Instance. * **InstanceType** *(string) --* The instance type on which the Reserved Instance can be used. * **AvailabilityZone** *(string) --* The Availability Zone in which the Reserved Instance can be used. * **Start** *(datetime) --* The date and time the Reserved Instance started. * **End** *(datetime) --* The time when the Reserved Instance expires. * **Duration** *(integer) --* The duration of the Reserved Instance, in seconds. * **UsagePrice** *(float) --* The usage price of the Reserved Instance, per hour. * **FixedPrice** *(float) --* The purchase price of the Reserved Instance. * **InstanceCount** *(integer) --* The number of reservations purchased. * **ProductDescription** *(string) --* The Reserved Instance product platform description. * **State** *(string) --* The state of the Reserved Instance purchase. EC2 / Client / request_spot_fleet request_spot_fleet ****************** EC2.Client.request_spot_fleet(**kwargs) 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*. Warning: We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.request_spot_fleet( DryRun=True|False, SpotFleetRequestConfig={ 'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized'|'priceCapacityOptimized', 'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized', 'SpotMaintenanceStrategies': { 'CapacityRebalance': { 'ReplacementStrategy': 'launch'|'launch-before-terminate', 'TerminationDelay': 123 } }, 'ClientToken': 'string', 'ExcessCapacityTerminationPolicy': 'noTermination'|'default', 'FulfilledCapacity': 123.0, 'OnDemandFulfilledCapacity': 123.0, 'IamFleetRole': 'string', 'LaunchSpecifications': [ { 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SpotPrice': 'string', 'SubnetId': 'string', 'UserData': 'string', 'WeightedCapacity': 123.0, 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ] }, ], 'LaunchTemplateConfigs': [ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'SpotPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, ] }, ], 'SpotPrice': 'string', 'TargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'OnDemandMaxTotalPrice': 'string', 'SpotMaxTotalPrice': 'string', 'TerminateInstancesWithExpiration': True|False, 'Type': 'request'|'maintain'|'instant', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'ReplaceUnhealthyInstances': True|False, 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate', 'LoadBalancersConfig': { 'ClassicLoadBalancersConfig': { 'ClassicLoadBalancers': [ { 'Name': 'string' }, ] }, 'TargetGroupsConfig': { 'TargetGroups': [ { 'Arn': 'string' }, ] } }, 'InstancePoolsToUseCount': 123, 'Context': 'string', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotFleetRequestConfig** (*dict*) -- **[REQUIRED]** The configuration for the Spot Fleet request. * **AllocationStrategy** *(string) --* The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the *Amazon EC2 User Guide*. priceCapacityOptimized (recommended) Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. capacityOptimized Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use "capacityOptimizedPrioritized". Set a priority for each instance type by using the "Priority" parameter for "LaunchTemplateOverrides". You can assign the same priority to different "LaunchTemplateOverrides". EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. "capacityOptimizedPrioritized" is supported only if your Spot Fleet uses a launch template. Note that if the "OnDemandAllocationStrategy" is set to "prioritized", the same priority is applied when fulfilling On-Demand capacity. diversified Spot Fleet requests instances from all of the Spot Instance pools that you specify. lowestPrice (not recommended) Warning: We don't recommend the "lowestPrice" allocation strategy because it has the highest risk of interruption for your Spot Instances. Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates. Default: "lowestPrice" * **OnDemandAllocationStrategy** *(string) --* The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify "lowestPrice", Spot Fleet uses price to determine the order, launching the lowest price first. If you specify "prioritized", Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to "lowestPrice". * **SpotMaintenanceStrategies** *(dict) --* The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. * **CapacityRebalance** *(dict) --* The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the *Amazon EC2 User Guide*. * **ReplacementStrategy** *(string) --* The replacement strategy to use. Only available for fleets of type "maintain". "launch" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running. "launch-before-terminate" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in "TerminationDelay"), terminates the instances that received a rebalance notification. * **TerminationDelay** *(integer) --* The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance. Required when "ReplacementStrategy" is set to "launch- before-terminate". Not valid when "ReplacementStrategy" is set to "launch". Valid values: Minimum value of "120" seconds. Maximum value of "7200" seconds. * **ClientToken** *(string) --* A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency. * **ExcessCapacityTerminationPolicy** *(string) --* Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. Supported only for fleets of type "maintain". * **FulfilledCapacity** *(float) --* The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. * **OnDemandFulfilledCapacity** *(float) --* The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. * **IamFleetRole** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the *Amazon EC2 User Guide*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set "TerminateInstancesWithExpiration". * **LaunchSpecifications** *(list) --* The launch specifications for the Spot Fleet request. If you specify "LaunchSpecifications", you can't specify "LaunchTemplateConfigs". If you include On-Demand capacity in your request, you must use "LaunchTemplateConfigs". Note: If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type "maintain", the target capacity will not be maintained. * *(dict) --* Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use "SpotFleetLaunchSpecification"; you must use LaunchTemplateConfig. * **AddressingType** *(string) --* Deprecated. * **BlockDeviceMappings** *(list) --* One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **EbsOptimized** *(boolean) --* Indicates whether the instances are optimized for 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. Default: "false" * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **ImageId** *(string) --* The ID of the AMI. * **InstanceType** *(string) --* The instance type. * **KernelId** *(string) --* The ID of the kernel. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* Enable or disable monitoring for the instances. * **Enabled** *(boolean) --* Enables monitoring for the instance. Default: "false" * **NetworkInterfaces** *(list) --* The network interfaces. Note: "SpotFleetLaunchSpecification" does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead. * *(dict) --* Describes a network interface. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is "true". Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* If set to "true", the interface is deleted when the instance is terminated. You can specify "true" only if creating a new network interface when launching an instance. * **Description** *(string) --* The description of the network interface. Applies only if creating a network interface when launching an instance. * **DeviceIndex** *(integer) --* The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index. * **Groups** *(list) --* The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. * *(string) --* * **Ipv6AddressCount** *(integer) --* A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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. * **Ipv6Addresses** *(list) --* The IPv6 addresses to assign to the 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the "PrivateIpAddress" parameter. * **SubnetId** *(string) --* The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the *Amazon Web Services Wavelength Developer Guide*. * **InterfaceType** *(string) --* The type of network interface. If you specify "efa-only", do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Valid values: "interface" | "efa" | "efa-only" * **NetworkCardIndex** *(integer) --* 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. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances. * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv4PrefixCount" option. * *(dict) --* Describes the IPv4 prefix option for a network interface. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv4Prefix" option. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv6PrefixCount" option. * *(dict) --* Describes the IPv6 prefix option for a network interface. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv6Prefix" option. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Specifies the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Specifies whether ENA Express is enabled for the network interface when you launch an instance. * **EnaSrdUdpSpecification** *(dict) --* Contains ENA Express settings for UDP network traffic for the network interface attached to the instance. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set **EnaSrdEnabled** in the **EnaSrdSpecificationRequest** to "true". * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request- response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **Placement** *(dict) --* The placement information. * **AvailabilityZone** *(string) --* The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us- west-2a, us-west-2b". * **GroupName** *(string) --* The name of the placement group. * **Tenancy** *(string) --* The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of "dedicated" runs on single-tenant hardware. The "host" tenancy is not supported for Spot Instances. * **RamdiskId** *(string) --* The ID of the RAM disk. 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, refer to the Amazon Web Services Resource Center and search for the kernel ID. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet- 0987cdef6example2". If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter. * **UserData** *(string) --* The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **TagSpecifications** *(list) --* The tags to apply during creation. * *(dict) --* The tags for a Spot Fleet resource. * **ResourceType** *(string) --* The type of resource. Currently, the only resource type that is supported is "instance". To tag the Spot Fleet request on creation, use the "TagSpecifications" parameter in >>``<>``<<. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in- 16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SecurityGroups** *(list) --* The security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **LaunchTemplateConfigs** *(list) --* The launch template and overrides. If you specify "LaunchTemplateConfigs", you can't specify "LaunchSpecifications". If you include On-Demand capacity in your request, you must use "LaunchTemplateConfigs". * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template to use. Make sure that the launch template does not contain the "NetworkInterfaceId" parameter because you can't specify a network interface ID in a Spot Fleet. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If "OnDemandAllocationStrategy" is set to "prioritized", Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacityOptimizedPrioritized", Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides. * **InstanceRequirements** *(dict) --* The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **TargetCapacity** *(integer) --* **[REQUIRED]** The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandMaxTotalPrice** *(string) --* The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the "onDemandMaxTotalPrice" parameter, the "spotMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "onDemandMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "onDemandMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **SpotMaxTotalPrice** *(string) --* The maximum amount per hour for Spot Instances that you're willing to pay. You can use the "spotMaxTotalPrice" parameter, the "onDemandMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On- Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "spotMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "spotMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **TerminateInstancesWithExpiration** *(boolean) --* Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. * **Type** *(string) --* The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is "request", the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is "maintain", the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: "maintain". "instant" is listed but is not used by Spot Fleet. * **ValidFrom** *(datetime) --* The start date and time of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PublicIpv4Pools': [ { 'PoolId': 'string', 'Description': 'string', 'PoolAddressRanges': [ { 'FirstAddress': 'string', 'LastAddress': 'string', 'AddressCount': 123, 'AvailableAddressCount': 123 }, ], 'TotalAddressCount': 123, 'TotalAvailableAddressCount': 123, 'NetworkBorderGroup': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PublicIpv4Pools** *(list) --* Information about the address pools. * *(dict) --* Describes an IPv4 address pool. * **PoolId** *(string) --* The ID of the address pool. * **Description** *(string) --* A description of the address pool. * **PoolAddressRanges** *(list) --* The address ranges. * *(dict) --* Describes an address range of an IPv4 address pool. * **FirstAddress** *(string) --* The first IP address in the range. * **LastAddress** *(string) --* The last IP address in the range. * **AddressCount** *(integer) --* The number of addresses in the range. * **AvailableAddressCount** *(integer) --* The number of available addresses in the range. * **TotalAddressCount** *(integer) --* The total number of addresses. * **TotalAvailableAddressCount** *(integer) --* The total number of available addresses. * **NetworkBorderGroup** *(string) --* The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses. * **Tags** *(list) --* Any tags for the address pool. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / disassociate_vpc_cidr_block disassociate_vpc_cidr_block *************************** EC2.Client.disassociate_vpc_cidr_block(**kwargs) 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). See also: AWS API Documentation **Request Syntax** response = client.disassociate_vpc_cidr_block( AssociationId='string' ) Parameters: **AssociationId** (*string*) -- **[REQUIRED]** The association ID for the CIDR block. Return type: dict Returns: **Response Syntax** { 'Ipv6CidrBlockAssociation': { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'NetworkBorderGroup': 'string', 'Ipv6Pool': 'string', 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, 'CidrBlockAssociation': { 'AssociationId': 'string', 'CidrBlock': 'string', 'CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' } }, 'VpcId': 'string' } **Response Structure** * *(dict) --* * **Ipv6CidrBlockAssociation** *(dict) --* Information about the IPv6 CIDR block association. * **AssociationId** *(string) --* The association ID for the IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, "us-east-1-wl1-bos- wlz-1". * **Ipv6Pool** *(string) --* The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **CidrBlockAssociation** *(dict) --* Information about the IPv4 CIDR block association. * **AssociationId** *(string) --* The association ID for the IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **VpcId** *(string) --* The ID of the VPC. EC2 / Client / copy_image copy_image ********** EC2.Client.copy_image(**kwargs) Initiates an AMI copy operation. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask. When you copy an AMI from one Region to another, the destination Region is the current Region. When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the destination. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots. For information about the prerequisites when copying an AMI, see Copy an Amazon EC2 AMI in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.copy_image( ClientToken='string', Description='string', Encrypted=True|False, KmsKeyId='string', Name='string', SourceImageId='string', SourceRegion='string', DestinationOutpostArn='string', CopyImageTags=True|False, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], SnapshotCopyCompletionDurationMinutes=123, DryRun=True|False ) Parameters: * **ClientToken** (*string*) -- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests in the *Amazon EC2 API Reference*. This field is autopopulated if not provided. * **Description** (*string*) -- A description for the new AMI in the destination Region. * **Encrypted** (*boolean*) -- 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 KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using "KmsKeyId". For more information, see Use encryption with EBS- backed AMIs in the *Amazon EC2 User Guide*. * **KmsKeyId** (*string*) -- The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to "true". You can specify a KMS key 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. Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails. The specified KMS key must exist in the destination Region. Amazon EBS does not support asymmetric KMS keys. * **Name** (*string*) -- **[REQUIRED]** The name of the new AMI in the destination Region. * **SourceImageId** (*string*) -- **[REQUIRED]** The ID of the AMI to copy. * **SourceRegion** (*string*) -- **[REQUIRED]** The name of the Region that contains the AMI to copy. * **DestinationOutpostArn** (*string*) -- The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services 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 Copy AMIs from an Amazon Web Services Region to an Outpost in the *Amazon EBS User Guide*. * **CopyImageTags** (*boolean*) -- Indicates whether to include your user-defined AMI tags when copying the AMI. The following tags will not be copied: * System tags (prefixed with "aws:") * For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts Default: Your user-defined AMI tags are not copied. * **TagSpecifications** (*list*) -- The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both. * To tag the new AMI, the value for "ResourceType" must be "image". * To tag the new snapshots, the value for "ResourceType" must be "snapshot". The same tag is applied to all the new snapshots. If you specify other values for "ResourceType", the request fails. To tag an AMI or snapshot after it has been created, see CreateTags. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SnapshotCopyCompletionDurationMinutes** (*integer*) -- Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target. If you do not specify a value, the AMI copy operation is completed on a best-effort basis. For more information, see Time-based copies for Amazon EBS snapshots and EBS-backed AMIs. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'ImageId': 'string' } **Response Structure** * *(dict) --* Contains the output of CopyImage. * **ImageId** *(string) --* The ID of the new AMI. **Examples** This example copies the specified AMI from the us-east-1 region to the current region. response = client.copy_image( Description='', Name='My server', SourceImageId='ami-5731123e', SourceRegion='us-east-1', ) print(response) Expected Output: { 'ImageId': 'ami-438bea42', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / can_paginate can_paginate ************ EC2.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. EC2 / Client / delete_network_acl_entry delete_network_acl_entry ************************ EC2.Client.delete_network_acl_entry(**kwargs) Deletes the specified ingress or egress entry (rule) from the specified network ACL. See also: AWS API Documentation **Request Syntax** response = client.delete_network_acl_entry( DryRun=True|False, NetworkAclId='string', RuleNumber=123, Egress=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclId** (*string*) -- **[REQUIRED]** The ID of the network ACL. * **RuleNumber** (*integer*) -- **[REQUIRED]** The rule number of the entry to delete. * **Egress** (*boolean*) -- **[REQUIRED]** Indicates whether the rule is an egress rule. Returns: None **Examples** This example deletes ingress rule number 100 from the specified network ACL. response = client.delete_network_acl_entry( Egress=True, NetworkAclId='acl-5fb85d36', RuleNumber=100, ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / accept_address_transfer accept_address_transfer *********************** EC2.Client.accept_address_transfer(**kwargs) Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.accept_address_transfer( Address='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **Address** (*string*) -- **[REQUIRED]** The Elastic IP address you are accepting for transfer. * **TagSpecifications** (*list*) -- "tag": - 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'AddressTransfer': { 'PublicIp': 'string', 'AllocationId': 'string', 'TransferAccountId': 'string', 'TransferOfferExpirationTimestamp': datetime(2015, 1, 1), 'TransferOfferAcceptedTimestamp': datetime(2015, 1, 1), 'AddressTransferStatus': 'pending'|'disabled'|'accepted' } } **Response Structure** * *(dict) --* * **AddressTransfer** *(dict) --* An Elastic IP address transfer. * **PublicIp** *(string) --* The Elastic IP address being transferred. * **AllocationId** *(string) --* The allocation ID of an Elastic IP address. * **TransferAccountId** *(string) --* The ID of the account that you want to transfer the Elastic IP address to. * **TransferOfferExpirationTimestamp** *(datetime) --* The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner. * **TransferOfferAcceptedTimestamp** *(datetime) --* The timestamp when the Elastic IP address transfer was accepted. * **AddressTransferStatus** *(string) --* The Elastic IP address transfer status. EC2 / Client / register_transit_gateway_multicast_group_members register_transit_gateway_multicast_group_members ************************************************ EC2.Client.register_transit_gateway_multicast_group_members(**kwargs) Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see Multicast on transit gateways in the *Amazon Web Services Transit Gateways Guide*. After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group. See also: AWS API Documentation **Request Syntax** response = client.register_transit_gateway_multicast_group_members( TransitGatewayMulticastDomainId='string', GroupIpAddress='string', NetworkInterfaceIds=[ 'string', ], DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- **[REQUIRED]** The ID of the transit gateway multicast domain. * **GroupIpAddress** (*string*) -- The IP address assigned to the transit gateway multicast group. * **NetworkInterfaceIds** (*list*) -- **[REQUIRED]** The group members' network interface IDs to register with the transit gateway multicast group. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RegisteredMulticastGroupMembers': { 'TransitGatewayMulticastDomainId': 'string', 'RegisteredNetworkInterfaceIds': [ 'string', ], 'GroupIpAddress': 'string' } } **Response Structure** * *(dict) --* * **RegisteredMulticastGroupMembers** *(dict) --* Information about the registered transit gateway multicast group members. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **RegisteredNetworkInterfaceIds** *(list) --* The ID of the registered network interfaces. * *(string) --* * **GroupIpAddress** *(string) --* The IP address assigned to the transit gateway multicast group. EC2 / Client / describe_ipam_external_resource_verification_tokens describe_ipam_external_resource_verification_tokens *************************************************** EC2.Client.describe_ipam_external_resource_verification_tokens(**kwargs) Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). See also: AWS API Documentation **Request Syntax** response = client.describe_ipam_external_resource_verification_tokens( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123, IpamExternalResourceVerificationTokenIds=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. Available filters: * "ipam-arn" * "ipam-external-resource-verification-token-arn" * "ipam-external-resource-verification-token-id" * "ipam-id" * "ipam-region" * "state" * "status" * "token-name" * "token-value" * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of tokens to return in one page of results. * **IpamExternalResourceVerificationTokenIds** (*list*) -- Verification token IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'IpamExternalResourceVerificationTokens': [ { 'IpamExternalResourceVerificationTokenId': 'string', 'IpamExternalResourceVerificationTokenArn': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'TokenValue': 'string', 'TokenName': 'string', 'NotAfter': datetime(2015, 1, 1), 'Status': 'valid'|'expired', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **IpamExternalResourceVerificationTokens** *(list) --* Verification tokens. * *(dict) --* A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). * **IpamExternalResourceVerificationTokenId** *(string) --* The ID of the token. * **IpamExternalResourceVerificationTokenArn** *(string) --* Token ARN. * **IpamId** *(string) --* The ID of the IPAM that created the token. * **IpamArn** *(string) --* ARN of the IPAM that created the token. * **IpamRegion** *(string) --* Region of the IPAM that created the token. * **TokenValue** *(string) --* Token value. * **TokenName** *(string) --* Token name. * **NotAfter** *(datetime) --* Token expiration. * **Status** *(string) --* Token status. * **Tags** *(list) --* Token tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **State** *(string) --* Token state. EC2 / Client / create_verified_access_endpoint create_verified_access_endpoint ******************************* EC2.Client.create_verified_access_endpoint(**kwargs) An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy. See also: AWS API Documentation **Request Syntax** response = client.create_verified_access_endpoint( VerifiedAccessGroupId='string', EndpointType='load-balancer'|'network-interface'|'rds'|'cidr', AttachmentType='vpc', DomainCertificateArn='string', ApplicationDomain='string', EndpointDomainPrefix='string', SecurityGroupIds=[ 'string', ], LoadBalancerOptions={ 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'LoadBalancerArn': 'string', 'SubnetIds': [ 'string', ], 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, NetworkInterfaceOptions={ 'NetworkInterfaceId': 'string', 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, Description='string', PolicyDocument='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', DryRun=True|False, SseSpecification={ 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, RdsOptions={ 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'RdsDbInstanceArn': 'string', 'RdsDbClusterArn': 'string', 'RdsDbProxyArn': 'string', 'RdsEndpoint': 'string', 'SubnetIds': [ 'string', ] }, CidrOptions={ 'Protocol': 'http'|'https'|'tcp', 'SubnetIds': [ 'string', ], 'Cidr': 'string', 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] } ) Parameters: * **VerifiedAccessGroupId** (*string*) -- **[REQUIRED]** The ID of the Verified Access group to associate the endpoint with. * **EndpointType** (*string*) -- **[REQUIRED]** The type of Verified Access endpoint to create. * **AttachmentType** (*string*) -- **[REQUIRED]** The type of attachment. * **DomainCertificateArn** (*string*) -- The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application. * **ApplicationDomain** (*string*) -- The DNS name for users to reach your application. * **EndpointDomainPrefix** (*string*) -- A custom identifier that is prepended to the DNS name that is generated for the endpoint. * **SecurityGroupIds** (*list*) -- The IDs of the security groups to associate with the Verified Access endpoint. Required if "AttachmentType" is set to "vpc". * *(string) --* * **LoadBalancerOptions** (*dict*) -- The load balancer details. This parameter is required if the endpoint type is "load-balancer". * **Protocol** *(string) --* The IP protocol. * **Port** *(integer) --* The IP port number. * **LoadBalancerArn** *(string) --* The ARN of the load balancer. * **SubnetIds** *(list) --* The IDs of the subnets. You can specify only one subnet per Availability Zone. * *(string) --* * **PortRanges** *(list) --* The port ranges. * *(dict) --* Describes the port range for a Verified Access endpoint. * **FromPort** *(integer) --* The start of the port range. * **ToPort** *(integer) --* The end of the port range. * **NetworkInterfaceOptions** (*dict*) -- The network interface details. This parameter is required if the endpoint type is "network-interface". * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **Protocol** *(string) --* The IP protocol. * **Port** *(integer) --* The IP port number. * **PortRanges** *(list) --* The port ranges. * *(dict) --* Describes the port range for a Verified Access endpoint. * **FromPort** *(integer) --* The start of the port range. * **ToPort** *(integer) --* The end of the port range. * **Description** (*string*) -- A description for the Verified Access endpoint. * **PolicyDocument** (*string*) -- The Verified Access policy document. * **TagSpecifications** (*list*) -- The tags to assign to the Verified Access endpoint. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SseSpecification** (*dict*) -- The options for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Enable or disable the use of customer managed KMS keys for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. * **RdsOptions** (*dict*) -- The RDS details. This parameter is required if the endpoint type is "rds". * **Protocol** *(string) --* The protocol. * **Port** *(integer) --* The port. * **RdsDbInstanceArn** *(string) --* The ARN of the RDS instance. * **RdsDbClusterArn** *(string) --* The ARN of the DB cluster. * **RdsDbProxyArn** *(string) --* The ARN of the RDS proxy. * **RdsEndpoint** *(string) --* The RDS endpoint. * **SubnetIds** *(list) --* The IDs of the subnets. You can specify only one subnet per Availability Zone. * *(string) --* * **CidrOptions** (*dict*) -- The CIDR options. This parameter is required if the endpoint type is "cidr". * **Protocol** *(string) --* The protocol. * **SubnetIds** *(list) --* The IDs of the subnets. * *(string) --* * **Cidr** *(string) --* The CIDR. * **PortRanges** *(list) --* The port ranges. * *(dict) --* Describes the port range for a Verified Access endpoint. * **FromPort** *(integer) --* The start of the port range. * **ToPort** *(integer) --* The end of the port range. Return type: dict Returns: **Response Syntax** { 'VerifiedAccessEndpoint': { 'VerifiedAccessInstanceId': 'string', 'VerifiedAccessGroupId': 'string', 'VerifiedAccessEndpointId': 'string', 'ApplicationDomain': 'string', 'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr', 'AttachmentType': 'vpc', 'DomainCertificateArn': 'string', 'EndpointDomain': 'string', 'DeviceValidationDomain': 'string', 'SecurityGroupIds': [ 'string', ], 'LoadBalancerOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'LoadBalancerArn': 'string', 'SubnetIds': [ 'string', ], 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'NetworkInterfaceOptions': { 'NetworkInterfaceId': 'string', 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'Status': { 'Code': 'pending'|'active'|'updating'|'deleting'|'deleted', 'Message': 'string' }, 'Description': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'DeletionTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'RdsOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'RdsDbInstanceArn': 'string', 'RdsDbClusterArn': 'string', 'RdsDbProxyArn': 'string', 'RdsEndpoint': 'string', 'SubnetIds': [ 'string', ] }, 'CidrOptions': { 'Cidr': 'string', 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'Protocol': 'http'|'https'|'tcp', 'SubnetIds': [ 'string', ] } } } **Response Structure** * *(dict) --* * **VerifiedAccessEndpoint** *(dict) --* Details about the Verified Access endpoint. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **VerifiedAccessGroupId** *(string) --* The ID of the Amazon Web Services Verified Access group. * **VerifiedAccessEndpointId** *(string) --* The ID of the Amazon Web Services Verified Access endpoint. * **ApplicationDomain** *(string) --* The DNS name for users to reach your application. * **EndpointType** *(string) --* The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. * **AttachmentType** *(string) --* The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application. * **DomainCertificateArn** *(string) --* The ARN of a public TLS/SSL certificate imported into or created with ACM. * **EndpointDomain** *(string) --* A DNS name that is generated for the endpoint. * **DeviceValidationDomain** *(string) --* Returned if endpoint has a device trust provider attached. * **SecurityGroupIds** *(list) --* The IDs of the security groups for the endpoint. * *(string) --* * **LoadBalancerOptions** *(dict) --* The load balancer details if creating the Amazon Web Services Verified Access endpoint as >>``<" - 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. * "tenancy" - The tenancy of an instance ( "dedicated" | "default" | "host"). * "tpm-support" - Indicates if the instance is configured for NitroTPM support ( "v2.0"). * "usage-operation" - The usage operation value for the instance ( "RunInstances" | "RunInstances:00g0" | "RunInstances:0010" | "RunInstances:1010" | "RunInstances:1014" | "RunInstances:1110" | "RunInstances:0014" | "RunInstances:0210" | "RunInstances:0110" | "RunInstances:0100" | "RunInstances:0004" | "RunInstances:0200" | "RunInstances:000g" | "RunInstances:0g00" | "RunInstances:0002" | "RunInstances:0800" | "RunInstances:0102" | "RunInstances:0006" | "RunInstances:0202"). * "usage-operation-update-time" - The time that the usage operation was last updated, for example, "2022-09-15T17:15:20.000Z". * "virtualization-type" - The virtualization type of the instance ( "paravirtual" | "hvm"). * "vpc-id" - The ID of the VPC that the instance is running in. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. You cannot specify this parameter and the instance IDs parameter in the same request. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Reservations': [ { 'ReservationId': 'string', 'OwnerId': 'string', 'RequesterId': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Instances': [ { 'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'Ebs': { 'AttachTime': datetime(2015, 1, 1), 'DeleteOnTermination': True|False, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'VolumeId': 'string', 'AssociatedResource': 'string', 'VolumeOwnerId': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' } } }, ], 'ClientToken': 'string', 'EbsOptimized': True|False, 'EnaSupport': True|False, 'Hypervisor': 'ovm'|'xen', 'IamInstanceProfile': { 'Arn': 'string', 'Id': 'string' }, 'InstanceLifecycle': 'spot'|'scheduled'|'capacity-block', 'ElasticGpuAssociations': [ { 'ElasticGpuId': 'string', 'ElasticGpuAssociationId': 'string', 'ElasticGpuAssociationState': 'string', 'ElasticGpuAssociationTime': 'string' }, ], 'ElasticInferenceAcceleratorAssociations': [ { 'ElasticInferenceAcceleratorArn': 'string', 'ElasticInferenceAcceleratorAssociationId': 'string', 'ElasticInferenceAcceleratorAssociationState': 'string', 'ElasticInferenceAcceleratorAssociationTime': datetime(2015, 1, 1) }, ], 'NetworkInterfaces': [ { 'Association': { 'CarrierIp': 'string', 'CustomerOwnedIp': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string' }, 'Attachment': { 'AttachTime': datetime(2015, 1, 1), 'AttachmentId': 'string', 'DeleteOnTermination': True|False, 'DeviceIndex': 123, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'NetworkCardIndex': 123, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'EnaQueueCount': 123 }, 'Description': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'MacAddress': 'string', 'NetworkInterfaceId': 'string', 'OwnerId': 'string', 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Association': { 'CarrierIp': 'string', 'CustomerOwnedIp': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string' }, 'Primary': True|False, 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string' }, ], 'SourceDestCheck': True|False, 'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching', 'SubnetId': 'string', 'VpcId': 'string', 'InterfaceType': 'string', 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'ConnectionTrackingConfiguration': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], 'OutpostArn': 'string', 'RootDeviceName': 'string', 'RootDeviceType': 'ebs'|'instance-store', 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'SourceDestCheck': True|False, 'SpotInstanceRequestId': 'string', 'SriovNetSupport': 'string', 'StateReason': { 'Code': 'string', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VirtualizationType': 'hvm'|'paravirtual', 'CpuOptions': { 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, 'CapacityBlockId': 'string', 'CapacityReservationId': 'string', 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'HibernationOptions': { 'Configured': True|False }, 'Licenses': [ { 'LicenseConfigurationArn': 'string' }, ], 'MetadataOptions': { 'State': 'pending'|'applied', 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, 'EnclaveOptions': { 'Enabled': True|False }, 'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred', 'PlatformDetails': 'string', 'UsageOperation': 'string', 'UsageOperationUpdateTime': datetime(2015, 1, 1), 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'Ipv6Address': 'string', 'TpmSupport': 'string', 'MaintenanceOptions': { 'AutoRecovery': 'disabled'|'default', 'RebootMigration': 'disabled'|'default' }, 'CurrentInstanceBootMode': 'legacy-bios'|'uefi', 'NetworkPerformanceOptions': { 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' }, 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'InstanceId': 'string', 'ImageId': 'string', 'State': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'PrivateDnsName': 'string', 'PublicDnsName': 'string', 'StateTransitionReason': 'string', 'KeyName': 'string', 'AmiLaunchIndex': 123, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'LaunchTime': datetime(2015, 1, 1), 'Placement': { 'Affinity': 'string', 'GroupName': 'string', 'PartitionNumber': 123, 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'GroupId': 'string', 'AvailabilityZone': 'string' }, 'KernelId': 'string', 'RamdiskId': 'string', 'Platform': 'Windows', 'Monitoring': { 'State': 'disabled'|'disabling'|'enabled'|'pending' }, 'SubnetId': 'string', 'VpcId': 'string', 'PrivateIpAddress': 'string', 'PublicIpAddress': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Reservations** *(list) --* Information about the reservations. * *(dict) --* Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request. * **ReservationId** *(string) --* The ID of the reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the reservation. * **RequesterId** *(string) --* The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling). * **Groups** *(list) --* Not supported. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **Instances** *(list) --* The instances. * *(dict) --* Describes an instance. * **Architecture** *(string) --* The architecture of the image. * **BlockDeviceMappings** *(list) --* Any block device mapping entries for the instance. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Status** *(string) --* The attachment state. * **VolumeId** *(string) --* The ID of the EBS volume. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **VolumeOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the volume. This parameter is returned only for volumes that are attached to Amazon Web Services- managed resources. * **Operator** *(dict) --* The service provider that manages the EBS volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **ClientToken** *(string) --* The idempotency token you provided when you launched the instance, if applicable. * **EbsOptimized** *(boolean) --* 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 I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. * **EnaSupport** *(boolean) --* Specifies whether enhanced networking with ENA is enabled. * **Hypervisor** *(string) --* The hypervisor type of the instance. The value "xen" is used for both Xen and Nitro hypervisors. * **IamInstanceProfile** *(dict) --* The IAM instance profile associated with the instance, if applicable. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. * **InstanceLifecycle** *(string) --* Indicates whether this is a Spot Instance or a Scheduled Instance. * **ElasticGpuAssociations** *(list) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. Describes the association between an instance and an Elastic Graphics accelerator. * **ElasticGpuId** *(string) --* The ID of the Elastic Graphics accelerator. * **ElasticGpuAssociationId** *(string) --* The ID of the association. * **ElasticGpuAssociationState** *(string) --* The state of the association between the instance and the Elastic Graphics accelerator. * **ElasticGpuAssociationTime** *(string) --* The time the Elastic Graphics accelerator was associated with the instance. * **ElasticInferenceAcceleratorAssociations** *(list) --* Deprecated Note: Amazon Elastic Inference is no longer available. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes the association between an instance and an elastic inference accelerator. * **ElasticInferenceAcceleratorArn** *(string) --* The Amazon Resource Name (ARN) of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationId** *(string) --* The ID of the association. * **ElasticInferenceAcceleratorAssociationState** *(string) --* The state of the elastic inference accelerator. * **ElasticInferenceAcceleratorAssociationTime** *(datetime) --* The time at which the elastic inference accelerator is associated with an instance. * **NetworkInterfaces** *(list) --* The network interfaces for the instance. * *(dict) --* Describes a network interface. * **Association** *(dict) --* The association information for an Elastic IPv4 associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Attachment** *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The index of the device on the instance for the network interface attachment. * **Status** *(string) --* The attachment state. * **NetworkCardIndex** *(integer) --* The index of the network card. * **EnaSrdSpecification** *(dict) --* Contains the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **Description** *(string) --* The description. * **Groups** *(list) --* The security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **Ipv6Addresses** *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **MacAddress** *(string) --* The MAC address. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that created the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes a private IPv4 address. * **Association** *(dict) --* The association information for an Elastic IP address for the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **IpOwnerId** *(string) --* The ID of the owner of the Elastic IP address. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The public IP address or Elastic IP address bound to the network interface. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IP address of the network interface. * **PrivateDnsName** *(string) --* The private IPv4 DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **Status** *(string) --* The status of the network interface. * **SubnetId** *(string) --* The ID of the subnet. * **VpcId** *(string) --* The ID of the VPC. * **InterfaceType** *(string) --* The type of network interface. Valid values: "interface" | "efa" | "efa-only" | "evs" | "trunk" * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv4 prefix. * **Ipv4Prefix** *(string) --* One or more IPv4 prefixes assigned to the network interface. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes that are assigned to the network interface. * *(dict) --* Information about an IPv6 prefix. * **Ipv6Prefix** *(string) --* One or more IPv6 prefixes assigned to the network interface. * **ConnectionTrackingConfiguration** *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Operator** *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **RootDeviceName** *(string) --* The device name of the root device volume (for example, "/dev/sda1"). * **RootDeviceType** *(string) --* The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. * **SecurityGroups** *(list) --* The security groups for the instance. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **SpotInstanceRequestId** *(string) --* If the request is a Spot Instance request, the ID of the request. * **SriovNetSupport** *(string) --* Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **StateReason** *(dict) --* The reason for the most recent state transition. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. * **Tags** *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VirtualizationType** *(string) --* The virtualization type of the instance. * **CpuOptions** *(dict) --* The CPU options for the instance. * **CoreCount** *(integer) --* The number of CPU cores for the instance. * **ThreadsPerCore** *(integer) --* The number of threads per CPU core. * **AmdSevSnp** *(string) --* Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. Note: For P5 instances, a Capacity Block ID refers to a group of instances. For Trn2u instances, a capacity block ID refers to an EC2 UltraServer. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **CapacityReservationSpecification** *(dict) --* Information about the Capacity Reservation targeting option. * **CapacityReservationPreference** *(string) --* Describes the instance's Capacity Reservation preferences. Possible preferences include: * "open" - The instance can run in any "open" Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * "none" - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. * **CapacityReservationTarget** *(dict) --* Information about the targeted Capacity Reservation or Capacity Reservation group. * **CapacityReservationId** *(string) --* The ID of the targeted Capacity Reservation. * **CapacityReservationResourceGroupArn** *(string) --* The ARN of the targeted Capacity Reservation group. * **HibernationOptions** *(dict) --* Indicates whether the instance is enabled for hibernation. * **Configured** *(boolean) --* If "true", your instance is enabled for hibernation; otherwise, it is not enabled for hibernation. * **Licenses** *(list) --* The license configurations for the instance. * *(dict) --* Describes a license configuration. * **LicenseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the license configuration. * **MetadataOptions** *(dict) --* The metadata options for the instance. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. * "required" - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. * **HttpPutResponseHopLimit** *(integer) --* The maximum number of hops that the metadata token can travel. Possible values: Integers from "1" to "64" * **HttpEndpoint** *(string) --* Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled. If the value is "disabled", you cannot access your instance metadata. * **HttpProtocolIpv6** *(string) --* Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. Default: "disabled" * **InstanceMetadataTags** *(string) --* Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata. * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **BootMode** *(string) --* The boot mode that was specified by the AMI. If the value is "uefi-preferred", the AMI supports both UEFI and Legacy BIOS. The "currentInstanceBootMode" parameter is the boot mode that is used to boot the instance at launch or start. Note: The operating system contained in the AMI must be configured to support the specified boot mode. For more information, see Boot modes in the *Amazon EC2 User Guide*. * **PlatformDetails** *(string) --* The platform details value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. * **UsageOperation** *(string) --* The usage operation value for the instance. For more information, see AMI billing information fields in the *Amazon EC2 User Guide*. * **UsageOperationUpdateTime** *(datetime) --* The time that the usage operation was last updated. * **PrivateDnsNameOptions** *(dict) --* The options for the instance hostname. * **HostnameType** *(string) --* The type of hostname to assign to an instance. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * **Ipv6Address** *(string) --* The IPv6 address assigned to the instance. * **TpmSupport** *(string) --* If the instance is configured for NitroTPM support, the value is "v2.0". For more information, see NitroTPM in the *Amazon EC2 User Guide*. * **MaintenanceOptions** *(dict) --* Provides information on the recovery and maintenance options of your instance. * **AutoRecovery** *(string) --* Provides information on the current automatic recovery behavior of your instance. * **RebootMigration** *(string) --* Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled "system-reboot" event: * "default" - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the "system-reboot" event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled. * "disabled" - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The "system-reboot" event remains scheduled. This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the *Amazon EC2 User Guide*. * **CurrentInstanceBootMode** *(string) --* The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the *Amazon EC2 User Guide*. * **NetworkPerformanceOptions** *(dict) --* Contains settings for the network performance options for your instance. * **BandwidthWeighting** *(string) --* When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type. * **Operator** *(dict) --* The service provider that manages the instance. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **InstanceId** *(string) --* The ID of the instance. * **ImageId** *(string) --* The ID of the AMI used to launch the instance. * **State** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **PrivateDnsName** *(string) --* [IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the "running" state. The Amazon-provided DNS server resolves Amazon- provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate. * **PublicDnsName** *(string) --* The public DNS name assigned to the instance. This name is not available until the instance enters the "running" state. This name is only available if you've enabled DNS hostnames for your VPC. The format of this name depends on the public hostname type. * **StateTransitionReason** *(string) --* The reason for the most recent state transition. This might be an empty string. * **KeyName** *(string) --* The name of the key pair, if this instance was launched with an associated key pair. * **AmiLaunchIndex** *(integer) --* The AMI launch index, which can be used to find this instance in the launch group. * **ProductCodes** *(list) --* The product codes attached to this instance, if applicable. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **InstanceType** *(string) --* The instance type. * **LaunchTime** *(datetime) --* The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface. * **Placement** *(dict) --* The location where the instance launched, if applicable. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. * **KernelId** *(string) --* The kernel associated with this instance, if applicable. * **RamdiskId** *(string) --* The RAM disk associated with this instance, if applicable. * **Platform** *(string) --* The platform. This value is "windows" for Windows instances; otherwise, it is empty. * **Monitoring** *(dict) --* The monitoring for the instance. * **State** *(string) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **SubnetId** *(string) --* The ID of the subnet in which the instance is running. * **VpcId** *(string) --* The ID of the VPC in which the instance is running. * **PrivateIpAddress** *(string) --* The private IPv4 address assigned to the instance. * **PublicIpAddress** *(string) --* The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable. A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone. **Examples** This example describes the specified instance. response = client.describe_instances( InstanceIds=[ 'i-1234567890abcdef0', ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example describes the instances with the t2.micro instance type. response = client.describe_instances( Filters=[ { 'Name': 'instance-type', 'Values': [ 't2.micro', ], }, ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example describes the instances with the Purpose=test tag. response = client.describe_instances( Filters=[ { 'Name': 'tag:Purpose', 'Values': [ 'test', ], }, ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_vpn_tunnel_options modify_vpn_tunnel_options ************************* EC2.Client.modify_vpn_tunnel_options(**kwargs) Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the *Amazon Web Services Site- to-Site VPN User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_vpn_tunnel_options( VpnConnectionId='string', VpnTunnelOutsideIpAddress='string', TunnelOptions={ 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DPDTimeoutSeconds': 123, 'DPDTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IKEVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string', 'LogOptions': { 'CloudWatchLogOptions': { 'LogEnabled': True|False, 'LogGroupArn': 'string', 'LogOutputFormat': 'string' } }, 'EnableTunnelLifecycleControl': True|False }, DryRun=True|False, SkipTunnelReplacement=True|False, PreSharedKeyStorage='string' ) Parameters: * **VpnConnectionId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services Site-to-Site VPN connection. * **VpnTunnelOutsideIpAddress** (*string*) -- **[REQUIRED]** The external IP address of the VPN tunnel. * **TunnelOptions** (*dict*) -- **[REQUIRED]** The tunnel options to modify. * **TunnelInsideCidr** *(string) --* The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. Constraints: A size /30 CIDR block from the "169.254.0.0/16" range. The following CIDR blocks are reserved and cannot be used: * "169.254.0.0/30" * "169.254.1.0/30" * "169.254.2.0/30" * "169.254.3.0/30" * "169.254.4.0/30" * "169.254.5.0/30" * "169.254.169.252/30" * **TunnelInsideIpv6Cidr** *(string) --* The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway. Constraints: A size /126 CIDR block from the local "fd00::/8" range. * **PreSharedKey** *(string) --* The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0). * **Phase1LifetimeSeconds** *(integer) --* The lifetime for phase 1 of the IKE negotiation, in seconds. Constraints: A value between 900 and 28,800. Default: "28800" * **Phase2LifetimeSeconds** *(integer) --* The lifetime for phase 2 of the IKE negotiation, in seconds. Constraints: A value between 900 and 3,600. The value must be less than the value for "Phase1LifetimeSeconds". Default: "3600" * **RekeyMarginTimeSeconds** *(integer) --* The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for "RekeyFuzzPercentage". Constraints: A value between 60 and half of "Phase2LifetimeSeconds". Default: "270" * **RekeyFuzzPercentage** *(integer) --* The percentage of the rekey window (determined by "RekeyMarginTimeSeconds") during which the rekey time is randomly selected. Constraints: A value between 0 and 100. Default: "100" * **ReplayWindowSize** *(integer) --* The number of packets in an IKE replay window. Constraints: A value between 64 and 2048. Default: "1024" * **DPDTimeoutSeconds** *(integer) --* The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive. Constraints: A value greater than or equal to 30. Default: "40" * **DPDTimeoutAction** *(string) --* The action to take after DPD timeout occurs. Specify "restart" to restart the IKE initiation. Specify "clear" to end the IKE session. Valid Values: "clear" | "none" | "restart" Default: "clear" * **Phase1EncryptionAlgorithms** *(list) --* One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations. Valid values: "AES128" | "AES256" | "AES128-GCM-16" | "AES256-GCM-16" * *(dict) --* Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. * **Value** *(string) --* The value for the encryption algorithm. * **Phase2EncryptionAlgorithms** *(list) --* One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations. Valid values: "AES128" | "AES256" | "AES128-GCM-16" | "AES256-GCM-16" * *(dict) --* Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. * **Value** *(string) --* The encryption algorithm. * **Phase1IntegrityAlgorithms** *(list) --* One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations. Valid values: "SHA1" | "SHA2-256" | "SHA2-384" | "SHA2-512" * *(dict) --* Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. * **Value** *(string) --* The value for the integrity algorithm. * **Phase2IntegrityAlgorithms** *(list) --* One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations. Valid values: "SHA1" | "SHA2-256" | "SHA2-384" | "SHA2-512" * *(dict) --* Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. * **Value** *(string) --* The integrity algorithm. * **Phase1DHGroupNumbers** *(list) --* One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations. Valid values: "2" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" * *(dict) --* Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **Phase2DHGroupNumbers** *(list) --* One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations. Valid values: "2" | "5" | "14" | "15" | "16" | "17" | "18" | "19" | "20" | "21" | "22" | "23" | "24" * *(dict) --* Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **IKEVersions** *(list) --* The IKE versions that are permitted for the VPN tunnel. Valid values: "ikev1" | "ikev2" * *(dict) --* The IKE version that is permitted for the VPN tunnel. * **Value** *(string) --* The IKE version. * **StartupAction** *(string) --* The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify "start" for Amazon Web Services to initiate the IKE negotiation. Valid Values: "add" | "start" Default: "add" * **LogOptions** *(dict) --* Options for logging VPN tunnel activity. * **CloudWatchLogOptions** *(dict) --* Options for sending VPN tunnel logs to CloudWatch. * **LogEnabled** *(boolean) --* Enable or disable VPN tunnel logging feature. Default value is "False". Valid values: "True" | "False" * **LogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. * **LogOutputFormat** *(string) --* Set log format. Default format is "json". Valid values: "json" | "text" * **EnableTunnelLifecycleControl** *(boolean) --* Turn on or off tunnel endpoint lifecycle control feature. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SkipTunnelReplacement** (*boolean*) -- Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off "EnableTunnelLifecycleControl". Valid values: "True" | "False" * **PreSharedKeyStorage** (*string*) -- Specifies the storage mode for the pre-shared key (PSK). Valid values are "Standard" (stored in Site-to-Site VPN service) or "SecretsManager" (stored in Amazon Web Services Secrets Manager). Return type: dict Returns: **Response Syntax** { 'VpnConnection': { 'Category': 'string', 'TransitGatewayId': 'string', 'CoreNetworkArn': 'string', 'CoreNetworkAttachmentArn': 'string', 'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'OutsideIpAddressType': 'string', 'TransportTransitGatewayAttachmentId': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string', 'LogOptions': { 'CloudWatchLogOptions': { 'LogEnabled': True|False, 'LogGroupArn': 'string', 'LogOutputFormat': 'string' } }, 'EnableTunnelLifecycleControl': True|False }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ], 'PreSharedKeyArn': 'string', 'VpnConnectionId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CustomerGatewayConfiguration': 'string', 'Type': 'ipsec.1', 'CustomerGatewayId': 'string', 'VpnGatewayId': 'string' } } **Response Structure** * *(dict) --* * **VpnConnection** *(dict) --* Information about the VPN connection. * **Category** *(string) --* The category of the VPN connection. A value of "VPN" indicates an Amazon Web Services VPN connection. A value of "VPN-Classic" indicates an Amazon Web Services Classic VPN connection. * **TransitGatewayId** *(string) --* The ID of the transit gateway associated with the VPN connection. * **CoreNetworkArn** *(string) --* The ARN of the core network. * **CoreNetworkAttachmentArn** *(string) --* The ARN of the core network attachment. * **GatewayAssociationState** *(string) --* The current state of the gateway association. * **Options** *(dict) --* The VPN connection options. * **EnableAcceleration** *(boolean) --* Indicates whether acceleration is enabled for the VPN connection. * **StaticRoutesOnly** *(boolean) --* Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. * **LocalIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the Amazon Web Services side of the VPN connection. * **LocalIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the Amazon Web Services side of the VPN connection. * **OutsideIpAddressType** *(string) --* The type of IPv4 address assigned to the outside interface of the customer gateway. Valid values: "PrivateIpv4" | "PublicIpv4" | "Ipv6" Default: "PublicIpv4" * **TransportTransitGatewayAttachmentId** *(string) --* The transit gateway attachment ID in use for the VPN tunnel. * **TunnelInsideIpVersion** *(string) --* Indicates whether the VPN tunnels process IPv4 or IPv6 traffic. * **TunnelOptions** *(list) --* Indicates the VPN tunnel options. * *(dict) --* The VPN tunnel options. * **OutsideIpAddress** *(string) --* The external IP address of the VPN tunnel. * **TunnelInsideCidr** *(string) --* The range of inside IPv4 addresses for the tunnel. * **TunnelInsideIpv6Cidr** *(string) --* The range of inside IPv6 addresses for the tunnel. * **PreSharedKey** *(string) --* The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. * **Phase1LifetimeSeconds** *(integer) --* The lifetime for phase 1 of the IKE negotiation, in seconds. * **Phase2LifetimeSeconds** *(integer) --* The lifetime for phase 2 of the IKE negotiation, in seconds. * **RekeyMarginTimeSeconds** *(integer) --* The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. * **RekeyFuzzPercentage** *(integer) --* The percentage of the rekey window determined by "RekeyMarginTimeSeconds" during which the rekey time is randomly selected. * **ReplayWindowSize** *(integer) --* The number of packets in an IKE replay window. * **DpdTimeoutSeconds** *(integer) --* The number of seconds after which a DPD timeout occurs. * **DpdTimeoutAction** *(string) --* The action to take after a DPD timeout occurs. * **Phase1EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The encryption algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the encryption algorithm. * **Phase2EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The encryption algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The encryption algorithm. * **Phase1IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The integrity algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the integrity algorithm. * **Phase2IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The integrity algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The integrity algorithm. * **Phase1DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 1 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **Phase2DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 2 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **IkeVersions** *(list) --* The IKE versions that are permitted for the VPN tunnel. * *(dict) --* The internet key exchange (IKE) version permitted for the VPN tunnel. * **Value** *(string) --* The IKE version. * **StartupAction** *(string) --* The action to take when the establishing the VPN tunnels for a VPN connection. * **LogOptions** *(dict) --* Options for logging VPN tunnel activity. * **CloudWatchLogOptions** *(dict) --* Options for sending VPN tunnel logs to CloudWatch. * **LogEnabled** *(boolean) --* Status of VPN tunnel logging feature. Default value is "False". Valid values: "True" | "False" * **LogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. * **LogOutputFormat** *(string) --* Configured log format. Default format is "json". Valid values: "json" | "text" * **EnableTunnelLifecycleControl** *(boolean) --* Status of tunnel endpoint lifecycle control feature. * **Routes** *(list) --* The static routes associated with the VPN connection. * *(dict) --* Describes a static route for a VPN connection. * **DestinationCidrBlock** *(string) --* The CIDR block associated with the local subnet of the customer data center. * **Source** *(string) --* Indicates how the routes were provided. * **State** *(string) --* The current state of the static route. * **Tags** *(list) --* Any tags assigned to the VPN connection. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VgwTelemetry** *(list) --* Information about the VPN tunnel. * *(dict) --* Describes telemetry for a VPN tunnel. * **AcceptedRouteCount** *(integer) --* The number of accepted routes. * **LastStatusChange** *(datetime) --* The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected. * **OutsideIpAddress** *(string) --* The Internet-routable IP address of the virtual private gateway's outside interface. * **Status** *(string) --* The status of the VPN tunnel. * **StatusMessage** *(string) --* If an error occurs, a description of the error. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. * **PreSharedKeyArn** *(string) --* The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. * **VpnConnectionId** *(string) --* The ID of the VPN connection. * **State** *(string) --* The current state of the VPN connection. * **CustomerGatewayConfiguration** *(string) --* The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the "pending" or "available" state. * **Type** *(string) --* The type of VPN connection. * **CustomerGatewayId** *(string) --* The ID of the customer gateway at your end of the VPN connection. * **VpnGatewayId** *(string) --* The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. EC2 / Client / delete_key_pair delete_key_pair *************** EC2.Client.delete_key_pair(**kwargs) Deletes the specified key pair, by removing the public key from Amazon EC2. See also: AWS API Documentation **Request Syntax** response = client.delete_key_pair( KeyName='string', KeyPairId='string', DryRun=True|False ) Parameters: * **KeyName** (*string*) -- The name of the key pair. * **KeyPairId** (*string*) -- The ID of the key pair. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'KeyPairId': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Is "true" if the request succeeds, and an error otherwise. * **KeyPairId** *(string) --* The ID of the key pair. **Examples** This example deletes the specified key pair. response = client.delete_key_pair( KeyName='my-key-pair', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / associate_nat_gateway_address associate_nat_gateway_address ***************************** EC2.Client.associate_nat_gateway_address(**kwargs) Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the *Amazon VPC User Guide*. By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the *Amazon VPC User Guide*. Warning: When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_nat_gateway_address( NatGatewayId='string', AllocationIds=[ 'string', ], PrivateIpAddresses=[ 'string', ], DryRun=True|False ) Parameters: * **NatGatewayId** (*string*) -- **[REQUIRED]** The ID of the NAT gateway. * **AllocationIds** (*list*) -- **[REQUIRED]** The allocation IDs of EIPs that you want to associate with your NAT gateway. * *(string) --* * **PrivateIpAddresses** (*list*) -- The private IPv4 addresses that you want to assign to the NAT gateway. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'NatGatewayId': 'string', 'NatGatewayAddresses': [ { 'AllocationId': 'string', 'NetworkInterfaceId': 'string', 'PrivateIp': 'string', 'PublicIp': 'string', 'AssociationId': 'string', 'IsPrimary': True|False, 'FailureMessage': 'string', 'Status': 'assigning'|'unassigning'|'associating'|'disassociating'|'succeeded'|'failed' }, ] } **Response Structure** * *(dict) --* * **NatGatewayId** *(string) --* The ID of the NAT gateway. * **NatGatewayAddresses** *(list) --* The IP addresses. * *(dict) --* Describes the IP addresses and network interface associated with a NAT gateway. * **AllocationId** *(string) --* [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway. * **NetworkInterfaceId** *(string) --* The ID of the network interface associated with the NAT gateway. * **PrivateIp** *(string) --* The private IP address associated with the NAT gateway. * **PublicIp** *(string) --* [Public NAT gateway only] The Elastic IP address associated with the NAT gateway. * **AssociationId** *(string) --* [Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway. * **IsPrimary** *(boolean) --* Defines if the IP address is the primary address. * **FailureMessage** *(string) --* The address failure message. * **Status** *(string) --* The address status. EC2 / Client / create_capacity_reservation_by_splitting create_capacity_reservation_by_splitting **************************************** EC2.Client.create_capacity_reservation_by_splitting(**kwargs) Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be "active" and owned by your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.create_capacity_reservation_by_splitting( DryRun=True|False, ClientToken='string', SourceCapacityReservationId='string', InstanceCount=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. This field is autopopulated if not provided. * **SourceCapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation from which you want to split the capacity. * **InstanceCount** (*integer*) -- **[REQUIRED]** The number of instances to split from the source Capacity Reservation. * **TagSpecifications** (*list*) -- The tags to apply to the new Capacity Reservation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'SourceCapacityReservation': { 'CapacityReservationId': 'string', 'OwnerId': 'string', 'CapacityReservationArn': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'string', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'TotalInstanceCount': 123, 'AvailableInstanceCount': 123, 'EbsOptimized': True|False, 'EphemeralStorage': True|False, 'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'unavailable', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'EndDateType': 'unlimited'|'limited', 'InstanceMatchCriteria': 'open'|'targeted', 'CreateDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OutpostArn': 'string', 'CapacityReservationFleetId': 'string', 'PlacementGroupArn': 'string', 'CapacityAllocations': [ { 'AllocationType': 'used'|'future', 'Count': 123 }, ], 'ReservationType': 'default'|'capacity-block', 'UnusedReservationBillingOwnerId': 'string', 'CommitmentInfo': { 'CommittedInstanceCount': 123, 'CommitmentEndDate': datetime(2015, 1, 1) }, 'DeliveryPreference': 'fixed'|'incremental', 'CapacityBlockId': 'string' }, 'DestinationCapacityReservation': { 'CapacityReservationId': 'string', 'OwnerId': 'string', 'CapacityReservationArn': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'string', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'TotalInstanceCount': 123, 'AvailableInstanceCount': 123, 'EbsOptimized': True|False, 'EphemeralStorage': True|False, 'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'unavailable', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'EndDateType': 'unlimited'|'limited', 'InstanceMatchCriteria': 'open'|'targeted', 'CreateDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OutpostArn': 'string', 'CapacityReservationFleetId': 'string', 'PlacementGroupArn': 'string', 'CapacityAllocations': [ { 'AllocationType': 'used'|'future', 'Count': 123 }, ], 'ReservationType': 'default'|'capacity-block', 'UnusedReservationBillingOwnerId': 'string', 'CommitmentInfo': { 'CommittedInstanceCount': 123, 'CommitmentEndDate': datetime(2015, 1, 1) }, 'DeliveryPreference': 'fixed'|'incremental', 'CapacityBlockId': 'string' }, 'InstanceCount': 123 } **Response Structure** * *(dict) --* * **SourceCapacityReservation** *(dict) --* Information about the source Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the Capacity Reservation. * **CapacityReservationArn** *(string) --* The Amazon Resource Name (ARN) of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Reservation. * **InstanceType** *(string) --* The type of instance for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the capacity is reserved. * **Tenancy** *(string) --* 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **AvailableInstanceCount** *(integer) --* The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. * **EbsOptimized** *(boolean) --* 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. * **EphemeralStorage** *(boolean) --* *Deprecated.* * **State** *(string) --* The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: * "active" - The capacity is available for use. * "expired" - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. * "cancelled" - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. * "scheduled" - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. * "payment-pending" - (*Capacity Blocks*) The upfront payment has not been processed yet. * "payment-failed" - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. * "assessing" - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. * "delayed" - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. * "unsupported" - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. * **StartDate** *(datetime) --* The date and time at which the Capacity Reservation was started. * **EndDate** *(datetime) --* 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. * **EndDateType** *(string) --* 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. * **InstanceMatchCriteria** *(string) --* 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. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Tags** *(list) --* Any tags assigned to the Capacity Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. * **PlacementGroupArn** *(string) --* The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the *Amazon EC2 User Guide*. * **CapacityAllocations** *(list) --* Information about instance capacity usage. * *(dict) --* Information about instance capacity usage for a Capacity Reservation. * **AllocationType** *(string) --* The usage type. "used" indicates that the instance capacity is in use by instances that are running in the Capacity Reservation. * **Count** *(integer) --* The amount of instance capacity associated with the usage. For example a value of "4" indicates that instance capacity for 4 instances is currently in use. * **ReservationType** *(string) --* The type of Capacity Reservation. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned. * **CommitmentInfo** *(dict) --* Information about your commitment for a future-dated Capacity Reservation. * **CommittedInstanceCount** *(integer) --* The instance capacity that you committed to when you requested the future-dated Capacity Reservation. * **CommitmentEndDate** *(datetime) --* The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). You can't decrease the instance count or cancel the Capacity Reservation before this date and time. * **DeliveryPreference** *(string) --* The delivery method for a future-dated Capacity Reservation. "incremental" indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **DestinationCapacityReservation** *(dict) --* Information about the destination Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the Capacity Reservation. * **CapacityReservationArn** *(string) --* The Amazon Resource Name (ARN) of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Reservation. * **InstanceType** *(string) --* The type of instance for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the capacity is reserved. * **Tenancy** *(string) --* 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **AvailableInstanceCount** *(integer) --* The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. * **EbsOptimized** *(boolean) --* 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. * **EphemeralStorage** *(boolean) --* *Deprecated.* * **State** *(string) --* The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: * "active" - The capacity is available for use. * "expired" - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. * "cancelled" - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. * "scheduled" - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. * "payment-pending" - (*Capacity Blocks*) The upfront payment has not been processed yet. * "payment-failed" - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. * "assessing" - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. * "delayed" - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. * "unsupported" - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. * **StartDate** *(datetime) --* The date and time at which the Capacity Reservation was started. * **EndDate** *(datetime) --* 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. * **EndDateType** *(string) --* 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. * **InstanceMatchCriteria** *(string) --* 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. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Tags** *(list) --* Any tags assigned to the Capacity Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. * **PlacementGroupArn** *(string) --* The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the *Amazon EC2 User Guide*. * **CapacityAllocations** *(list) --* Information about instance capacity usage. * *(dict) --* Information about instance capacity usage for a Capacity Reservation. * **AllocationType** *(string) --* The usage type. "used" indicates that the instance capacity is in use by instances that are running in the Capacity Reservation. * **Count** *(integer) --* The amount of instance capacity associated with the usage. For example a value of "4" indicates that instance capacity for 4 instances is currently in use. * **ReservationType** *(string) --* The type of Capacity Reservation. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned. * **CommitmentInfo** *(dict) --* Information about your commitment for a future-dated Capacity Reservation. * **CommittedInstanceCount** *(integer) --* The instance capacity that you committed to when you requested the future-dated Capacity Reservation. * **CommitmentEndDate** *(datetime) --* The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). You can't decrease the instance count or cancel the Capacity Reservation before this date and time. * **DeliveryPreference** *(string) --* The delivery method for a future-dated Capacity Reservation. "incremental" indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **InstanceCount** *(integer) --* The number of instances in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount. EC2 / Client / modify_instance_credit_specification modify_instance_credit_specification ************************************ EC2.Client.modify_instance_credit_specification(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.modify_instance_credit_specification( DryRun=True|False, ClientToken='string', InstanceCreditSpecifications=[ { 'InstanceId': 'string', 'CpuCredits': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. * **InstanceCreditSpecifications** (*list*) -- **[REQUIRED]** Information about the credit option for CPU usage. * *(dict) --* Describes the credit option for CPU usage of a burstable performance instance. * **InstanceId** *(string) --* **[REQUIRED]** The ID of the instance. * **CpuCredits** *(string) --* The credit option for CPU usage of the instance. Valid values: "standard" | "unlimited" T3 instances with "host" tenancy do not support the "unlimited" CPU credit option. Return type: dict Returns: **Response Syntax** { 'SuccessfulInstanceCreditSpecifications': [ { 'InstanceId': 'string' }, ], 'UnsuccessfulInstanceCreditSpecifications': [ { 'InstanceId': 'string', 'Error': { 'Code': 'InvalidInstanceID.Malformed'|'InvalidInstanceID.NotFound'|'IncorrectInstanceState'|'InstanceCreditSpecification.NotSupported', 'Message': 'string' } }, ] } **Response Structure** * *(dict) --* * **SuccessfulInstanceCreditSpecifications** *(list) --* Information about the instances whose credit option for CPU usage was successfully modified. * *(dict) --* Describes the burstable performance instance whose credit option for CPU usage was successfully modified. * **InstanceId** *(string) --* The ID of the instance. * **UnsuccessfulInstanceCreditSpecifications** *(list) --* Information about the instances whose credit option for CPU usage was not modified. * *(dict) --* Describes the burstable performance instance whose credit option for CPU usage was not modified. * **InstanceId** *(string) --* The ID of the instance. * **Error** *(dict) --* The applicable error for the burstable performance instance whose credit option for CPU usage was not modified. * **Code** *(string) --* The error code. * **Message** *(string) --* The applicable error message. EC2 / Client / describe_vpc_endpoints describe_vpc_endpoints ********************** EC2.Client.describe_vpc_endpoints(**kwargs) Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria. See also: AWS API Documentation **Request Syntax** response = client.describe_vpc_endpoints( DryRun=True|False, VpcEndpointIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcEndpointIds** (*list*) -- The IDs of the VPC endpoints. * *(string) --* * **Filters** (*list*) -- The filters. * "ip-address-type" - The IP address type ( "ipv4" | "ipv6"). * "service-name" - The name of the service. * "service-region" - The Region of the service. * "tag": - 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 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" | "Resource" | "ServiceNetwork"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next set of items to return. (You received this token from a prior call.) Return type: dict Returns: **Response Syntax** { 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcEndpointType': 'Interface'|'Gateway'|'GatewayLoadBalancer'|'Resource'|'ServiceNetwork', 'VpcId': 'string', 'ServiceName': 'string', 'State': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired'|'Partial', 'PolicyDocument': 'string', 'RouteTableIds': [ 'string', ], 'SubnetIds': [ 'string', ], 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'IpAddressType': 'ipv4'|'dualstack'|'ipv6', 'DnsOptions': { 'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined', 'PrivateDnsOnlyForInboundResolverEndpoint': True|False }, 'PrivateDnsEnabled': True|False, 'RequesterManaged': True|False, 'NetworkInterfaceIds': [ 'string', ], 'DnsEntries': [ { 'DnsName': 'string', 'HostedZoneId': 'string' }, ], 'CreationTimestamp': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OwnerId': 'string', 'LastError': { 'Message': 'string', 'Code': 'string' }, 'Ipv4Prefixes': [ { 'SubnetId': 'string', 'IpPrefixes': [ 'string', ] }, ], 'Ipv6Prefixes': [ { 'SubnetId': 'string', 'IpPrefixes': [ 'string', ] }, ], 'FailureReason': 'string', 'ServiceNetworkArn': 'string', 'ResourceConfigurationArn': 'string', 'ServiceRegion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VpcEndpoints** *(list) --* Information about the VPC endpoints. * *(dict) --* Describes a VPC endpoint. * **VpcEndpointId** *(string) --* The ID of the endpoint. * **VpcEndpointType** *(string) --* The type of endpoint. * **VpcId** *(string) --* The ID of the VPC to which the endpoint is associated. * **ServiceName** *(string) --* The name of the service to which the endpoint is associated. * **State** *(string) --* The state of the endpoint. * **PolicyDocument** *(string) --* The policy document associated with the endpoint, if applicable. * **RouteTableIds** *(list) --* (Gateway endpoint) The IDs of the route tables associated with the endpoint. * *(string) --* * **SubnetIds** *(list) --* (Interface endpoint) The subnets for the endpoint. * *(string) --* * **Groups** *(list) --* (Interface endpoint) Information about the security groups that are associated with the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **IpAddressType** *(string) --* The IP address type for the endpoint. * **DnsOptions** *(dict) --* The DNS options for the endpoint. * **DnsRecordIpType** *(string) --* The DNS records created for the endpoint. * **PrivateDnsOnlyForInboundResolverEndpoint** *(boolean) --* Indicates whether to enable private DNS only for inbound endpoints. * **PrivateDnsEnabled** *(boolean) --* (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. * **RequesterManaged** *(boolean) --* Indicates whether the endpoint is being managed by its service. * **NetworkInterfaceIds** *(list) --* (Interface endpoint) The network interfaces for the endpoint. * *(string) --* * **DnsEntries** *(list) --* (Interface endpoint) The DNS entries for the endpoint. * *(dict) --* Describes a DNS entry. * **DnsName** *(string) --* The DNS name. * **HostedZoneId** *(string) --* The ID of the private hosted zone. * **CreationTimestamp** *(datetime) --* The date and time that the endpoint was created. * **Tags** *(list) --* The tags assigned to the endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the endpoint. * **LastError** *(dict) --* The last error that occurred for endpoint. * **Message** *(string) --* The error message for the VPC endpoint error. * **Code** *(string) --* The error code for the VPC endpoint error. * **Ipv4Prefixes** *(list) --* Array of IPv4 prefixes. * *(dict) --* Prefixes of the subnet IP. * **SubnetId** *(string) --* ID of the subnet. * **IpPrefixes** *(list) --* Array of SubnetIpPrefixes objects. * *(string) --* * **Ipv6Prefixes** *(list) --* Array of IPv6 prefixes. * *(dict) --* Prefixes of the subnet IP. * **SubnetId** *(string) --* ID of the subnet. * **IpPrefixes** *(list) --* Array of SubnetIpPrefixes objects. * *(string) --* * **FailureReason** *(string) --* Reason for the failure. * **ServiceNetworkArn** *(string) --* The Amazon Resource Name (ARN) of the service network. * **ResourceConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the resource configuration. * **ServiceRegion** *(string) --* The Region where the service is hosted. * **NextToken** *(string) --* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. EC2 / Client / get_ipam_discovered_resource_cidrs get_ipam_discovered_resource_cidrs ********************************** EC2.Client.get_ipam_discovered_resource_cidrs(**kwargs) Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_discovered_resource_cidrs( DryRun=True|False, IpamResourceDiscoveryId='string', ResourceRegion='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** A resource discovery ID. * **ResourceRegion** (*string*) -- **[REQUIRED]** A resource Region. * **Filters** (*list*) -- Filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- Specify the pagination token from a previous request to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of discovered resource CIDRs to return in one page of results. Return type: dict Returns: **Response Syntax** { 'IpamDiscoveredResourceCidrs': [ { 'IpamResourceDiscoveryId': 'string', 'ResourceRegion': 'string', 'ResourceId': 'string', 'ResourceOwnerId': 'string', 'ResourceCidr': 'string', 'IpSource': 'amazon'|'byoip'|'none', 'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', 'ResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpUsage': 123.0, 'VpcId': 'string', 'SubnetId': 'string', 'NetworkInterfaceAttachmentStatus': 'available'|'in-use', 'SampleTime': datetime(2015, 1, 1), 'AvailabilityZoneId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IpamDiscoveredResourceCidrs** *(list) --* Discovered resource CIDRs. * *(dict) --* An IPAM discovered resource CIDR. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource. * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **ResourceRegion** *(string) --* The resource Region. * **ResourceId** *(string) --* The resource ID. * **ResourceOwnerId** *(string) --* The resource owner ID. * **ResourceCidr** *(string) --* The resource CIDR. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **ResourceType** *(string) --* The resource type. * **ResourceTags** *(list) --* The resource tags. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **IpUsage** *(float) --* The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following: * For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. * For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. * For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). * **VpcId** *(string) --* The VPC ID. * **SubnetId** *(string) --* The subnet ID. * **NetworkInterfaceAttachmentStatus** *(string) --* For elastic network interfaces, this is the status of whether or not the elastic network interface is attached. * **SampleTime** *(datetime) --* The last successful resource discovery time. * **AvailabilityZoneId** *(string) --* The Availability Zone ID. * **NextToken** *(string) --* Specify the pagination token from a previous request to retrieve the next page of results. EC2 / Client / describe_host_reservation_offerings describe_host_reservation_offerings *********************************** EC2.Client.describe_host_reservation_offerings(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.describe_host_reservation_offerings( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxDuration=123, MaxResults=123, MinDuration=123, NextToken='string', OfferingId='string' ) Parameters: * **Filters** (*list*) -- The filters. * "instance-family" - The instance family of the offering (for example, "m4"). * "payment-option" - The payment option ( "NoUpfront" | "PartialUpfront" | "AllUpfront"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxDuration** (*integer*) -- 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** (*integer*) -- 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** (*integer*) -- 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** (*string*) -- The token to use to retrieve the next page of results. * **OfferingId** (*string*) -- The ID of the reservation offering. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'OfferingSet': [ { 'CurrencyCode': 'USD', 'Duration': 123, 'HourlyPrice': 'string', 'InstanceFamily': 'string', 'OfferingId': 'string', 'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront', 'UpfrontPrice': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **OfferingSet** *(list) --* Information about the offerings. * *(dict) --* Details about the Dedicated Host Reservation offering. * **CurrencyCode** *(string) --* The currency of the offering. * **Duration** *(integer) --* The duration of the offering (in seconds). * **HourlyPrice** *(string) --* The hourly price of the offering. * **InstanceFamily** *(string) --* The instance family of the offering. * **OfferingId** *(string) --* The ID of the offering. * **PaymentOption** *(string) --* The available payment option. * **UpfrontPrice** *(string) --* The upfront price of the offering. Does not apply to No Upfront offerings. EC2 / Client / modify_vpc_endpoint_service_permissions modify_vpc_endpoint_service_permissions *************************************** EC2.Client.modify_vpc_endpoint_service_permissions(**kwargs) Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service. Principal ARNs with path components aren't supported. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. See also: AWS API Documentation **Request Syntax** response = client.modify_vpc_endpoint_service_permissions( DryRun=True|False, ServiceId='string', AddAllowedPrincipals=[ 'string', ], RemoveAllowedPrincipals=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the service. * **AddAllowedPrincipals** (*list*) -- The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*). * *(string) --* * **RemoveAllowedPrincipals** (*list*) -- The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list. * *(string) --* Return type: dict Returns: **Response Syntax** { 'AddedPrincipals': [ { 'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role', 'Principal': 'string', 'ServicePermissionId': 'string', 'ServiceId': 'string' }, ], 'ReturnValue': True|False } **Response Structure** * *(dict) --* * **AddedPrincipals** *(list) --* Information about the added principals. * *(dict) --* Describes a principal. * **PrincipalType** *(string) --* The type of principal. * **Principal** *(string) --* The Amazon Resource Name (ARN) of the principal. * **ServicePermissionId** *(string) --* The ID of the service permission. * **ServiceId** *(string) --* The ID of the service. * **ReturnValue** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / disable_fast_snapshot_restores disable_fast_snapshot_restores ****************************** EC2.Client.disable_fast_snapshot_restores(**kwargs) Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. See also: AWS API Documentation **Request Syntax** response = client.disable_fast_snapshot_restores( AvailabilityZones=[ 'string', ], SourceSnapshotIds=[ 'string', ], DryRun=True|False ) Parameters: * **AvailabilityZones** (*list*) -- **[REQUIRED]** One or more Availability Zones. For example, "us-east-2a". * *(string) --* * **SourceSnapshotIds** (*list*) -- **[REQUIRED]** The IDs of one or more snapshots. For example, "snap- 1234567890abcdef0". * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Successful': [ { 'SnapshotId': 'string', 'AvailabilityZone': 'string', 'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled', 'StateTransitionReason': 'string', 'OwnerId': 'string', 'OwnerAlias': 'string', 'EnablingTime': datetime(2015, 1, 1), 'OptimizingTime': datetime(2015, 1, 1), 'EnabledTime': datetime(2015, 1, 1), 'DisablingTime': datetime(2015, 1, 1), 'DisabledTime': datetime(2015, 1, 1) }, ], 'Unsuccessful': [ { 'SnapshotId': 'string', 'FastSnapshotRestoreStateErrors': [ { 'AvailabilityZone': 'string', 'Error': { 'Code': 'string', 'Message': 'string' } }, ] }, ] } **Response Structure** * *(dict) --* * **Successful** *(list) --* Information about the snapshots for which fast snapshot restores were successfully disabled. * *(dict) --* Describes fast snapshot restores that were successfully disabled. * **SnapshotId** *(string) --* The ID of the snapshot. * **AvailabilityZone** *(string) --* The Availability Zone. * **State** *(string) --* The state of fast snapshot restores for the snapshot. * **StateTransitionReason** *(string) --* The reason for the state transition. The possible values are as follows: * "Client.UserInitiated" - The state successfully transitioned to "enabling" or "disabling". * "Client.UserInitiated - Lifecycle state transition" - The state successfully transitioned to "optimizing", "enabled", or "disabled". * **OwnerId** *(string) --* The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. * **OwnerAlias** *(string) --* The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. * **EnablingTime** *(datetime) --* The time at which fast snapshot restores entered the "enabling" state. * **OptimizingTime** *(datetime) --* The time at which fast snapshot restores entered the "optimizing" state. * **EnabledTime** *(datetime) --* The time at which fast snapshot restores entered the "enabled" state. * **DisablingTime** *(datetime) --* The time at which fast snapshot restores entered the "disabling" state. * **DisabledTime** *(datetime) --* The time at which fast snapshot restores entered the "disabled" state. * **Unsuccessful** *(list) --* Information about the snapshots for which fast snapshot restores could not be disabled. * *(dict) --* Contains information about the errors that occurred when disabling fast snapshot restores. * **SnapshotId** *(string) --* The ID of the snapshot. * **FastSnapshotRestoreStateErrors** *(list) --* The errors. * *(dict) --* Contains information about an error that occurred when disabling fast snapshot restores. * **AvailabilityZone** *(string) --* The Availability Zone. * **Error** *(dict) --* The error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message. EC2 / Client / describe_security_group_rules describe_security_group_rules ***************************** EC2.Client.describe_security_group_rules(**kwargs) Describes one or more of your security group rules. See also: AWS API Documentation **Request Syntax** response = client.describe_security_group_rules( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SecurityGroupRuleIds=[ 'string', ], DryRun=True|False, NextToken='string', MaxResults=123 ) Parameters: * **Filters** (*list*) -- One or more filters. * "group-id" - The ID of the security group. * "security-group-rule-id" - The ID of the security group rule. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination. Return type: dict Returns: **Response Syntax** { 'SecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'GroupOwnerId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupInfo': { 'GroupId': 'string', 'PeeringStatus': 'string', 'UserId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string' }, 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SecurityGroupRuleArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SecurityGroupRules** *(list) --* Information about security group rules. * *(dict) --* Describes a security group rule. * **SecurityGroupRuleId** *(string) --* The ID of the security group rule. * **GroupId** *(string) --* The ID of the security group. * **GroupOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the security group. * **IsEgress** *(boolean) --* Indicates whether the security group rule is an outbound rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **CidrIpv4** *(string) --* The IPv4 CIDR range. * **CidrIpv6** *(string) --* The IPv6 CIDR range. * **PrefixListId** *(string) --* The ID of the prefix list. * **ReferencedGroupInfo** *(dict) --* Describes the security group that is referenced in the rule. * **GroupId** *(string) --* The ID of the security group. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **UserId** *(string) --* The Amazon Web Services account ID. * **VpcId** *(string) --* The ID of the VPC. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection (if applicable). * **Description** *(string) --* The security group rule description. * **Tags** *(list) --* The tags applied to the security group rule. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupRuleArn** *(string) --* The ARN of the security group rule. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / create_route create_route ************ EC2.Client.create_route(**kwargs) Creates a route in a route table within a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address "192.0.2.3", and the route table includes the following two IPv4 routes: * "192.0.2.0/24" (goes to some target A) * "192.0.2.0/28" (goes to some target B) Both routes apply to the traffic destined for "192.0.2.3". However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_route( DestinationPrefixListId='string', VpcEndpointId='string', TransitGatewayId='string', LocalGatewayId='string', CarrierGatewayId='string', CoreNetworkArn='string', OdbNetworkArn='string', DryRun=True|False, RouteTableId='string', DestinationCidrBlock='string', GatewayId='string', DestinationIpv6CidrBlock='string', EgressOnlyInternetGatewayId='string', InstanceId='string', NetworkInterfaceId='string', VpcPeeringConnectionId='string', NatGatewayId='string' ) Parameters: * **DestinationPrefixListId** (*string*) -- The ID of a prefix list used for the destination match. * **VpcEndpointId** (*string*) -- The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. * **TransitGatewayId** (*string*) -- The ID of a transit gateway. * **LocalGatewayId** (*string*) -- The ID of the local gateway. * **CarrierGatewayId** (*string*) -- 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. * **CoreNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the core network. * **OdbNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the ODB network. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table for the route. * **DestinationCidrBlock** (*string*) -- 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". * **GatewayId** (*string*) -- The ID of an internet gateway or virtual private gateway attached to your VPC. * **DestinationIpv6CidrBlock** (*string*) -- The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. * **EgressOnlyInternetGatewayId** (*string*) -- [IPv6 traffic only] The ID of an egress-only internet gateway. * **InstanceId** (*string*) -- 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. * **NetworkInterfaceId** (*string*) -- The ID of a network interface. * **VpcPeeringConnectionId** (*string*) -- The ID of a VPC peering connection. * **NatGatewayId** (*string*) -- [IPv4 traffic only] The ID of a NAT gateway. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. **Examples** This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway. response = client.create_route( DestinationCidrBlock='0.0.0.0/0', GatewayId='igw-c0a643a9', RouteTableId='rtb-22574640', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / detach_vpn_gateway detach_vpn_gateway ****************** EC2.Client.detach_vpn_gateway(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.detach_vpn_gateway( VpcId='string', VpnGatewayId='string', DryRun=True|False ) Parameters: * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **VpnGatewayId** (*string*) -- **[REQUIRED]** The ID of the virtual private gateway. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None EC2 / Client / delete_vpc delete_vpc ********** EC2.Client.delete_vpc(**kwargs) Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the default security group, network ACL, and route table for the VPC. If you created a flow log for the VPC that you are deleting, note that flow logs for deleted VPCs are eventually automatically removed. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc( VpcId='string', DryRun=True|False ) Parameters: * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None **Examples** This example deletes the specified VPC. response = client.delete_vpc( VpcId='vpc-a01106c2', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / terminate_client_vpn_connections terminate_client_vpn_connections ******************************** EC2.Client.terminate_client_vpn_connections(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.terminate_client_vpn_connections( ClientVpnEndpointId='string', ConnectionId='string', Username='string', DryRun=True|False ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint to which the client is connected. * **ConnectionId** (*string*) -- The ID of the client connection to be terminated. * **Username** (*string*) -- 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. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'ClientVpnEndpointId': 'string', 'Username': 'string', 'ConnectionStatuses': [ { 'ConnectionId': 'string', 'PreviousStatus': { 'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated', 'Message': 'string' }, 'CurrentStatus': { 'Code': 'active'|'failed-to-terminate'|'terminating'|'terminated', 'Message': 'string' } }, ] } **Response Structure** * *(dict) --* * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint. * **Username** *(string) --* The user who established the terminated client connections. * **ConnectionStatuses** *(list) --* The current state of the client connections. * *(dict) --* Information about a terminated Client VPN endpoint client connection. * **ConnectionId** *(string) --* The ID of the client connection. * **PreviousStatus** *(dict) --* The state of the client connection. * **Code** *(string) --* The state of the client connection. * **Message** *(string) --* A message about the status of the client connection, if applicable. * **CurrentStatus** *(dict) --* A message about the status of the client connection, if applicable. * **Code** *(string) --* The state of the client connection. * **Message** *(string) --* A message about the status of the client connection, if applicable. EC2 / Client / modify_verified_access_instance modify_verified_access_instance ******************************* EC2.Client.modify_verified_access_instance(**kwargs) Modifies the configuration of the specified Amazon Web Services Verified Access instance. See also: AWS API Documentation **Request Syntax** response = client.modify_verified_access_instance( VerifiedAccessInstanceId='string', Description='string', DryRun=True|False, ClientToken='string', CidrEndpointsCustomSubDomain='string' ) Parameters: * **VerifiedAccessInstanceId** (*string*) -- **[REQUIRED]** The ID of the Verified Access instance. * **Description** (*string*) -- A description for the Verified Access instance. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **CidrEndpointsCustomSubDomain** (*string*) -- The custom subdomain. Return type: dict Returns: **Response Syntax** { 'VerifiedAccessInstance': { 'VerifiedAccessInstanceId': 'string', 'Description': 'string', 'VerifiedAccessTrustProviders': [ { 'VerifiedAccessTrustProviderId': 'string', 'Description': 'string', 'TrustProviderType': 'user'|'device', 'UserTrustProviderType': 'iam-identity-center'|'oidc', 'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud' }, ], 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FipsEnabled': True|False, 'CidrEndpointsCustomSubDomain': { 'SubDomain': 'string', 'Nameservers': [ 'string', ] } } } **Response Structure** * *(dict) --* * **VerifiedAccessInstance** *(dict) --* Details about the Verified Access instance. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **Description** *(string) --* A description for the Amazon Web Services Verified Access instance. * **VerifiedAccessTrustProviders** *(list) --* The IDs of the Amazon Web Services Verified Access trust providers. * *(dict) --* Condensed information about a trust provider. * **VerifiedAccessTrustProviderId** *(string) --* The ID of the trust provider. * **Description** *(string) --* The description of trust provider. * **TrustProviderType** *(string) --* The type of trust provider (user- or device-based). * **UserTrustProviderType** *(string) --* The type of user-based trust provider. * **DeviceTrustProviderType** *(string) --* The type of device-based trust provider. * **CreationTime** *(string) --* The creation time. * **LastUpdatedTime** *(string) --* The last updated time. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **FipsEnabled** *(boolean) --* Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance. * **CidrEndpointsCustomSubDomain** *(dict) --* The custom subdomain. * **SubDomain** *(string) --* The subdomain. * **Nameservers** *(list) --* The name servers. * *(string) --* EC2 / Client / get_spot_placement_scores get_spot_placement_scores ************************* EC2.Client.get_spot_placement_scores(**kwargs) Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements. You can specify your compute requirements either by using "InstanceRequirementsWithMetadata" and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using "InstanceTypes". For more information, see Spot placement score in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_spot_placement_scores( InstanceTypes=[ 'string', ], TargetCapacity=123, TargetCapacityUnitType='vcpu'|'memory-mib'|'units', SingleAvailabilityZone=True|False, RegionNames=[ 'string', ], InstanceRequirementsWithMetadata={ 'ArchitectureTypes': [ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], 'VirtualizationTypes': [ 'hvm'|'paravirtual', ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, DryRun=True|False, MaxResults=123, NextToken='string' ) type InstanceTypes: list param InstanceTypes: The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an "m3.xlarge" with and without instance storage), the returned placement score will always be low. If you specify "InstanceTypes", you can't specify "InstanceRequirementsWithMetadata". * *(string) --* type TargetCapacity: integer param TargetCapacity: **[REQUIRED]** The target capacity. type TargetCapacityUnitType: string param TargetCapacityUnitType: The unit for the target capacity. type SingleAvailabilityZone: boolean param SingleAvailabilityZone: Specify "true" so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions. A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone. type RegionNames: list param RegionNames: The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, "us-east-1". * *(string) --* type InstanceRequirementsWithMetadata: dict param InstanceRequirementsWithMetadata: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify "InstanceRequirementsWithMetadata", you can't specify "InstanceTypes". * **ArchitectureTypes** *(list) --* The architecture type. * *(string) --* * **VirtualizationTypes** *(list) --* The virtualization type. * *(string) --* * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. * **VCpuCount** *(dict) --* **[REQUIRED]** The minimum and maximum number of vCPUs. * **Min** *(integer) --* **[REQUIRED]** The minimum number of vCPUs. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum number of vCPUs. To specify no maximum limit, omit this parameter. * **MemoryMiB** *(dict) --* **[REQUIRED]** The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* **[REQUIRED]** The minimum amount of memory, in MiB. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance family, type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per- instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On- Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To indicate no price protection threshold, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of network interfaces. To specify no maximum limit, omit this parameter. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set "Max" to "0". * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. type DryRun: boolean param DryRun: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". type MaxResults: integer param MaxResults: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. type NextToken: string param NextToken: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. rtype: dict returns: **Response Syntax** { 'SpotPlacementScores': [ { 'Region': 'string', 'AvailabilityZoneId': 'string', 'Score': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SpotPlacementScores** *(list) --* The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity *at the time of the Spot placement score request*. A score of "10" means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone. If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the "capacity-optimized" allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the "capacity-optimized" allocation strategy. Different Regions or Availability Zones might return the same score. Note: The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled. * *(dict) --* The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the "capacity-optimized" allocation strategy is used and that all of the Availability Zones in the Region can be used. * **Region** *(string) --* The Region. * **AvailabilityZoneId** *(string) --* The Availability Zone. * **Score** *(integer) --* The placement score, on a scale from "1" to "10". A score of "10" indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of "1" indicates that your Spot request is not likely to succeed. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / delete_placement_group delete_placement_group ********************** EC2.Client.delete_placement_group(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.delete_placement_group( DryRun=True|False, GroupName='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without 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** (*string*) -- **[REQUIRED]** The name of the placement group. Returns: None **Examples** This example deletes the specified placement group. response = client.delete_placement_group( GroupName='my-cluster', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_vpc_endpoint modify_vpc_endpoint ******************* EC2.Client.modify_vpc_endpoint(**kwargs) Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide. See also: AWS API Documentation **Request Syntax** response = client.modify_vpc_endpoint( DryRun=True|False, VpcEndpointId='string', ResetPolicy=True|False, PolicyDocument='string', AddRouteTableIds=[ 'string', ], RemoveRouteTableIds=[ 'string', ], AddSubnetIds=[ 'string', ], RemoveSubnetIds=[ 'string', ], AddSecurityGroupIds=[ 'string', ], RemoveSecurityGroupIds=[ 'string', ], IpAddressType='ipv4'|'dualstack'|'ipv6', DnsOptions={ 'DnsRecordIpType': 'ipv4'|'dualstack'|'ipv6'|'service-defined', 'PrivateDnsOnlyForInboundResolverEndpoint': True|False }, PrivateDnsEnabled=True|False, SubnetConfigurations=[ { 'SubnetId': 'string', 'Ipv4': 'string', 'Ipv6': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcEndpointId** (*string*) -- **[REQUIRED]** The ID of the endpoint. * **ResetPolicy** (*boolean*) -- (Gateway endpoint) Specify "true" to reset the policy document to the default policy. The default policy allows full access to the service. * **PolicyDocument** (*string*) -- (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. * **AddRouteTableIds** (*list*) -- (Gateway endpoint) The IDs of the route tables to associate with the endpoint. * *(string) --* * **RemoveRouteTableIds** (*list*) -- (Gateway endpoint) The IDs of the route tables to disassociate from the endpoint. * *(string) --* * **AddSubnetIds** (*list*) -- (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. * *(string) --* * **RemoveSubnetIds** (*list*) -- (Interface endpoint) The IDs of the subnets from which to remove the endpoint. * *(string) --* * **AddSecurityGroupIds** (*list*) -- (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. * *(string) --* * **RemoveSecurityGroupIds** (*list*) -- (Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces. * *(string) --* * **IpAddressType** (*string*) -- The IP address type for the endpoint. * **DnsOptions** (*dict*) -- The DNS options for the endpoint. * **DnsRecordIpType** *(string) --* The DNS records created for the endpoint. * **PrivateDnsOnlyForInboundResolverEndpoint** *(boolean) --* Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint. * **PrivateDnsEnabled** (*boolean*) -- (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC. * **SubnetConfigurations** (*list*) -- The subnet configurations for the endpoint. * *(dict) --* Describes the configuration of a subnet for a VPC endpoint. * **SubnetId** *(string) --* The ID of the subnet. * **Ipv4** *(string) --* The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4. If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint. * **Ipv6** *(string) --* The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6. If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / associate_instance_event_window associate_instance_event_window ******************************* EC2.Client.associate_instance_event_window(**kwargs) Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window. For more information, see Define event windows for scheduled events in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_instance_event_window( DryRun=True|False, InstanceEventWindowId='string', AssociationTarget={ 'InstanceIds': [ 'string', ], 'InstanceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceEventWindowId** (*string*) -- **[REQUIRED]** The ID of the event window. * **AssociationTarget** (*dict*) -- **[REQUIRED]** One or more targets associated with the specified event window. * **InstanceIds** *(list) --* The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated Host ID parameter. * *(string) --* * **InstanceTags** *(list) --* The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts to associate with the event window. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InstanceEventWindow': { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **InstanceEventWindow** *(dict) --* Information about the event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / modify_spot_fleet_request modify_spot_fleet_request ************************* EC2.Client.modify_spot_fleet_request(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_spot_fleet_request( LaunchTemplateConfigs=[ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'SpotPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, ] }, ], OnDemandTargetCapacity=123, Context='string', SpotFleetRequestId='string', TargetCapacity=123, ExcessCapacityTerminationPolicy='noTermination'|'default' ) Parameters: * **LaunchTemplateConfigs** (*list*) -- 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. * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template to use. Make sure that the launch template does not contain the "NetworkInterfaceId" parameter because you can't specify a network interface ID in a Spot Fleet. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If "OnDemandAllocationStrategy" is set to "prioritized", Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacityOptimizedPrioritized", Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides. * **InstanceRequirements** *(dict) --* The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On- Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in- 32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **OnDemandTargetCapacity** (*integer*) -- The number of On- Demand Instances in the fleet. * **Context** (*string*) -- Reserved. * **SpotFleetRequestId** (*string*) -- **[REQUIRED]** The ID of the Spot Fleet request. * **TargetCapacity** (*integer*) -- The size of the fleet. * **ExcessCapacityTerminationPolicy** (*string*) -- Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. Supported only for fleets of type "maintain". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* Contains the output of ModifySpotFleetRequest. * **Return** *(boolean) --* If the request succeeds, the response returns "true". If the request fails, no response is returned, and instead an error message is returned. **Examples** This example increases the target capacity of the specified Spot fleet request. response = client.modify_spot_fleet_request( SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE', TargetCapacity=20, ) print(response) Expected Output: { 'Return': True, 'ResponseMetadata': { '...': '...', }, } This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result. response = client.modify_spot_fleet_request( ExcessCapacityTerminationPolicy='NoTermination ', SpotFleetRequestId='sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE', TargetCapacity=10, ) print(response) Expected Output: { 'Return': True, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_regions describe_regions **************** EC2.Client.describe_regions(**kwargs) Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints. For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the *Amazon Web Services Account Management Reference Guide*. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_regions( RegionNames=[ 'string', ], AllRegions=True|False, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **RegionNames** (*list*) -- The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account. * *(string) --* * **AllRegions** (*boolean*) -- Indicates whether to display all Regions, including Regions that are disabled for your account. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Regions': [ { 'OptInStatus': 'string', 'RegionName': 'string', 'Endpoint': 'string' }, ] } **Response Structure** * *(dict) --* * **Regions** *(list) --* Information about the Regions. * *(dict) --* Describes a Region. * **OptInStatus** *(string) --* The Region opt-in status. The possible values are "opt- in-not-required", "opted-in", and "not-opted-in". * **RegionName** *(string) --* The name of the Region. * **Endpoint** *(string) --* The Region service endpoint. **Examples** This example describes all the regions that are available to you. response = client.describe_regions( ) print(response) Expected Output: { 'Regions': [ { 'Endpoint': 'ec2.ap-south-1.amazonaws.com', 'RegionName': 'ap-south-1', }, { 'Endpoint': 'ec2.eu-west-1.amazonaws.com', 'RegionName': 'eu-west-1', }, { 'Endpoint': 'ec2.ap-southeast-1.amazonaws.com', 'RegionName': 'ap-southeast-1', }, { 'Endpoint': 'ec2.ap-southeast-2.amazonaws.com', 'RegionName': 'ap-southeast-2', }, { 'Endpoint': 'ec2.eu-central-1.amazonaws.com', 'RegionName': 'eu-central-1', }, { 'Endpoint': 'ec2.ap-northeast-2.amazonaws.com', 'RegionName': 'ap-northeast-2', }, { 'Endpoint': 'ec2.ap-northeast-1.amazonaws.com', 'RegionName': 'ap-northeast-1', }, { 'Endpoint': 'ec2.us-east-1.amazonaws.com', 'RegionName': 'us-east-1', }, { 'Endpoint': 'ec2.sa-east-1.amazonaws.com', 'RegionName': 'sa-east-1', }, { 'Endpoint': 'ec2.us-west-1.amazonaws.com', 'RegionName': 'us-west-1', }, { 'Endpoint': 'ec2.us-west-2.amazonaws.com', 'RegionName': 'us-west-2', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / allocate_address allocate_address **************** EC2.Client.allocate_address(**kwargs) Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account. You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the *Amazon EC2 User Guide*. If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation. For more information, see Elastic IP Addresses in the *Amazon EC2 User Guide*. You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance). See also: AWS API Documentation **Request Syntax** response = client.allocate_address( Domain='vpc'|'standard', Address='string', PublicIpv4Pool='string', NetworkBorderGroup='string', CustomerOwnedIpv4Pool='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], IpamPoolId='string', DryRun=True|False ) Parameters: * **Domain** (*string*) -- The network ( "vpc"). * **Address** (*string*) -- The Elastic IP address to recover or an IPv4 address from an address pool. * **PublicIpv4Pool** (*string*) -- 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. * **NetworkBorderGroup** (*string*) -- A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. * **CustomerOwnedIpv4Pool** (*string*) -- 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. * **TagSpecifications** (*list*) -- The tags to assign to the Elastic IP address. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **IpamPoolId** (*string*) -- The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the *Amazon VPC IPAM User Guide*. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'AllocationId': 'string', 'PublicIpv4Pool': 'string', 'NetworkBorderGroup': 'string', 'Domain': 'vpc'|'standard', 'CustomerOwnedIp': 'string', 'CustomerOwnedIpv4Pool': 'string', 'CarrierIp': 'string', 'PublicIp': 'string' } **Response Structure** * *(dict) --* * **AllocationId** *(string) --* The ID that represents the allocation of the Elastic IP address. * **PublicIpv4Pool** *(string) --* The ID of an address pool. * **NetworkBorderGroup** *(string) --* The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. * **Domain** *(string) --* The network ( "vpc"). * **CustomerOwnedIp** *(string) --* The customer-owned IP address. * **CustomerOwnedIpv4Pool** *(string) --* The ID of the customer-owned address pool. * **CarrierIp** *(string) --* The carrier IP address. This option is only available for network interfaces that reside in a subnet in a Wavelength Zone. * **PublicIp** *(string) --* The Elastic IP address. **Examples** This example allocates an Elastic IP address to use with an instance in a VPC. response = client.allocate_address( Domain='vpc', ) print(response) Expected Output: { 'AllocationId': 'eipalloc-64d5890a', 'Domain': 'vpc', 'PublicIp': '203.0.113.0', 'ResponseMetadata': { '...': '...', }, } This example allocates an Elastic IP address to use with an instance in EC2-Classic. response = client.allocate_address( ) print(response) Expected Output: { 'Domain': 'standard', 'PublicIp': '198.51.100.0', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / replace_transit_gateway_route replace_transit_gateway_route ***************************** EC2.Client.replace_transit_gateway_route(**kwargs) Replaces the specified route in the specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.replace_transit_gateway_route( DestinationCidrBlock='string', TransitGatewayRouteTableId='string', TransitGatewayAttachmentId='string', Blackhole=True|False, DryRun=True|False ) Parameters: * **DestinationCidrBlock** (*string*) -- **[REQUIRED]** The CIDR range used for the destination match. Routing decisions are based on the most specific match. * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. * **TransitGatewayAttachmentId** (*string*) -- The ID of the attachment. * **Blackhole** (*boolean*) -- Indicates whether traffic matching this route is to be dropped. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Route': { 'DestinationCidrBlock': 'string', 'PrefixListId': 'string', 'TransitGatewayRouteTableAnnouncementId': 'string', 'TransitGatewayAttachments': [ { 'ResourceId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function' }, ], 'Type': 'static'|'propagated', 'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted' } } **Response Structure** * *(dict) --* * **Route** *(dict) --* Information about the modified route. * **DestinationCidrBlock** *(string) --* The CIDR block used for destination matches. * **PrefixListId** *(string) --* The ID of the prefix list used for destination matches. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. * **TransitGatewayAttachments** *(list) --* The attachments. * *(dict) --* Describes a route attachment. * **ResourceId** *(string) --* The ID of the resource. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **Type** *(string) --* The route type. * **State** *(string) --* The state of the route. EC2 / Client / get_ipam_resource_cidrs get_ipam_resource_cidrs *********************** EC2.Client.get_ipam_resource_cidrs(**kwargs) Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_resource_cidrs( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', IpamScopeId='string', IpamPoolId='string', ResourceId='string', ResourceType='vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', ResourceTag={ 'Key': 'string', 'Value': 'string' }, ResourceOwner='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return in the request. * **NextToken** (*string*) -- The token for the next page of results. * **IpamScopeId** (*string*) -- **[REQUIRED]** The ID of the scope that the resource is in. * **IpamPoolId** (*string*) -- The ID of the IPAM pool that the resource is in. * **ResourceId** (*string*) -- The ID of the resource. * **ResourceType** (*string*) -- The resource type. * **ResourceTag** (*dict*) -- The resource tag. * **Key** *(string) --* 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. * **Value** *(string) --* The value for the tag. * **ResourceOwner** (*string*) -- The ID of the Amazon Web Services account that owns the resource. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'IpamResourceCidrs': [ { 'IpamId': 'string', 'IpamScopeId': 'string', 'IpamPoolId': 'string', 'ResourceRegion': 'string', 'ResourceOwnerId': 'string', 'ResourceId': 'string', 'ResourceName': 'string', 'ResourceCidr': 'string', 'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', 'ResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpUsage': 123.0, 'ComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored', 'ManagementState': 'managed'|'unmanaged'|'ignored', 'OverlapStatus': 'overlapping'|'nonoverlapping'|'ignored', 'VpcId': 'string', 'AvailabilityZoneId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **IpamResourceCidrs** *(list) --* The resource CIDRs. * *(dict) --* The CIDR for an IPAM resource. * **IpamId** *(string) --* The IPAM ID for an IPAM resource. * **IpamScopeId** *(string) --* The scope ID for an IPAM resource. * **IpamPoolId** *(string) --* The pool ID for an IPAM resource. * **ResourceRegion** *(string) --* The Amazon Web Services Region for an IPAM resource. * **ResourceOwnerId** *(string) --* The Amazon Web Services account number of the owner of an IPAM resource. * **ResourceId** *(string) --* The ID of an IPAM resource. * **ResourceName** *(string) --* The name of an IPAM resource. * **ResourceCidr** *(string) --* The CIDR for an IPAM resource. * **ResourceType** *(string) --* The type of IPAM resource. * **ResourceTags** *(list) --* The tags for an IPAM resource. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **IpUsage** *(float) --* The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following: * For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. * For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. * For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). * **ComplianceStatus** *(string) --* The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **ManagementState** *(string) --* The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **OverlapStatus** *(string) --* The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **VpcId** *(string) --* The ID of a VPC. * **AvailabilityZoneId** *(string) --* The Availability Zone ID. EC2 / Client / reset_network_interface_attribute reset_network_interface_attribute ********************************* EC2.Client.reset_network_interface_attribute(**kwargs) Resets a network interface attribute. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = client.reset_network_interface_attribute( DryRun=True|False, NetworkInterfaceId='string', SourceDestCheck='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the network interface. * **SourceDestCheck** (*string*) -- The source/destination checking attribute. Resets the value to "true". Returns: None EC2 / Client / modify_ipam_resource_cidr modify_ipam_resource_cidr ************************* EC2.Client.modify_ipam_resource_cidr(**kwargs) Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in. For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_ipam_resource_cidr( DryRun=True|False, ResourceId='string', ResourceCidr='string', ResourceRegion='string', CurrentIpamScopeId='string', DestinationIpamScopeId='string', Monitored=True|False ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ResourceId** (*string*) -- **[REQUIRED]** The ID of the resource you want to modify. * **ResourceCidr** (*string*) -- **[REQUIRED]** The CIDR of the resource you want to modify. * **ResourceRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region of the resource you want to modify. * **CurrentIpamScopeId** (*string*) -- **[REQUIRED]** The ID of the current scope that the resource CIDR is in. * **DestinationIpamScopeId** (*string*) -- The ID of the scope you want to transfer the resource CIDR to. * **Monitored** (*boolean*) -- **[REQUIRED]** Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR. Return type: dict Returns: **Response Syntax** { 'IpamResourceCidr': { 'IpamId': 'string', 'IpamScopeId': 'string', 'IpamPoolId': 'string', 'ResourceRegion': 'string', 'ResourceOwnerId': 'string', 'ResourceId': 'string', 'ResourceName': 'string', 'ResourceCidr': 'string', 'ResourceType': 'vpc'|'subnet'|'eip'|'public-ipv4-pool'|'ipv6-pool'|'eni', 'ResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpUsage': 123.0, 'ComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored', 'ManagementState': 'managed'|'unmanaged'|'ignored', 'OverlapStatus': 'overlapping'|'nonoverlapping'|'ignored', 'VpcId': 'string', 'AvailabilityZoneId': 'string' } } **Response Structure** * *(dict) --* * **IpamResourceCidr** *(dict) --* The CIDR of the resource. * **IpamId** *(string) --* The IPAM ID for an IPAM resource. * **IpamScopeId** *(string) --* The scope ID for an IPAM resource. * **IpamPoolId** *(string) --* The pool ID for an IPAM resource. * **ResourceRegion** *(string) --* The Amazon Web Services Region for an IPAM resource. * **ResourceOwnerId** *(string) --* The Amazon Web Services account number of the owner of an IPAM resource. * **ResourceId** *(string) --* The ID of an IPAM resource. * **ResourceName** *(string) --* The name of an IPAM resource. * **ResourceCidr** *(string) --* The CIDR for an IPAM resource. * **ResourceType** *(string) --* The type of IPAM resource. * **ResourceTags** *(list) --* The tags for an IPAM resource. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **IpUsage** *(float) --* The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following: * For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. * For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. * For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). * **ComplianceStatus** *(string) --* The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **ManagementState** *(string) --* The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **OverlapStatus** *(string) --* The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **VpcId** *(string) --* The ID of a VPC. * **AvailabilityZoneId** *(string) --* The Availability Zone ID. EC2 / Client / describe_capacity_reservation_billing_requests describe_capacity_reservation_billing_requests ********************************************** EC2.Client.describe_capacity_reservation_billing_requests(**kwargs) Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations. See also: AWS API Documentation **Request Syntax** response = client.describe_capacity_reservation_billing_requests( CapacityReservationIds=[ 'string', ], Role='odcr-owner'|'unused-reservation-billing-owner', NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CapacityReservationIds** (*list*) -- The ID of the Capacity Reservation. * *(string) --* * **Role** (*string*) -- **[REQUIRED]** Specify one of the following: * "odcr-owner" - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the "requested-by" filter. * "unused-reservation-billing-owner" - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the "unused-reservation- billing-owner" filter. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **Filters** (*list*) -- One or more filters. * "status" - The state of the request ( "pending" | "accepted" | "rejected" | "cancelled" | "revoked" | "expired"). * "requested-by" - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify "requested-by" for **Role**. * "unused-reservation-billing-owner" - The ID of the consumer account to which the request was sent. Not supported if you specify "unused-reservation-billing-owner" for **Role**. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'CapacityReservationBillingRequests': [ { 'CapacityReservationId': 'string', 'RequestedBy': 'string', 'UnusedReservationBillingOwnerId': 'string', 'LastUpdateTime': datetime(2015, 1, 1), 'Status': 'pending'|'accepted'|'rejected'|'cancelled'|'revoked'|'expired', 'StatusMessage': 'string', 'CapacityReservationInfo': { 'InstanceType': 'string', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'AvailabilityZoneId': 'string' } }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **CapacityReservationBillingRequests** *(list) --* Information about the request. * *(dict) --* Information about a request to assign billing of the unused capacity of a Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **RequestedBy** *(string) --* The ID of the Amazon Web Services account that initiated the request. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which the request was sent. * **LastUpdateTime** *(datetime) --* The date and time, in UTC time format, at which the request was initiated. * **Status** *(string) --* The status of the request. For more information, see View billing assignment requests for a shared Amazon EC2 Capacity Reservation. * **StatusMessage** *(string) --* Information about the status. * **CapacityReservationInfo** *(dict) --* Information about the Capacity Reservation. * **InstanceType** *(string) --* The instance type for the Capacity Reservation. * **AvailabilityZone** *(string) --* The Availability Zone for the Capacity Reservation. * **Tenancy** *(string) --* The tenancy of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. EC2 / Client / release_hosts release_hosts ************* EC2.Client.release_hosts(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.release_hosts( HostIds=[ 'string', ] ) Parameters: **HostIds** (*list*) -- **[REQUIRED]** The IDs of the Dedicated Hosts to release. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Successful': [ 'string', ], 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **Successful** *(list) --* The IDs of the Dedicated Hosts that were successfully released. * *(string) --* * **Unsuccessful** *(list) --* The IDs of the Dedicated Hosts that could not be released, including an error message. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / create_ipam_pool create_ipam_pool **************** EC2.Client.create_ipam_pool(**kwargs) Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each. For more information, see Create a top-level pool in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_ipam_pool( DryRun=True|False, IpamScopeId='string', Locale='string', SourceIpamPoolId='string', Description='string', AddressFamily='ipv4'|'ipv6', AutoImport=True|False, PubliclyAdvertisable=True|False, AllocationMinNetmaskLength=123, AllocationMaxNetmaskLength=123, AllocationDefaultNetmaskLength=123, AllocationResourceTags=[ { 'Key': 'string', 'Value': 'string' }, ], TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', AwsService='ec2', PublicIpSource='amazon'|'byoip', SourceResource={ 'ResourceId': 'string', 'ResourceType': 'vpc', 'ResourceRegion': 'string', 'ResourceOwner': 'string' } ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamScopeId** (*string*) -- **[REQUIRED]** The ID of the scope in which you would like to create the IPAM pool. * **Locale** (*string*) -- The locale for the pool should be one of the following: * An Amazon Web Services Region where you want this IPAM pool to be available for allocations. * The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is "none" and means any locale. * **SourceIpamPoolId** (*string*) -- The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range. * **Description** (*string*) -- A description for the IPAM pool. * **AddressFamily** (*string*) -- **[REQUIRED]** The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. * **AutoImport** (*boolean*) -- If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work. * **PubliclyAdvertisable** (*boolean*) -- Determines if the pool is publicly advertisable. The request can only contain "PubliclyAdvertisable" if "AddressFamily" is "ipv6" and "PublicIpSource" is "byoip". * **AllocationMinNetmaskLength** (*integer*) -- The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationMaxNetmaskLength** (*integer*) -- The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationDefaultNetmaskLength** (*integer*) -- The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. * **AllocationResourceTags** (*list*) -- Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. * *(dict) --* A tag on an IPAM resource. * **Key** *(string) --* 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. * **Value** *(string) --* The value for the tag. * **TagSpecifications** (*list*) -- 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **AwsService** (*string*) -- Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. * **PublicIpSource** (*string*) -- The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is "byoip". For more information, see Create IPv6 pools in the *Amazon VPC IPAM User Guide*. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is "amazon". For information on increasing the default limit, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. * **SourceResource** (*dict*) -- The resource used to provision CIDRs to a resource planning pool. * **ResourceId** *(string) --* The source resource ID. * **ResourceType** *(string) --* The source resource type. * **ResourceRegion** *(string) --* The source resource Region. * **ResourceOwner** *(string) --* The source resource owner. Return type: dict Returns: **Response Syntax** { 'IpamPool': { 'OwnerId': 'string', 'IpamPoolId': 'string', 'SourceIpamPoolId': 'string', 'IpamPoolArn': 'string', 'IpamScopeArn': 'string', 'IpamScopeType': 'public'|'private', 'IpamArn': 'string', 'IpamRegion': 'string', 'Locale': 'string', 'PoolDepth': 123, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'StateMessage': 'string', 'Description': 'string', 'AutoImport': True|False, 'PubliclyAdvertisable': True|False, 'AddressFamily': 'ipv4'|'ipv6', 'AllocationMinNetmaskLength': 123, 'AllocationMaxNetmaskLength': 123, 'AllocationDefaultNetmaskLength': 123, 'AllocationResourceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'AwsService': 'ec2', 'PublicIpSource': 'amazon'|'byoip', 'SourceResource': { 'ResourceId': 'string', 'ResourceType': 'vpc', 'ResourceRegion': 'string', 'ResourceOwner': 'string' } } } **Response Structure** * *(dict) --* * **IpamPool** *(dict) --* Information about the IPAM pool created. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM pool. * **IpamPoolId** *(string) --* The ID of the IPAM pool. * **SourceIpamPoolId** *(string) --* The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool. * **IpamPoolArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM pool. * **IpamScopeArn** *(string) --* The ARN of the scope of the IPAM pool. * **IpamScopeType** *(string) --* In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. * **IpamArn** *(string) --* The ARN of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM pool. * **Locale** *(string) --* The locale of the IPAM pool. The locale for the pool should be one of the following: * An Amazon Web Services Region where you want this IPAM pool to be available for allocations. * The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations ( supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error. * **PoolDepth** *(integer) --* The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **State** *(string) --* The state of the IPAM pool. * **StateMessage** *(string) --* The state message. * **Description** *(string) --* The description of the IPAM pool. * **AutoImport** *(boolean) --* If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work. * **PubliclyAdvertisable** *(boolean) --* Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to "ipv4". * **AddressFamily** *(string) --* The address family of the pool. * **AllocationMinNetmaskLength** *(integer) --* The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationMaxNetmaskLength** *(integer) --* The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **AllocationDefaultNetmaskLength** *(integer) --* The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. * **AllocationResourceTags** *(list) --* Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. * *(dict) --* 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. * **Key** *(string) --* 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. * **Value** *(string) --* The value of the tag. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **AwsService** *(string) --* Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. * **PublicIpSource** *(string) --* The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is "BYOIP". For more information, see Create IPv6 pools in the *Amazon VPC IPAM User Guide*. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. * **SourceResource** *(dict) --* The resource used to provision CIDRs to a resource planning pool. * **ResourceId** *(string) --* The source resource ID. * **ResourceType** *(string) --* The source resource type. * **ResourceRegion** *(string) --* The source resource Region. * **ResourceOwner** *(string) --* The source resource owner. EC2 / Client / cancel_export_task cancel_export_task ****************** EC2.Client.cancel_export_task(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.cancel_export_task( ExportTaskId='string' ) Parameters: **ExportTaskId** (*string*) -- **[REQUIRED]** The ID of the export task. This is the ID returned by the "CreateInstanceExportTask" and "ExportImage" operations. Returns: None EC2 / Client / create_ipam create_ipam *********** EC2.Client.create_ipam(**kwargs) Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see Create an IPAM in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_ipam( DryRun=True|False, Description='string', OperatingRegions=[ { 'RegionName': 'string' }, ], TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string', Tier='free'|'advanced', EnablePrivateGua=True|False, MeteredAccount='ipam-owner'|'resource-owner' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Description** (*string*) -- A description for the IPAM. * **OperatingRegions** (*list*) -- The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **TagSpecifications** (*list*) -- 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **Tier** (*string*) -- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** (*boolean*) -- Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** (*string*) -- A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. Return type: dict Returns: **Response Syntax** { 'Ipam': { 'OwnerId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'PublicDefaultScopeId': 'string', 'PrivateDefaultScopeId': 'string', 'ScopeCount': 123, 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DefaultResourceDiscoveryId': 'string', 'DefaultResourceDiscoveryAssociationId': 'string', 'ResourceDiscoveryAssociationCount': 123, 'StateMessage': 'string', 'Tier': 'free'|'advanced', 'EnablePrivateGua': True|False, 'MeteredAccount': 'ipam-owner'|'resource-owner' } } **Response Structure** * *(dict) --* * **Ipam** *(dict) --* Information about the IPAM created. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM. * **IpamId** *(string) --* The ID of the IPAM. * **IpamArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM. * **PublicDefaultScopeId** *(string) --* The ID of the IPAM's default public scope. * **PrivateDefaultScopeId** *(string) --* The ID of the IPAM's default private scope. * **ScopeCount** *(integer) --* The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **Description** *(string) --* The description for the IPAM. * **OperatingRegions** *(list) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **State** *(string) --* The state of the IPAM. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DefaultResourceDiscoveryId** *(string) --* The IPAM's default resource discovery ID. * **DefaultResourceDiscoveryAssociationId** *(string) --* The IPAM's default resource discovery association ID. * **ResourceDiscoveryAssociationCount** *(integer) --* The IPAM's resource discovery association count. * **StateMessage** *(string) --* The state message. * **Tier** *(string) --* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** *(boolean) --* Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** *(string) --* A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. EC2 / Client / describe_capacity_block_status describe_capacity_block_status ****************************** EC2.Client.describe_capacity_block_status(**kwargs) Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks. See also: AWS API Documentation **Request Syntax** response = client.describe_capacity_block_status( CapacityBlockIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CapacityBlockIds** (*list*) -- The ID of the Capacity Block. * *(string) --* * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **Filters** (*list*) -- One or more filters. * "interconnect-status" - The status of the interconnect for the Capacity Block ( "ok" | "impaired" | "insufficient- data"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CapacityBlockStatuses': [ { 'CapacityBlockId': 'string', 'InterconnectStatus': 'ok'|'impaired'|'insufficient-data', 'TotalCapacity': 123, 'TotalAvailableCapacity': 123, 'TotalUnavailableCapacity': 123, 'CapacityReservationStatuses': [ { 'CapacityReservationId': 'string', 'TotalCapacity': 123, 'TotalAvailableCapacity': 123, 'TotalUnavailableCapacity': 123 }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CapacityBlockStatuses** *(list) --* The availability of capacity for a Capacity Block. * *(dict) --* Describes the availability of capacity for a Capacity Block. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **InterconnectStatus** *(string) --* The status of the high-bandwidth accelerator interconnect. Possible states include: * "ok" the accelerator interconnect is healthy. * "impaired" - accelerator interconnect communication is impaired. * "insufficient-data" - insufficient data to determine accelerator interconnect status. * **TotalCapacity** *(integer) --* The combined amount of "Available" and "Unavailable" capacity in the Capacity Block. * **TotalAvailableCapacity** *(integer) --* The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block. * **TotalUnavailableCapacity** *(integer) --* The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure. * **CapacityReservationStatuses** *(list) --* The availability of capacity for the Capacity Block reservations. * *(dict) --* Describes the availability of capacity for a Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **TotalCapacity** *(integer) --* The combined amount of "Available" and "Unavailable" capacity in the Capacity Reservation. * **TotalAvailableCapacity** *(integer) --* The remaining capacity. Indicates the amount of resources that can be launched into the Capacity Reservation. * **TotalUnavailableCapacity** *(integer) --* The used capacity. Indicates that the capacity is in use by resources that are running in the Capacity Reservation. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / create_local_gateway_virtual_interface create_local_gateway_virtual_interface ************************************** EC2.Client.create_local_gateway_virtual_interface(**kwargs) Create a virtual interface for a local gateway. See also: AWS API Documentation **Request Syntax** response = client.create_local_gateway_virtual_interface( LocalGatewayVirtualInterfaceGroupId='string', OutpostLagId='string', Vlan=123, LocalAddress='string', PeerAddress='string', PeerBgpAsn=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, PeerBgpAsnExtended=123 ) Parameters: * **LocalGatewayVirtualInterfaceGroupId** (*string*) -- **[REQUIRED]** The ID of the local gateway virtual interface group. * **OutpostLagId** (*string*) -- **[REQUIRED]** References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices. * **Vlan** (*integer*) -- **[REQUIRED]** The virtual local area network (VLAN) used for the local gateway virtual interface. * **LocalAddress** (*string*) -- **[REQUIRED]** The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported. * **PeerAddress** (*string*) -- **[REQUIRED]** The peer IP address for the local gateway virtual interface. Only IPv4 is supported. * **PeerBgpAsn** (*integer*) -- The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer. * **TagSpecifications** (*list*) -- The tags to apply to a resource when the local gateway virtual interface is being created. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PeerBgpAsnExtended** (*integer*) -- The extended 32-bit ASN of the BGP peer for use with larger ASN values. Return type: dict Returns: **Response Syntax** { 'LocalGatewayVirtualInterface': { 'LocalGatewayVirtualInterfaceId': 'string', 'LocalGatewayId': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayVirtualInterfaceArn': 'string', 'OutpostLagId': 'string', 'Vlan': 123, 'LocalAddress': 'string', 'PeerAddress': 'string', 'LocalBgpAsn': 123, 'PeerBgpAsn': 123, 'PeerBgpAsnExtended': 123, 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConfigurationState': 'pending'|'available'|'deleting'|'deleted' } } **Response Structure** * *(dict) --* * **LocalGatewayVirtualInterface** *(dict) --* Information about the local gateway virtual interface. * **LocalGatewayVirtualInterfaceId** *(string) --* The ID of the virtual interface. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the local gateway virtual interface group. * **LocalGatewayVirtualInterfaceArn** *(string) --* The Amazon Resource Number (ARN) of the local gateway virtual interface. * **OutpostLagId** *(string) --* The Outpost LAG ID. * **Vlan** *(integer) --* The ID of the VLAN. * **LocalAddress** *(string) --* The local address. * **PeerAddress** *(string) --* The peer address. * **LocalBgpAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. * **PeerBgpAsn** *(integer) --* The peer BGP ASN. * **PeerBgpAsnExtended** *(integer) --* The extended 32-bit ASN of the BGP peer for use with larger ASN values. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface. * **Tags** *(list) --* The tags assigned to the virtual interface. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConfigurationState** *(string) --* The current state of the local gateway virtual interface. EC2 / Client / modify_verified_access_endpoint_policy modify_verified_access_endpoint_policy ************************************** EC2.Client.modify_verified_access_endpoint_policy(**kwargs) Modifies the specified Amazon Web Services Verified Access endpoint policy. See also: AWS API Documentation **Request Syntax** response = client.modify_verified_access_endpoint_policy( VerifiedAccessEndpointId='string', PolicyEnabled=True|False, PolicyDocument='string', ClientToken='string', DryRun=True|False, SseSpecification={ 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' } ) Parameters: * **VerifiedAccessEndpointId** (*string*) -- **[REQUIRED]** The ID of the Verified Access endpoint. * **PolicyEnabled** (*boolean*) -- The status of the Verified Access policy. * **PolicyDocument** (*string*) -- The Verified Access policy document. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SseSpecification** (*dict*) -- The options for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Enable or disable the use of customer managed KMS keys for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. Return type: dict Returns: **Response Syntax** { 'PolicyEnabled': True|False, 'PolicyDocument': 'string', 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' } } **Response Structure** * *(dict) --* * **PolicyEnabled** *(boolean) --* The status of the Verified Access policy. * **PolicyDocument** *(string) --* The Verified Access policy document. * **SseSpecification** *(dict) --* The options in use for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. EC2 / Client / disassociate_address disassociate_address ******************** EC2.Client.disassociate_address(**kwargs) Disassociates an Elastic IP address from the instance or network interface it's associated with. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. An address cannot be disassociated if the all of the following conditions are met: * Network interface has a "publicDualStackDnsName" publicDnsName * Public IPv4 address is the primary public IPv4 address * Network interface only has one remaining public IPv4 address See also: AWS API Documentation **Request Syntax** response = client.disassociate_address( AssociationId='string', PublicIp='string', DryRun=True|False ) Parameters: * **AssociationId** (*string*) -- The association ID. This parameter is required. * **PublicIp** (*string*) -- Deprecated. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None **Examples** This example disassociates an Elastic IP address from an instance in a VPC. response = client.disassociate_address( AssociationId='eipassoc-2bebb745', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example disassociates an Elastic IP address from an instance in EC2-Classic. response = client.disassociate_address( PublicIp='198.51.100.0', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / start_declarative_policies_report start_declarative_policies_report ********************************* EC2.Client.start_declarative_policies_report(**kwargs) Generates an account status report. The report is generated asynchronously, and can take several hours to complete. The report provides the current status of all attributes supported by declarative policies for the accounts within the specified scope. The scope is determined by the specified "TargetId", which can represent an individual account, or all the accounts that fall under the specified organizational unit (OU) or root (the entire Amazon Web Services Organization). The report is saved to your specified S3 bucket, using the following path structure (with the capitalized placeholders representing your specific values): "s3://AMZN-S3-DEMO-BUCKET/YOUR- OPTIONAL-S3-PREFIX/ec2_TARGETID_REPORTID_YYYYMMDDTHHMMZ.csv" **Prerequisites for generating a report** * The "StartDeclarativePoliciesReport" API can only be called by the management account or delegated administrators for the organization. * An S3 bucket must be available before generating the report (you can create a new one or use an existing one), it must be in the same Region where the report generation request is made, and it must have an appropriate bucket policy. For a sample S3 policy, see *Sample Amazon S3 policy* under Examples. * Trusted access must be enabled for the service for which the declarative policy will enforce a baseline configuration. If you use the Amazon Web Services Organizations console, this is done automatically when you enable declarative policies. The API uses the following service principal to identify the EC2 service: "ec2.amazonaws.com". For more information on how to enable trusted access with the Amazon Web Services CLI and Amazon Web Services SDKs, see Using Organizations with other Amazon Web Services services in the *Amazon Web Services Organizations User Guide*. * Only one report per organization can be generated at a time. Attempting to generate a report while another is in progress will result in an error. For more information, including the required IAM permissions to run this API, see Generating the account status report for declarative policies in the *Amazon Web Services Organizations User Guide*. See also: AWS API Documentation **Request Syntax** response = client.start_declarative_policies_report( DryRun=True|False, S3Bucket='string', S3Prefix='string', TargetId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **S3Bucket** (*string*) -- **[REQUIRED]** The name of the S3 bucket where the report will be saved. The bucket must be in the same Region where the report generation request is made. * **S3Prefix** (*string*) -- The prefix for your S3 object. * **TargetId** (*string*) -- **[REQUIRED]** The root ID, organizational unit ID, or account ID. Format: * For root: "r-ab12" * For OU: "ou-ab12-cdef1234" * For account: "123456789012" * **TagSpecifications** (*list*) -- The tags to apply. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'ReportId': 'string' } **Response Structure** * *(dict) --* * **ReportId** *(string) --* The ID of the report. EC2 / Client / modify_public_ip_dns_name_options modify_public_ip_dns_name_options ********************************* EC2.Client.modify_public_ip_dns_name_options(**kwargs) Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_public_ip_dns_name_options( NetworkInterfaceId='string', HostnameType='public-dual-stack-dns-name'|'public-ipv4-dns-name'|'public-ipv6-dns-name', DryRun=True|False ) Parameters: * **NetworkInterfaceId** (*string*) -- **[REQUIRED]** A network interface ID. * **HostnameType** (*string*) -- **[REQUIRED]** The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * "public-dual-stack-dns-name": A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface. * "public-ipv4-dns-name": An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface. * "public-ipv6-dns-name": An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Successful': True|False } **Response Structure** * *(dict) --* * **Successful** *(boolean) --* Whether or not the request was successful. EC2 / Client / get_ipam_address_history get_ipam_address_history ************************ EC2.Client.get_ipam_address_history(**kwargs) Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_address_history( DryRun=True|False, Cidr='string', IpamScopeId='string', VpcId='string', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Cidr** (*string*) -- **[REQUIRED]** The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR. * **IpamScopeId** (*string*) -- **[REQUIRED]** The ID of the IPAM scope that the CIDR is in. * **VpcId** (*string*) -- The ID of the VPC you want your history records filtered by. * **StartTime** (*datetime*) -- The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime. * **EndTime** (*datetime*) -- The end of the time period for which you are looking for history. If you omit this option, it will default to the current time. * **MaxResults** (*integer*) -- The maximum number of historical results you would like returned per page. Defaults to 100. * **NextToken** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'HistoryRecords': [ { 'ResourceOwnerId': 'string', 'ResourceRegion': 'string', 'ResourceType': 'eip'|'vpc'|'subnet'|'network-interface'|'instance', 'ResourceId': 'string', 'ResourceCidr': 'string', 'ResourceName': 'string', 'ResourceComplianceStatus': 'compliant'|'noncompliant'|'unmanaged'|'ignored', 'ResourceOverlapStatus': 'overlapping'|'nonoverlapping'|'ignored', 'VpcId': 'string', 'SampledStartTime': datetime(2015, 1, 1), 'SampledEndTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **HistoryRecords** *(list) --* A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface. * *(dict) --* The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the *Amazon VPC IPAM User Guide*. * **ResourceOwnerId** *(string) --* The ID of the resource owner. * **ResourceRegion** *(string) --* The Amazon Web Services Region of the resource. * **ResourceType** *(string) --* The type of the resource. * **ResourceId** *(string) --* The ID of the resource. * **ResourceCidr** *(string) --* The CIDR of the resource. * **ResourceName** *(string) --* The name of the resource. * **ResourceComplianceStatus** *(string) --* The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **ResourceOverlapStatus** *(string) --* The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the *Amazon VPC IPAM User Guide*. * **VpcId** *(string) --* The VPC ID of the resource. * **SampledStartTime** *(datetime) --* Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time. * **SampledEndTime** *(datetime) --* Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_id_format describe_id_format ****************** EC2.Client.describe_id_format(**kwargs) Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. The following resource types support longer IDs: "bundle" | "conversion-task" | "customer-gateway" | "dhcp-options" | "elastic- ip-allocation" | "elastic-ip-association" | "export-task" | "flow- log" | "image" | "import-task" | "instance" | "internet-gateway" | "network-acl" | "network-acl-association" | "network-interface" | "network-interface-attachment" | "prefix-list" | "reservation" | "route-table" | "route-table-association" | "security-group" | "snapshot" | "subnet" | "subnet-cidr-block-association" | "volume" | "vpc" | "vpc-cidr-block-association" | "vpc-endpoint" | "vpc- peering-connection" | "vpn-connection" | "vpn-gateway". These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant "Describe" command for the resource type. See also: AWS API Documentation **Request Syntax** response = client.describe_id_format( Resource='string' ) Parameters: **Resource** (*string*) -- 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" Return type: dict Returns: **Response Syntax** { 'Statuses': [ { 'Deadline': datetime(2015, 1, 1), 'Resource': 'string', 'UseLongIds': True|False }, ] } **Response Structure** * *(dict) --* * **Statuses** *(list) --* Information about the ID format for the resource. * *(dict) --* Describes the ID format for a resource. * **Deadline** *(datetime) --* The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. * **Resource** *(string) --* The type of resource. * **UseLongIds** *(boolean) --* Indicates whether longer IDs (17-character IDs) are enabled for the resource. EC2 / Client / describe_capacity_blocks describe_capacity_blocks ************************ EC2.Client.describe_capacity_blocks(**kwargs) Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using. See also: AWS API Documentation **Request Syntax** response = client.describe_capacity_blocks( CapacityBlockIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CapacityBlockIds** (*list*) -- The IDs of the Capacity Blocks. * *(string) --* * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **Filters** (*list*) -- One or more filters. * "capacity-block-id" - The ID of the Capacity Block. * "ultraserver-type" - The Capacity Block type. The type can be "instances" or "ultraservers". * "availability-zone" - The Availability Zone of the Capacity Block. * "start-date" - The date and time at which the Capacity Block was started. * "end-date" - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated. * "create-date" - The date and time at which the Capacity Block was created. * "state" - The state of the Capacity Block ( "active" | "expired" | "unavailable" | "cancelled" | "failed" | "scheduled" | "payment-pending" | "payment-failed"). * "tags" - The tags assigned to the Capacity Block. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CapacityBlocks': [ { 'CapacityBlockId': 'string', 'UltraserverType': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'CapacityReservationIds': [ 'string', ], 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'CreateDate': datetime(2015, 1, 1), 'State': 'active'|'expired'|'unavailable'|'cancelled'|'failed'|'scheduled'|'payment-pending'|'payment-failed', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CapacityBlocks** *(list) --* The Capacity Blocks. * *(dict) --* Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside Amazon EC2 UltraClusters, for low-latency, petabit-scale, non- blocking networking. You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high- bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **UltraserverType** *(string) --* The EC2 UltraServer type of the Capacity Block. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Block. * **CapacityReservationIds** *(list) --* The ID of the Capacity Reservation. * *(string) --* * **StartDate** *(datetime) --* The date and time at which the Capacity Block was started. * **EndDate** *(datetime) --* The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated. * **CreateDate** *(datetime) --* The date and time at which the Capacity Block was created. * **State** *(string) --* The state of the Capacity Block. * **Tags** *(list) --* The tags assigned to the Capacity Block. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / disassociate_ipam_byoasn disassociate_ipam_byoasn ************************ EC2.Client.disassociate_ipam_byoasn(**kwargs) Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the *Amazon VPC IPAM guide*. See also: AWS API Documentation **Request Syntax** response = client.disassociate_ipam_byoasn( DryRun=True|False, Asn='string', Cidr='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Asn** (*string*) -- **[REQUIRED]** A public 2-byte or 4-byte ASN. * **Cidr** (*string*) -- **[REQUIRED]** A BYOIP CIDR. Return type: dict Returns: **Response Syntax** { 'AsnAssociation': { 'Asn': 'string', 'Cidr': 'string', 'StatusMessage': 'string', 'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated' } } **Response Structure** * *(dict) --* * **AsnAssociation** *(dict) --* An ASN and BYOIP CIDR association. * **Asn** *(string) --* The association's ASN. * **Cidr** *(string) --* The association's CIDR. * **StatusMessage** *(string) --* The association's status message. * **State** *(string) --* The association's state. EC2 / Client / describe_ipams describe_ipams ************** EC2.Client.describe_ipams(**kwargs) Get information about your IPAM pools. For more information, see What is IPAM? in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_ipams( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', IpamIds=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- One or more filters for the request. For more information about filtering, see Filtering CLI output. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return in the request. * **NextToken** (*string*) -- The token for the next page of results. * **IpamIds** (*list*) -- The IDs of the IPAMs you want information on. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Ipams': [ { 'OwnerId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'PublicDefaultScopeId': 'string', 'PrivateDefaultScopeId': 'string', 'ScopeCount': 123, 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DefaultResourceDiscoveryId': 'string', 'DefaultResourceDiscoveryAssociationId': 'string', 'ResourceDiscoveryAssociationCount': 123, 'StateMessage': 'string', 'Tier': 'free'|'advanced', 'EnablePrivateGua': True|False, 'MeteredAccount': 'ipam-owner'|'resource-owner' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **Ipams** *(list) --* Information about the IPAMs. * *(dict) --* IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM. * **IpamId** *(string) --* The ID of the IPAM. * **IpamArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM. * **PublicDefaultScopeId** *(string) --* The ID of the IPAM's default public scope. * **PrivateDefaultScopeId** *(string) --* The ID of the IPAM's default private scope. * **ScopeCount** *(integer) --* The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **Description** *(string) --* The description for the IPAM. * **OperatingRegions** *(list) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **State** *(string) --* The state of the IPAM. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DefaultResourceDiscoveryId** *(string) --* The IPAM's default resource discovery ID. * **DefaultResourceDiscoveryAssociationId** *(string) --* The IPAM's default resource discovery association ID. * **ResourceDiscoveryAssociationCount** *(integer) --* The IPAM's resource discovery association count. * **StateMessage** *(string) --* The state message. * **Tier** *(string) --* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** *(boolean) --* Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** *(string) --* A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. EC2 / Client / describe_aggregate_id_format describe_aggregate_id_format **************************** EC2.Client.describe_aggregate_id_format(**kwargs) 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". See also: AWS API Documentation **Request Syntax** response = client.describe_aggregate_id_format( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'UseLongIdsAggregated': True|False, 'Statuses': [ { 'Deadline': datetime(2015, 1, 1), 'Resource': 'string', 'UseLongIds': True|False }, ] } **Response Structure** * *(dict) --* * **UseLongIdsAggregated** *(boolean) --* Indicates whether all resource types in the Region are configured to use longer IDs. This value is only "true" if all users are configured to use longer IDs for all resources types in the Region. * **Statuses** *(list) --* Information about each resource's ID format. * *(dict) --* Describes the ID format for a resource. * **Deadline** *(datetime) --* The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned. * **Resource** *(string) --* The type of resource. * **UseLongIds** *(boolean) --* Indicates whether longer IDs (17-character IDs) are enabled for the resource. EC2 / Client / describe_transit_gateways describe_transit_gateways ************************* EC2.Client.describe_transit_gateways(**kwargs) Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. See also: AWS API Documentation **Request Syntax** response = client.describe_transit_gateways( TransitGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayIds** (*list*) -- The IDs of the transit gateways. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services 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. * "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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGateways': [ { 'TransitGatewayId': 'string', 'TransitGatewayArn': 'string', 'State': 'pending'|'available'|'modifying'|'deleting'|'deleted', 'OwnerId': 'string', 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'Options': { 'AmazonSideAsn': 123, 'TransitGatewayCidrBlocks': [ 'string', ], 'AutoAcceptSharedAttachments': 'enable'|'disable', 'DefaultRouteTableAssociation': 'enable'|'disable', 'AssociationDefaultRouteTableId': 'string', 'DefaultRouteTablePropagation': 'enable'|'disable', 'PropagationDefaultRouteTableId': 'string', 'VpnEcmpSupport': 'enable'|'disable', 'DnsSupport': 'enable'|'disable', 'SecurityGroupReferencingSupport': 'enable'|'disable', 'MulticastSupport': 'enable'|'disable' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGateways** *(list) --* Information about the transit gateways. * *(dict) --* Describes a transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **TransitGatewayArn** *(string) --* The Amazon Resource Name (ARN) of the transit gateway. * **State** *(string) --* The state of the transit gateway. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Description** *(string) --* The description of the transit gateway. * **CreationTime** *(datetime) --* The creation time. * **Options** *(dict) --* The transit gateway options. * **AmazonSideAsn** *(integer) --* A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. * **TransitGatewayCidrBlocks** *(list) --* The transit gateway CIDR blocks. * *(string) --* * **AutoAcceptSharedAttachments** *(string) --* Indicates whether attachment requests are automatically accepted. * **DefaultRouteTableAssociation** *(string) --* Indicates whether resource attachments are automatically associated with the default association route table. Enabled by default. If "defaultRouteTableAssociation" is set to "enable", Amazon Web Services Transit Gateway will create the default transit gateway route table. * **AssociationDefaultRouteTableId** *(string) --* The ID of the default association route table. * **DefaultRouteTablePropagation** *(string) --* Indicates whether resource attachments automatically propagate routes to the default propagation route table. Enabled by default. If "defaultRouteTablePropagation" is set to "enable", Amazon Web Services Transit Gateway will create the default transit gateway route table. * **PropagationDefaultRouteTableId** *(string) --* The ID of the default propagation route table. * **VpnEcmpSupport** *(string) --* Indicates whether Equal Cost Multipath Protocol support is enabled. * **DnsSupport** *(string) --* Indicates whether DNS support is enabled. * **SecurityGroupReferencingSupport** *(string) --* Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is disabled by default. * **MulticastSupport** *(string) --* Indicates whether multicast is enabled on the transit gateway * **Tags** *(list) --* The tags for the transit gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / import_client_vpn_client_certificate_revocation_list import_client_vpn_client_certificate_revocation_list **************************************************** EC2.Client.import_client_vpn_client_certificate_revocation_list(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.import_client_vpn_client_certificate_revocation_list( ClientVpnEndpointId='string', CertificateRevocationList='string', DryRun=True|False ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint to which the client certificate revocation list applies. * **CertificateRevocationList** (*string*) -- **[REQUIRED]** The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the *Client VPN Administrator Guide*. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / unassign_private_ip_addresses unassign_private_ip_addresses ***************************** EC2.Client.unassign_private_ip_addresses(**kwargs) Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface. See also: AWS API Documentation **Request Syntax** response = client.unassign_private_ip_addresses( Ipv4Prefixes=[ 'string', ], NetworkInterfaceId='string', PrivateIpAddresses=[ 'string', ] ) Parameters: * **Ipv4Prefixes** (*list*) -- The IPv4 prefixes to unassign from the network interface. * *(string) --* * **NetworkInterfaceId** (*string*) -- **[REQUIRED]** The ID of the network interface. * **PrivateIpAddresses** (*list*) -- 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. * *(string) --* Returns: None **Examples** This example unassigns the specified private IP address from the specified network interface. response = client.unassign_private_ip_addresses( NetworkInterfaceId='eni-e5aa89a3', PrivateIpAddresses=[ '10.0.0.82', ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_customer_gateways describe_customer_gateways ************************** EC2.Client.describe_customer_gateways(**kwargs) Describes one or more of your VPN customer gateways. For more information, see Amazon Web Services Site-to-Site VPN in the *Amazon Web Services Site-to-Site VPN User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_customer_gateways( CustomerGatewayIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CustomerGatewayIds** (*list*) -- One or more customer gateway IDs. Default: Describes all your customer gateways. * *(string) --* * **Filters** (*list*) -- 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 device's 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CustomerGateways': [ { 'CertificateArn': 'string', 'DeviceName': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'BgpAsnExtended': 'string', 'CustomerGatewayId': 'string', 'State': 'string', 'Type': 'string', 'IpAddress': 'string', 'BgpAsn': 'string' }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeCustomerGateways. * **CustomerGateways** *(list) --* Information about one or more customer gateways. * *(dict) --* Describes a customer gateway. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) for the customer gateway certificate. * **DeviceName** *(string) --* The name of customer gateway device. * **Tags** *(list) --* Any tags assigned to the customer gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **BgpAsnExtended** *(string) --* The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values: "2,147,483,648" to "4,294,967,295" * **CustomerGatewayId** *(string) --* The ID of the customer gateway. * **State** *(string) --* The current state of the customer gateway ( "pending | available | deleting | deleted"). * **Type** *(string) --* The type of VPN connection the customer gateway supports ( "ipsec.1"). * **IpAddress** *(string) --* The IP address for the customer gateway device's outside interface. The address must be static. If "OutsideIpAddressType" in your VPN connection options is set to "PrivateIpv4", you can use an RFC6598 or RFC1918 private IPv4 address. If "OutsideIpAddressType" is set to "PublicIpv4", you can use a public IPv4 address. If "OutsideIpAddressType" is set to "Ipv6", you can use a public IPv6 address. * **BgpAsn** *(string) --* The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values: "1" to "2,147,483,647" **Examples** This example describes the specified customer gateway. response = client.describe_customer_gateways( CustomerGatewayIds=[ 'cgw-0e11f167', ], ) print(response) Expected Output: { 'CustomerGateways': [ { 'BgpAsn': '65534', 'CustomerGatewayId': 'cgw-0e11f167', 'IpAddress': '12.1.2.3', 'State': 'available', 'Type': 'ipsec.1', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / attach_volume attach_volume ************* EC2.Client.attach_volume(**kwargs) Attaches an Amazon EBS volume to a "running" or "stopped" instance, and exposes it to the instance with the specified device name. Note: The maximum number of Amazon EBS volumes that you can attach to an instance depends on the instance type. If you exceed the volume attachment limit for an instance type, the attachment request fails with the "AttachmentLimitExceeded" error. For more information, see Instance volume limits. After you attach an EBS volume, you must make it available for use. For more information, see Make an EBS volume available for use. If a volume has an Amazon Web Services Marketplace product code: * The volume can be attached only to a stopped instance. * Amazon Web Services Marketplace product codes are copied from the volume to the instance. * You must be subscribed to the product. * The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information, see Attach an Amazon EBS volume to an instance in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.attach_volume( Device='string', InstanceId='string', VolumeId='string', DryRun=True|False ) Parameters: * **Device** (*string*) -- **[REQUIRED]** The device name (for example, "/dev/sdh" or "xvdh"). * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the EBS volume. The volume and instance must be within the same Availability Zone. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. **Examples** This example attaches a volume ("vol-1234567890abcdef0") to an instance ("i-01474ef662b89480") as "/dev/sdf". response = client.attach_volume( Device='/dev/sdf', InstanceId='i-01474ef662b89480', VolumeId='vol-1234567890abcdef0', ) print(response) Expected Output: { 'AttachTime': datetime(2016, 8, 29, 18, 52, 32, 0, 242, 0), 'Device': '/dev/sdf', 'InstanceId': 'i-01474ef662b89480', 'State': 'attaching', 'VolumeId': 'vol-1234567890abcdef0', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_launch_template_versions describe_launch_template_versions ********************************* EC2.Client.describe_launch_template_versions(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.describe_launch_template_versions( DryRun=True|False, LaunchTemplateId='string', LaunchTemplateName='string', Versions=[ 'string', ], MinVersion='string', MaxVersion='string', NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ResolveAlias=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- 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, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. * **LaunchTemplateName** (*string*) -- The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. * **Versions** (*list*) -- 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 request. You cannot specify numbers. * *(string) --* * **MinVersion** (*string*) -- The version number after which to describe launch template versions. * **MaxVersion** (*string*) -- The version number up to which to describe launch template versions. * **NextToken** (*string*) -- The token to request the next page of results. * **MaxResults** (*integer*) -- 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. * **Filters** (*list*) -- 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. * "http-endpoint" - Indicates whether the HTTP metadata endpoint on your instances is enabled ( "enabled" | "disabled"). * "http-protocol-ipv4" - Indicates whether the IPv4 endpoint for the instance metadata service is enabled ( "enabled" | "disabled"). * "host-resource-group-arn" - The ARN of the host resource group in which to launch the instances. * "http-tokens" - The state of token usage for your instance metadata requests ( "optional" | "required"). * "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. * "license-configuration-arn" - The ARN of the license configuration. * "network-card-index" - The index of the network card. * "ram-disk-id" - The RAM disk ID. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ResolveAlias** (*boolean*) -- If "true", and if a Systems Manager parameter is specified for "ImageId", the AMI ID is displayed in the response for "imageId". If "false", and if a Systems Manager parameter is specified for "ImageId", the parameter is displayed in the response for "imageId". For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. Default: "false" Return type: dict Returns: **Response Syntax** { 'LaunchTemplateVersions': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'VersionNumber': 123, 'VersionDescription': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersion': True|False, 'LaunchTemplateData': { 'KernelId': 'string', 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'Throughput': 123, 'VolumeInitializationRate': 123 }, 'NoDevice': 'string' }, ], 'NetworkInterfaces': [ { 'AssociateCarrierIpAddress': True|False, 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'InterfaceType': 'string', 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpTimeout': 123, 'UdpStreamTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'Placement': { 'AvailabilityZone': 'string', 'Affinity': 'string', 'GroupName': 'string', 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'PartitionNumber': 123, 'GroupId': 'string' }, 'RamDiskId': 'string', 'DisableApiTermination': True|False, 'InstanceInitiatedShutdownBehavior': 'stop'|'terminate', 'UserData': 'string', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'ElasticGpuSpecifications': [ { 'Type': 'string' }, ], 'ElasticInferenceAccelerators': [ { 'Type': 'string', 'Count': 123 }, ], 'SecurityGroupIds': [ 'string', ], 'SecurityGroups': [ 'string', ], 'InstanceMarketOptions': { 'MarketType': 'spot'|'capacity-block', 'SpotOptions': { 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'BlockDurationMinutes': 123, 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' } }, 'CreditSpecification': { 'CpuCredits': 'string' }, 'CpuOptions': { 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, 'CapacityReservationSpecification': { 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, 'LicenseSpecifications': [ { 'LicenseConfigurationArn': 'string' }, ], 'HibernationOptions': { 'Configured': True|False }, 'MetadataOptions': { 'State': 'pending'|'applied', 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, 'EnclaveOptions': { 'Enabled': True|False }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'PrivateDnsNameOptions': { 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, 'MaintenanceOptions': { 'AutoRecovery': 'default'|'disabled' }, 'DisableApiStop': True|False, 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'NetworkPerformanceOptions': { 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' } }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LaunchTemplateVersions** *(list) --* Information about the launch template versions. * *(dict) --* Describes a launch template version. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **VersionNumber** *(integer) --* The version number. * **VersionDescription** *(string) --* The description for the version. * **CreateTime** *(datetime) --* The time the version was created. * **CreatedBy** *(string) --* The principal that created the version. * **DefaultVersion** *(boolean) --* Indicates whether the version is the default version. * **LaunchTemplateData** *(dict) --* Information about the launch template. * **KernelId** *(string) --* The ID of the kernel, if applicable. * **EbsOptimized** *(boolean) --* Indicates whether the instance is optimized for Amazon EBS I/O. * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **BlockDeviceMappings** *(list) --* The block device mappings. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name. * **VirtualName** *(string) --* The virtual device name (ephemeralN). * **Ebs** *(dict) --* Information about the block device for an EBS volume. * **Encrypted** *(boolean) --* Indicates whether the EBS volume is encrypted. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **Iops** *(integer) --* The number of I/O operations per second (IOPS) that the volume supports. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiB. * **VolumeType** *(string) --* The volume type. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **VolumeInitializationRate** *(integer) --* The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. If no volume initialization rate was specified, the value is "null". * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. * **NetworkInterfaces** *(list) --* The network interfaces. * *(dict) --* Describes a network interface. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to associate a Carrier IP address with eth0 for a new network interface. Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP address in the *Wavelength Developer Guide*. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to associate a public IPv4 address with eth0 for a new network interface. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **Description** *(string) --* A description for the network interface. * **DeviceIndex** *(integer) --* The device index for the network interface attachment. * **Groups** *(list) --* The IDs of one or more security groups. * *(string) --* * **InterfaceType** *(string) --* The type of network interface. * **Ipv6AddressCount** *(integer) --* The number of IPv6 addresses for the network interface. * **Ipv6Addresses** *(list) --* The IPv6 addresses for the network interface. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **PrivateIpAddress** *(string) --* The primary private IPv4 address of the network interface. * **PrivateIpAddresses** *(list) --* One or more private IPv4 addresses. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses for the network interface. * **SubnetId** *(string) --* The ID of the subnet for the network interface. * **NetworkCardIndex** *(integer) --* The index of the network card. * **Ipv4Prefixes** *(list) --* One or more IPv4 prefixes assigned to the network interface. * *(dict) --* Information about the IPv4 delegated prefixes assigned to a network interface. * **Ipv4Prefix** *(string) --* The IPv4 delegated prefixes assigned to the network interface. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. * **Ipv6Prefixes** *(list) --* One or more IPv6 prefixes assigned to the network interface. * *(dict) --* Information about the IPv6 delegated prefixes assigned to a network interface. * **Ipv6Prefix** *(string) --* The IPv6 delegated prefixes assigned to the network interface. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Contains the ENA Express settings for instances launched from your launch template. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **ImageId** *(string) --* The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch. The value depends on what you specified in the request. The possible values are: * If an AMI ID was specified in the request, then this is the AMI ID. * If a Systems Manager parameter was specified in the request, and "ResolveAlias" was configured as "true", then this is the AMI ID that the parameter is mapped to in the Parameter Store. * If a Systems Manager parameter was specified in the request, and "ResolveAlias" was configured as "false", then this is the parameter value. For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. * **InstanceType** *(string) --* The instance type. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* The monitoring for the instance. * **Enabled** *(boolean) --* Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **Placement** *(dict) --* The placement of the instance. * **AvailabilityZone** *(string) --* The Availability Zone of the instance. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. * **GroupName** *(string) --* The name of the placement group for the instance. * **HostId** *(string) --* The ID of the Dedicated Host for the instance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. * **PartitionNumber** *(integer) --* The number of the partition the instance should launch in. Valid only if the placement group strategy is set to "partition". * **GroupId** *(string) --* The Group ID of the placement group. You must specify the Placement Group **Group ID** to launch an instance in a shared placement group. * **RamDiskId** *(string) --* The ID of the RAM disk, if applicable. * **DisableApiTermination** *(boolean) --* If set to "true", indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API. * **InstanceInitiatedShutdownBehavior** *(string) --* Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). * **UserData** *(string) --* The user data for the instance. * **TagSpecifications** *(list) --* The tags that are applied to the resources that are created during instance launch. * *(dict) --* The tags specification for the launch template. * **ResourceType** *(string) --* The type of resource to tag. * **Tags** *(list) --* The tags for the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ElasticGpuSpecifications** *(list) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * **Type** *(string) --* Deprecated. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * **ElasticInferenceAccelerators** *(list) --* Note: Amazon Elastic Inference is no longer available. 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. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes an elastic inference accelerator. * **Type** *(string) --* The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. * **Count** *(integer) --* The number of elastic inference accelerators to attach to the instance. Default: 1 * **SecurityGroupIds** *(list) --* The security group IDs. * *(string) --* * **SecurityGroups** *(list) --* The security group names. * *(string) --* * **InstanceMarketOptions** *(dict) --* The market (purchasing) option for the instances. * **MarketType** *(string) --* The market type. * **SpotOptions** *(dict) --* The options for Spot Instances. * **MaxPrice** *(string) --* The maximum hourly price you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. If you do specify this parameter, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message when the launch template is used to launch an instance. * **SpotInstanceType** *(string) --* The Spot Instance request type. * **BlockDurationMinutes** *(integer) --* 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). * **ValidUntil** *(datetime) --* The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. * **InstanceInterruptionBehavior** *(string) --* The behavior when a Spot Instance is interrupted. * **CreditSpecification** *(dict) --* The credit option for CPU usage of the instance. * **CpuCredits** *(string) --* The credit option for CPU usage of a T instance. Valid values: "standard" | "unlimited" * **CpuOptions** *(dict) --* The CPU options for the instance. For more information, see CPU options for Amazon EC2 instances in the *Amazon EC2 User Guide*. * **CoreCount** *(integer) --* The number of CPU cores for the instance. * **ThreadsPerCore** *(integer) --* The number of threads per CPU core. * **AmdSevSnp** *(string) --* Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP for Amazon EC2 instances. * **CapacityReservationSpecification** *(dict) --* Information about the Capacity Reservation targeting option. * **CapacityReservationPreference** *(string) --* Indicates the instance's Capacity Reservation preferences. Possible preferences include: * "open" - The instance can run in any "open" Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). * "none" - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity. * **CapacityReservationTarget** *(dict) --* Information about the target Capacity Reservation or Capacity Reservation group. * **CapacityReservationId** *(string) --* The ID of the targeted Capacity Reservation. * **CapacityReservationResourceGroupArn** *(string) --* The ARN of the targeted Capacity Reservation group. * **LicenseSpecifications** *(list) --* The license configurations. * *(dict) --* Describes a license configuration. * **LicenseConfigurationArn** *(string) --* The Amazon Resource Name (ARN) of the license configuration. * **HibernationOptions** *(dict) --* Indicates whether an instance is configured for hibernation. For more information, see Hibernate your Amazon EC2 instance in the *Amazon EC2 User Guide*. * **Configured** *(boolean) --* If this parameter is set to "true", the instance is enabled for hibernation; otherwise, it is not enabled for hibernation. * **MetadataOptions** *(dict) --* The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the *Amazon EC2 User Guide*. * **State** *(string) --* The state of the metadata option changes. "pending" - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection. "applied" - The metadata options have been successfully applied on the instance. * **HttpTokens** *(string) --* Indicates whether IMDSv2 is required. * "optional" - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. * "required" - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. * **HttpPutResponseHopLimit** *(integer) --* The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Default: 1 Possible values: Integers from 1 to 64 * **HttpEndpoint** *(string) --* Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is "enabled". Note: If you specify a value of "disabled", you will not be able to access your instance metadata. * **HttpProtocolIpv6** *(string) --* Enables or disables the IPv6 endpoint for the instance metadata service. Default: "disabled" * **InstanceMetadataTags** *(string) --* Set to "enabled" to allow access to instance tags from the instance metadata. Set to "disabled" to turn off access to instance tags from the instance metadata. For more information, see View tags for your EC2 instances using instance metadata. Default: "disabled" * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify "InstanceRequirements", you can't specify "InstanceTypes". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in- 32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **PrivateDnsNameOptions** *(dict) --* The options for the instance hostname. * **HostnameType** *(string) --* The type of hostname to assign to an instance. * **EnableResourceNameDnsARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS A records. * **EnableResourceNameDnsAAAARecord** *(boolean) --* Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. * **MaintenanceOptions** *(dict) --* The maintenance options for your instance. * **AutoRecovery** *(string) --* Disables the automatic recovery behavior of your instance or sets it to default. * **DisableApiStop** *(boolean) --* Indicates whether the instance is enabled for stop protection. For more information, see Enable stop protection for your EC2 instances in the *Amazon EC2 User Guide*. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **NetworkPerformanceOptions** *(dict) --* Contains the launch template settings for network performance options for your instance. * **BandwidthWeighting** *(string) --* When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Examples** This example describes the versions for the specified launch template. response = client.describe_launch_template_versions( LaunchTemplateId='068f72b72934aff71', ) print(response) Expected Output: { 'LaunchTemplateVersions': [ { 'CreateTime': datetime(2017, 11, 20, 13, 12, 32, 0, 324, 0), 'CreatedBy': 'arn:aws:iam::123456789102:root', 'DefaultVersion': False, 'LaunchTemplateData': { 'ImageId': 'ami-6057e21a', 'InstanceType': 't2.medium', 'KeyName': 'kp-us-east', 'NetworkInterfaces': [ { 'DeviceIndex': 0, 'Groups': [ 'sg-7c227019', ], 'SubnetId': 'subnet-1a2b3c4d', }, ], }, 'LaunchTemplateId': 'lt-068f72b72934aff71', 'LaunchTemplateName': 'Webservers', 'VersionNumber': 2, }, { 'CreateTime': datetime(2017, 11, 20, 12, 52, 33, 0, 324, 0), 'CreatedBy': 'arn:aws:iam::123456789102:root', 'DefaultVersion': True, 'LaunchTemplateData': { 'ImageId': 'ami-aabbcc11', 'InstanceType': 't2.medium', 'KeyName': 'kp-us-east', 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True, 'DeleteOnTermination': False, 'DeviceIndex': 0, 'Groups': [ 'sg-7c227019', ], 'SubnetId': 'subnet-7b16de0c', }, ], 'UserData': '', }, 'LaunchTemplateId': 'lt-068f72b72934aff71', 'LaunchTemplateName': 'Webservers', 'VersionNumber': 1, }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / create_flow_logs create_flow_logs **************** EC2.Client.create_flow_logs(**kwargs) Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the *Amazon VPC User Guide*. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see VPC Flow Logs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_flow_logs( DryRun=True|False, ClientToken='string', DeliverLogsPermissionArn='string', DeliverCrossAccountRole='string', LogGroupName='string', ResourceIds=[ 'string', ], ResourceType='VPC'|'Subnet'|'NetworkInterface'|'TransitGateway'|'TransitGatewayAttachment', TrafficType='ACCEPT'|'REJECT'|'ALL', LogDestinationType='cloud-watch-logs'|'s3'|'kinesis-data-firehose', LogDestination='string', LogFormat='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], MaxAggregationInterval=123, DestinationOptions={ 'FileFormat': 'plain-text'|'parquet', 'HiveCompatiblePartitions': True|False, 'PerHourPartition': True|False } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. * **DeliverLogsPermissionArn** (*string*) -- The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required if the destination type is "cloud- watch-logs", or if the destination type is "kinesis-data- firehose" and the delivery stream and the resources to monitor are in different accounts. * **DeliverCrossAccountRole** (*string*) -- The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. * **LogGroupName** (*string*) -- The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is valid only if the destination type is "cloud-watch-logs". * **ResourceIds** (*list*) -- **[REQUIRED]** The IDs of the resources to monitor. For example, if the resource type is "VPC", specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types. * *(string) --* * **ResourceType** (*string*) -- **[REQUIRED]** The type of resource to monitor. * **TrafficType** (*string*) -- The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types. * **LogDestinationType** (*string*) -- The type of destination for the flow log data. Default: "cloud-watch-logs" * **LogDestination** (*string*) -- The destination for the flow log data. The meaning of this parameter depends on the destination type. * If the destination type is "cloud-watch-logs", specify the ARN of a CloudWatch Logs log group. For example: arn:aws:logs:*region*:*account_id*:log-group:*my_group* Alternatively, use the "LogGroupName" parameter. * If the destination type is "s3", specify the ARN of an S3 bucket. For example: arn:aws:s3:::*my_bucket*/*my_subfolder*/ The subfolder is optional. Note that you can't use "AWSLogs" as a subfolder name. * If the destination type is "kinesis-data-firehose", specify the ARN of a Kinesis Data Firehose delivery stream. For example: arn:aws:firehose:*region*:*account_id*:deliverystr eam:*my_stream* * **LogFormat** (*string*) -- The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the *Amazon VPC User Guide* or Transit Gateway Flow Log records in the *Amazon Web Services Transit Gateway Guide*. Specify the fields using the "${field-id}" format, separated by spaces. * **TagSpecifications** (*list*) -- The tags to apply to the flow logs. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **MaxAggregationInterval** (*integer*) -- The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types. 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 * **DestinationOptions** (*dict*) -- The destination options. * **FileFormat** *(string) --* The format for the flow log. The default is "plain-text". * **HiveCompatiblePartitions** *(boolean) --* Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is "false". * **PerHourPartition** *(boolean) --* Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is "false". Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string', 'FlowLogIds': [ 'string', ], 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. * **FlowLogIds** *(list) --* The IDs of the flow logs. * *(string) --* * **Unsuccessful** *(list) --* Information about the flow logs that could not be created successfully. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / describe_ipam_byoasn describe_ipam_byoasn ******************** EC2.Client.describe_ipam_byoasn(**kwargs) Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the *Amazon VPC IPAM guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_ipam_byoasn( DryRun=True|False, MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*integer*) -- 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** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'Byoasns': [ { 'Asn': 'string', 'IpamId': 'string', 'StatusMessage': 'string', 'State': 'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Byoasns** *(list) --* ASN and BYOIP CIDR associations. * *(dict) --* The Autonomous System Number (ASN) and BYOIP CIDR association. * **Asn** *(string) --* A public 2-byte or 4-byte ASN. * **IpamId** *(string) --* An IPAM ID. * **StatusMessage** *(string) --* The status message. * **State** *(string) --* The provisioning state of the BYOASN. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / delete_local_gateway_route delete_local_gateway_route ************************** EC2.Client.delete_local_gateway_route(**kwargs) Deletes the specified route from the specified local gateway route table. See also: AWS API Documentation **Request Syntax** response = client.delete_local_gateway_route( DestinationCidrBlock='string', LocalGatewayRouteTableId='string', DryRun=True|False, DestinationPrefixListId='string' ) Parameters: * **DestinationCidrBlock** (*string*) -- The CIDR range for the route. This must match the CIDR for the route exactly. * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **DestinationPrefixListId** (*string*) -- Use a prefix list in place of "DestinationCidrBlock". You cannot use "DestinationPrefixListId" and "DestinationCidrBlock" in the same request. Return type: dict Returns: **Response Syntax** { 'Route': { 'DestinationCidrBlock': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'Type': 'static'|'propagated', 'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string', 'SubnetId': 'string', 'CoipPoolId': 'string', 'NetworkInterfaceId': 'string', 'DestinationPrefixListId': 'string' } } **Response Structure** * *(dict) --* * **Route** *(dict) --* Information about the route. * **DestinationCidrBlock** *(string) --* The CIDR block used for destination matches. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **Type** *(string) --* The route type. * **State** *(string) --* The state of the route. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route. * **SubnetId** *(string) --* The ID of the subnet. * **CoipPoolId** *(string) --* The ID of the customer-owned address pool. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **DestinationPrefixListId** *(string) --* The ID of the prefix list. EC2 / Client / revoke_security_group_egress revoke_security_group_egress **************************** EC2.Client.revoke_security_group_egress(**kwargs) Removes the specified outbound (egress) rules from the specified security group. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. See also: AWS API Documentation **Request Syntax** response = client.revoke_security_group_egress( SecurityGroupRuleIds=[ 'string', ], DryRun=True|False, GroupId='string', SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', IpProtocol='string', FromPort=123, ToPort=123, CidrIp='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ] ) Parameters: * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the security group. * **SourceSecurityGroupName** (*string*) -- Not supported. Use a set of IP permissions to specify a destination security group. * **SourceSecurityGroupOwnerId** (*string*) -- Not supported. Use a set of IP permissions to specify a destination security group. * **IpProtocol** (*string*) -- Not supported. Use a set of IP permissions to specify the protocol name or number. * **FromPort** (*integer*) -- Not supported. Use a set of IP permissions to specify the port. * **ToPort** (*integer*) -- Not supported. Use a set of IP permissions to specify the port. * **CidrIp** (*string*) -- Not supported. Use a set of IP permissions to specify the CIDR. * **IpPermissions** (*list*) -- 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. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'UnknownIpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'RevokedSecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupId': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **UnknownIpPermissions** *(list) --* The outbound rules that were unknown to the service. In some cases, "unknownIpPermissionSet" might be in a different format from the request parameter. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **RevokedSecurityGroupRules** *(list) --* Details about the revoked security group rules. * *(dict) --* A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress. * **SecurityGroupRuleId** *(string) --* A security group rule ID. * **GroupId** *(string) --* A security group ID. * **IsEgress** *(boolean) --* Defines if a security group rule is an outbound rule. * **IpProtocol** *(string) --* The security group rule's protocol. * **FromPort** *(integer) --* The 'from' port number of the security group rule. * **ToPort** *(integer) --* The 'to' port number of the security group rule. * **CidrIpv4** *(string) --* The IPv4 CIDR of the traffic source. * **CidrIpv6** *(string) --* The IPv6 CIDR of the traffic source. * **PrefixListId** *(string) --* The ID of a prefix list that's the traffic source. * **ReferencedGroupId** *(string) --* The ID of a referenced security group. * **Description** *(string) --* A description of the revoked security group rule. EC2 / Client / describe_instance_attribute describe_instance_attribute *************************** EC2.Client.describe_instance_attribute(**kwargs) Describes the specified attribute of the specified instance. You can specify only one attribute at a time. See also: AWS API Documentation **Request Syntax** response = client.describe_instance_attribute( DryRun=True|False, InstanceId='string', Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **Attribute** (*string*) -- **[REQUIRED]** The instance attribute. Note that the "enaSupport" attribute is not supported. Return type: dict Returns: **Response Syntax** { 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'Ebs': { 'AttachTime': datetime(2015, 1, 1), 'DeleteOnTermination': True|False, 'Status': 'attaching'|'attached'|'detaching'|'detached', 'VolumeId': 'string', 'AssociatedResource': 'string', 'VolumeOwnerId': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' } } }, ], 'DisableApiTermination': { 'Value': True|False }, 'EnaSupport': { 'Value': True|False }, 'EnclaveOptions': { 'Enabled': True|False }, 'EbsOptimized': { 'Value': True|False }, 'InstanceId': 'string', 'InstanceInitiatedShutdownBehavior': { 'Value': 'string' }, 'InstanceType': { 'Value': 'string' }, 'KernelId': { 'Value': 'string' }, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'RamdiskId': { 'Value': 'string' }, 'RootDeviceName': { 'Value': 'string' }, 'SourceDestCheck': { 'Value': True|False }, 'SriovNetSupport': { 'Value': 'string' }, 'UserData': { 'Value': 'string' }, 'DisableApiStop': { 'Value': True|False }, 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ] } **Response Structure** * *(dict) --* Describes an instance attribute. * **BlockDeviceMappings** *(list) --* The block device mapping of the instance. * *(dict) --* Describes a block device mapping. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Status** *(string) --* The attachment state. * **VolumeId** *(string) --* The ID of the EBS volume. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **VolumeOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the volume. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **Operator** *(dict) --* The service provider that manages the EBS volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **DisableApiTermination** *(dict) --* Indicates whether termination protection is enabled. If the value is "true", you can't terminate the instance using the Amazon EC2 console, command line tools, or API. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnaSupport** *(dict) --* Indicates whether enhanced networking with ENA is enabled. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **EnclaveOptions** *(dict) --* Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. * **Enabled** *(boolean) --* If this parameter is set to "true", the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves. * **EbsOptimized** *(dict) --* Indicates whether the instance is optimized for Amazon EBS I/O. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **InstanceId** *(string) --* The ID of the instance. * **InstanceInitiatedShutdownBehavior** *(dict) --* Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). * **Value** *(string) --* The attribute value. The value is case-sensitive. * **InstanceType** *(dict) --* The instance type. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **KernelId** *(dict) --* The kernel ID. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **ProductCodes** *(list) --* The product codes. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **RamdiskId** *(dict) --* The RAM disk ID. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **RootDeviceName** *(dict) --* The device name of the root device volume (for example, "/dev/sda1"). * **Value** *(string) --* The attribute value. The value is case-sensitive. * **SourceDestCheck** *(dict) --* Indicates whether source/destination checks are enabled. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **SriovNetSupport** *(dict) --* Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **UserData** *(dict) --* The user data. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **DisableApiStop** *(dict) --* Indicates whether stop protection is enabled for the instance. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **Groups** *(list) --* The security groups associated with the instance. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. **Examples** This example describes the instance type of the specified instance. response = client.describe_instance_attribute( Attribute='instanceType', InstanceId='i-1234567890abcdef0', ) print(response) Expected Output: { 'InstanceId': 'i-1234567890abcdef0', 'InstanceType': { 'Value': 't1.micro', }, 'ResponseMetadata': { '...': '...', }, } This example describes the "disableApiTermination" attribute of the specified instance. response = client.describe_instance_attribute( Attribute='disableApiTermination', InstanceId='i-1234567890abcdef0', ) print(response) Expected Output: { 'DisableApiTermination': { 'Value': 'false', }, 'InstanceId': 'i-1234567890abcdef0', 'ResponseMetadata': { '...': '...', }, } This example describes the "blockDeviceMapping" attribute of the specified instance. response = client.describe_instance_attribute( Attribute='blockDeviceMapping', InstanceId='i-1234567890abcdef0', ) print(response) Expected Output: { 'BlockDeviceMappings': [ { 'DeviceName': '/dev/sda1', 'Ebs': { 'AttachTime': datetime(2013, 5, 17, 22, 42, 34, 4, 137, 0), 'DeleteOnTermination': True, 'Status': 'attached', 'VolumeId': 'vol-049df61146c4d7901', }, }, { 'DeviceName': '/dev/sdf', 'Ebs': { 'AttachTime': datetime(2013, 9, 10, 23, 7, 0, 1, 253, 0), 'DeleteOnTermination': False, 'Status': 'attached', 'VolumeId': 'vol-049df61146c4d7901', }, }, ], 'InstanceId': 'i-1234567890abcdef0', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_trunk_interface_associations describe_trunk_interface_associations ************************************* EC2.Client.describe_trunk_interface_associations(**kwargs) Describes one or more network interface trunk associations. See also: AWS API Documentation **Request Syntax** response = client.describe_trunk_interface_associations( AssociationIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **AssociationIds** (*list*) -- The IDs of the associations. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "gre-key" - The ID of a trunk interface association. * "interface-protocol" - The interface protocol. Valid values are "VLAN" and "GRE". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. Return type: dict Returns: **Response Syntax** { 'InterfaceAssociations': [ { 'AssociationId': 'string', 'BranchInterfaceId': 'string', 'TrunkInterfaceId': 'string', 'InterfaceProtocol': 'VLAN'|'GRE', 'VlanId': 123, 'GreKey': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InterfaceAssociations** *(list) --* Information about the trunk associations. * *(dict) --* Information about an association between a branch network interface with a trunk network interface. * **AssociationId** *(string) --* The ID of the association. * **BranchInterfaceId** *(string) --* The ID of the branch network interface. * **TrunkInterfaceId** *(string) --* The ID of the trunk network interface. * **InterfaceProtocol** *(string) --* The interface protocol. Valid values are "VLAN" and "GRE". * **VlanId** *(integer) --* The ID of the VLAN when you use the VLAN protocol. * **GreKey** *(integer) --* The application key when you use the GRE protocol. * **Tags** *(list) --* The tags for the trunk interface association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_iam_instance_profile_associations describe_iam_instance_profile_associations ****************************************** EC2.Client.describe_iam_instance_profile_associations(**kwargs) Describes your IAM instance profile associations. See also: AWS API Documentation **Request Syntax** response = client.describe_iam_instance_profile_associations( AssociationIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **AssociationIds** (*list*) -- The IAM instance profile associations. * *(string) --* * **Filters** (*list*) -- The filters. * "instance-id" - The ID of the instance. * "state" - The state of the association ( "associating" | "associated" | "disassociating"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'IamInstanceProfileAssociations': [ { 'AssociationId': 'string', 'InstanceId': 'string', 'IamInstanceProfile': { 'Arn': 'string', 'Id': 'string' }, 'State': 'associating'|'associated'|'disassociating'|'disassociated', 'Timestamp': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IamInstanceProfileAssociations** *(list) --* Information about the IAM instance profile associations. * *(dict) --* Describes an association between an IAM instance profile and an instance. * **AssociationId** *(string) --* The ID of the association. * **InstanceId** *(string) --* The ID of the instance. * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. * **State** *(string) --* The state of the association. * **Timestamp** *(datetime) --* The time the IAM instance profile was associated with the instance. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. **Examples** This example describes the specified IAM instance profile association. response = client.describe_iam_instance_profile_associations( AssociationIds=[ 'iip-assoc-0db249b1f25fa24b8', ], ) print(response) Expected Output: { 'IamInstanceProfileAssociations': [ { 'AssociationId': 'iip-assoc-0db249b1f25fa24b8', 'IamInstanceProfile': { 'Arn': 'arn:aws:iam::123456789012:instance-profile/admin-role', 'Id': 'AIPAJVQN4F5WVLGCJDRGM', }, 'InstanceId': 'i-09eb09efa73ec1dee', 'State': 'associated', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / search_transit_gateway_multicast_groups search_transit_gateway_multicast_groups *************************************** EC2.Client.search_transit_gateway_multicast_groups(**kwargs) Searches one or more transit gateway multicast groups and returns the group membership information. See also: AWS API Documentation **Request Syntax** response = client.search_transit_gateway_multicast_groups( TransitGatewayMulticastDomainId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- **[REQUIRED]** The ID of the transit gateway multicast domain. * **Filters** (*list*) -- 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". * "subnet-id" - The ID of the subnet. * "transit-gateway-attachment-id" - The id of the transit gateway attachment. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'MulticastGroups': [ { 'GroupIpAddress': 'string', 'TransitGatewayAttachmentId': 'string', 'SubnetId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceOwnerId': 'string', 'NetworkInterfaceId': 'string', 'GroupMember': True|False, 'GroupSource': True|False, 'MemberType': 'static'|'igmp', 'SourceType': 'static'|'igmp' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **MulticastGroups** *(list) --* Information about the transit gateway multicast group. * *(dict) --* Describes the transit gateway multicast group resources. * **GroupIpAddress** *(string) --* The IP address assigned to the transit gateway multicast group. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **SubnetId** *(string) --* The ID of the subnet. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource, for example a VPC attachment. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource. * **NetworkInterfaceId** *(string) --* The ID of the transit gateway attachment. * **GroupMember** *(boolean) --* Indicates that the resource is a transit gateway multicast group member. * **GroupSource** *(boolean) --* Indicates that the resource is a transit gateway multicast group member. * **MemberType** *(string) --* The member type (for example, "static"). * **SourceType** *(string) --* The source type. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / get_instance_types_from_instance_requirements get_instance_types_from_instance_requirements ********************************************* EC2.Client.get_instance_types_from_instance_requirements(**kwargs) Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see Preview instance types with specified attributes, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot placement score in the *Amazon EC2 User Guide*, and Creating mixed instance groups using attribute- based instance type selection in the *Amazon EC2 Auto Scaling User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_instance_types_from_instance_requirements( DryRun=True|False, ArchitectureTypes=[ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], VirtualizationTypes=[ 'hvm'|'paravirtual', ], InstanceRequirements={ 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, MaxResults=123, NextToken='string', Context='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ArchitectureTypes** (*list*) -- **[REQUIRED]** The processor architecture type. * *(string) --* * **VirtualizationTypes** (*list*) -- **[REQUIRED]** The virtualization type. * *(string) --* * **InstanceRequirements** (*dict*) -- **[REQUIRED]** The attributes required for the instance types. * **VCpuCount** *(dict) --* **[REQUIRED]** The minimum and maximum number of vCPUs. * **Min** *(integer) --* **[REQUIRED]** The minimum number of vCPUs. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum number of vCPUs. To specify no maximum limit, omit this parameter. * **MemoryMiB** *(dict) --* **[REQUIRED]** The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* **[REQUIRED]** The minimum amount of memory, in MiB. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance family, type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On- Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To indicate no price protection threshold, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per- instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of network interfaces. To specify no maximum limit, omit this parameter. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set "Max" to "0". * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory- mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **Context** (*string*) -- Reserved. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceTypes** *(list) --* The instance types with the specified instance attributes. * *(dict) --* The list of instance types with the specified instance attributes. * **InstanceType** *(string) --* The matching instance type. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / describe_fpga_images describe_fpga_images ******************** EC2.Client.describe_fpga_images(**kwargs) Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions. See also: AWS API Documentation **Request Syntax** response = client.describe_fpga_images( DryRun=True|False, FpgaImageIds=[ 'string', ], Owners=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FpgaImageIds** (*list*) -- The AFI IDs. * *(string) --* * **Owners** (*list*) -- Filters the AFI by owner. Specify an Amazon Web Services account ID, "self" (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are "amazon" | "aws-marketplace"). * *(string) --* * **Filters** (*list*) -- 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 identifier (AGFI ID). * "name" - The name of the AFI. * "owner-id" - The Amazon Web Services account ID of the AFI owner. * "product-code" - The product code. * "shell-version" - The version of the Amazon Web Services Shell that was used to create the bitstream. * "state" - The state of the AFI ( "pending" | "failed" | "available" | "unavailable"). * "tag": - 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. * "update-time" - The time of the most recent update. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. Return type: dict Returns: **Response Syntax** { 'FpgaImages': [ { 'FpgaImageId': 'string', 'FpgaImageGlobalId': 'string', 'Name': 'string', 'Description': 'string', 'ShellVersion': 'string', 'PciId': { 'DeviceId': 'string', 'VendorId': 'string', 'SubsystemId': 'string', 'SubsystemVendorId': 'string' }, 'State': { 'Code': 'pending'|'failed'|'available'|'unavailable', 'Message': 'string' }, 'CreateTime': datetime(2015, 1, 1), 'UpdateTime': datetime(2015, 1, 1), 'OwnerId': 'string', 'OwnerAlias': 'string', 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Public': True|False, 'DataRetentionSupport': True|False, 'InstanceTypes': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FpgaImages** *(list) --* Information about the FPGA images. * *(dict) --* Describes an Amazon FPGA image (AFI). * **FpgaImageId** *(string) --* The FPGA image identifier (AFI ID). * **FpgaImageGlobalId** *(string) --* The global FPGA image identifier (AGFI ID). * **Name** *(string) --* The name of the AFI. * **Description** *(string) --* The description of the AFI. * **ShellVersion** *(string) --* The version of the Amazon Web Services Shell that was used to create the bitstream. * **PciId** *(dict) --* Information about the PCI bus. * **DeviceId** *(string) --* The ID of the device. * **VendorId** *(string) --* The ID of the vendor. * **SubsystemId** *(string) --* The ID of the subsystem. * **SubsystemVendorId** *(string) --* The ID of the vendor for the subsystem. * **State** *(dict) --* Information about the state of the AFI. * **Code** *(string) --* The state. The following are the possible values: * "pending" - AFI bitstream generation is in progress. * "available" - The AFI is available for use. * "failed" - AFI bitstream generation failed. * "unavailable" - The AFI is no longer available for use. * **Message** *(string) --* If the state is "failed", this is the error message. * **CreateTime** *(datetime) --* The date and time the AFI was created. * **UpdateTime** *(datetime) --* The time of the most recent update to the AFI. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the AFI. * **OwnerAlias** *(string) --* The alias of the AFI owner. Possible values include "self", "amazon", and "aws-marketplace". * **ProductCodes** *(list) --* The product codes for the AFI. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **Tags** *(list) --* Any tags assigned to the AFI. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Public** *(boolean) --* Indicates whether the AFI is public. * **DataRetentionSupport** *(boolean) --* Indicates whether data retention support is enabled for the AFI. * **InstanceTypes** *(list) --* The instance types supported by the AFI. * *(string) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / delete_launch_template_versions delete_launch_template_versions ******************************* EC2.Client.delete_launch_template_versions(**kwargs) Deletes one or more versions of a launch template. You can't delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate. You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the launch template and all of its versions. For more information, see Delete a launch template version in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_launch_template_versions( DryRun=True|False, LaunchTemplateId='string', LaunchTemplateName='string', Versions=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **LaunchTemplateName** (*string*) -- The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **Versions** (*list*) -- **[REQUIRED]** The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers. * *(string) --* Return type: dict Returns: **Response Syntax** { 'SuccessfullyDeletedLaunchTemplateVersions': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'VersionNumber': 123 }, ], 'UnsuccessfullyDeletedLaunchTemplateVersions': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'VersionNumber': 123, 'ResponseError': { 'Code': 'launchTemplateIdDoesNotExist'|'launchTemplateIdMalformed'|'launchTemplateNameDoesNotExist'|'launchTemplateNameMalformed'|'launchTemplateVersionDoesNotExist'|'unexpectedError', 'Message': 'string' } }, ] } **Response Structure** * *(dict) --* * **SuccessfullyDeletedLaunchTemplateVersions** *(list) --* Information about the launch template versions that were successfully deleted. * *(dict) --* Describes a launch template version that was successfully deleted. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **VersionNumber** *(integer) --* The version number of the launch template. * **UnsuccessfullyDeletedLaunchTemplateVersions** *(list) --* Information about the launch template versions that could not be deleted. * *(dict) --* Describes a launch template version that could not be deleted. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **VersionNumber** *(integer) --* The version number of the launch template. * **ResponseError** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message, if applicable. **Examples** This example deletes the specified launch template version. response = client.delete_launch_template_versions( LaunchTemplateId='lt-0abcd290751193123', Versions=[ '1', ], ) print(response) Expected Output: { 'SuccessfullyDeletedLaunchTemplateVersions': [ { 'LaunchTemplateId': 'lt-0abcd290751193123', 'LaunchTemplateName': 'my-template', 'VersionNumber': 1, }, ], 'UnsuccessfullyDeletedLaunchTemplateVersions': [ ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / update_security_group_rule_descriptions_ingress update_security_group_rule_descriptions_ingress *********************************************** EC2.Client.update_security_group_rule_descriptions_ingress(**kwargs) Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request. See also: AWS API Documentation **Request Syntax** response = client.update_security_group_rule_descriptions_ingress( DryRun=True|False, GroupId='string', GroupName='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], SecurityGroupRuleDescriptions=[ { 'SecurityGroupRuleId': 'string', 'Description': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- 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** (*string*) -- [Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID. * **IpPermissions** (*list*) -- The IP permissions for the security group rule. You must specify either IP permissions or a description. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **SecurityGroupRuleDescriptions** (*list*) -- The description for the ingress security group rules. You must specify either a description or IP permissions. * *(dict) --* Describes the description of a security group rule. You can use this when you want to update the security group rule description for either an inbound or outbound rule. * **SecurityGroupRuleId** *(string) --* The ID of the security group rule. * **Description** *(string) --* The description of the security group rule. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. **Examples** This example updates the description for the specified security group rule. response = client.update_security_group_rule_descriptions_ingress( GroupId='sg-123abc12', IpPermissions=[ { 'FromPort': 22, 'IpProtocol': 'tcp', 'IpRanges': [ { 'CidrIp': '203.0.113.0/16', 'Description': 'SSH access from the LA office', }, ], 'ToPort': 22, }, ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / replace_network_acl_association replace_network_acl_association ******************************* EC2.Client.replace_network_acl_association(**kwargs) Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the *Amazon VPC User Guide*. This is an idempotent operation. See also: AWS API Documentation **Request Syntax** response = client.replace_network_acl_association( DryRun=True|False, AssociationId='string', NetworkAclId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AssociationId** (*string*) -- **[REQUIRED]** The ID of the current association between the original network ACL and the subnet. * **NetworkAclId** (*string*) -- **[REQUIRED]** The ID of the new network ACL to associate with the subnet. Return type: dict Returns: **Response Syntax** { 'NewAssociationId': 'string' } **Response Structure** * *(dict) --* * **NewAssociationId** *(string) --* The ID of the new association. **Examples** This example associates the specified network ACL with the subnet for the specified network ACL association. response = client.replace_network_acl_association( AssociationId='aclassoc-e5b95c8c', NetworkAclId='acl-5fb85d36', ) print(response) Expected Output: { 'NewAssociationId': 'aclassoc-3999875b', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / disassociate_subnet_cidr_block disassociate_subnet_cidr_block ****************************** EC2.Client.disassociate_subnet_cidr_block(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.disassociate_subnet_cidr_block( AssociationId='string' ) Parameters: **AssociationId** (*string*) -- **[REQUIRED]** The association ID for the CIDR block. Return type: dict Returns: **Response Syntax** { 'Ipv6CidrBlockAssociation': { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, 'SubnetId': 'string' } **Response Structure** * *(dict) --* * **Ipv6CidrBlockAssociation** *(dict) --* Information about the IPv6 CIDR block association. * **AssociationId** *(string) --* The ID of the association. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* The state of the CIDR block. * **State** *(string) --* The state of a CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **SubnetId** *(string) --* The ID of the subnet. EC2 / Client / delete_route_table delete_route_table ****************** EC2.Client.delete_route_table(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_route_table( DryRun=True|False, RouteTableId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. Returns: None **Examples** This example deletes the specified route table. response = client.delete_route_table( RouteTableId='rtb-22574640', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / deregister_instance_event_notification_attributes deregister_instance_event_notification_attributes ************************************************* EC2.Client.deregister_instance_event_notification_attributes(**kwargs) Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. See also: AWS API Documentation **Request Syntax** response = client.deregister_instance_event_notification_attributes( DryRun=True|False, InstanceTagAttribute={ 'IncludeAllTagsOfInstance': True|False, 'InstanceTagKeys': [ 'string', ] } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*dict*) -- **[REQUIRED]** Information about the tag keys to deregister. * **IncludeAllTagsOfInstance** *(boolean) --* Indicates whether to deregister all tag keys in the current Region. Specify "false" to deregister all tag keys. * **InstanceTagKeys** *(list) --* Information about the tag keys to deregister. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InstanceTagAttribute': { 'InstanceTagKeys': [ 'string', ], 'IncludeAllTagsOfInstance': True|False } } **Response Structure** * *(dict) --* * **InstanceTagAttribute** *(dict) --* The resulting set of tag keys. * **InstanceTagKeys** *(list) --* The registered tag keys. * *(string) --* * **IncludeAllTagsOfInstance** *(boolean) --* Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. "true" indicates that all tag keys in the current Region are registered. EC2 / Client / associate_iam_instance_profile associate_iam_instance_profile ****************************** EC2.Client.associate_iam_instance_profile(**kwargs) Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. See also: AWS API Documentation **Request Syntax** response = client.associate_iam_instance_profile( IamInstanceProfile={ 'Arn': 'string', 'Name': 'string' }, InstanceId='string' ) Parameters: * **IamInstanceProfile** (*dict*) -- **[REQUIRED]** The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. Return type: dict Returns: **Response Syntax** { 'IamInstanceProfileAssociation': { 'AssociationId': 'string', 'InstanceId': 'string', 'IamInstanceProfile': { 'Arn': 'string', 'Id': 'string' }, 'State': 'associating'|'associated'|'disassociating'|'disassociated', 'Timestamp': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **IamInstanceProfileAssociation** *(dict) --* Information about the IAM instance profile association. * **AssociationId** *(string) --* The ID of the association. * **InstanceId** *(string) --* The ID of the instance. * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Id** *(string) --* The ID of the instance profile. * **State** *(string) --* The state of the association. * **Timestamp** *(datetime) --* The time the IAM instance profile was associated with the instance. **Examples** This example associates an IAM instance profile named admin-role with the specified instance. response = client.associate_iam_instance_profile( IamInstanceProfile={ 'Name': 'admin-role', }, InstanceId='i-123456789abcde123', ) print(response) Expected Output: { 'IamInstanceProfileAssociation': { 'AssociationId': 'iip-assoc-0e7736511a163c209', 'IamInstanceProfile': { 'Arn': 'arn:aws:iam::123456789012:instance-profile/admin-role', 'Id': 'AIPAJBLK7RKJKWDXVHIEC', }, 'InstanceId': 'i-123456789abcde123', 'State': 'associating', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_verified_access_group_policy modify_verified_access_group_policy *********************************** EC2.Client.modify_verified_access_group_policy(**kwargs) Modifies the specified Amazon Web Services Verified Access group policy. See also: AWS API Documentation **Request Syntax** response = client.modify_verified_access_group_policy( VerifiedAccessGroupId='string', PolicyEnabled=True|False, PolicyDocument='string', ClientToken='string', DryRun=True|False, SseSpecification={ 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' } ) Parameters: * **VerifiedAccessGroupId** (*string*) -- **[REQUIRED]** The ID of the Verified Access group. * **PolicyEnabled** (*boolean*) -- The status of the Verified Access policy. * **PolicyDocument** (*string*) -- The Verified Access policy document. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SseSpecification** (*dict*) -- The options for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Enable or disable the use of customer managed KMS keys for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. Return type: dict Returns: **Response Syntax** { 'PolicyEnabled': True|False, 'PolicyDocument': 'string', 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' } } **Response Structure** * *(dict) --* * **PolicyEnabled** *(boolean) --* The status of the Verified Access policy. * **PolicyDocument** *(string) --* The Verified Access policy document. * **SseSpecification** *(dict) --* The options in use for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. EC2 / Client / reset_instance_attribute reset_instance_attribute ************************ EC2.Client.reset_instance_attribute(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.reset_instance_attribute( DryRun=True|False, InstanceId='string', Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **Attribute** (*string*) -- **[REQUIRED]** The attribute to reset. Warning: You can only reset the following attributes: "kernel" | "ramdisk" | "sourceDestCheck". Returns: None **Examples** This example resets the sourceDestCheck attribute for the specified instance. response = client.reset_instance_attribute( Attribute='sourceDestCheck', InstanceId='i-1234567890abcdef0', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_spot_fleet_requests describe_spot_fleet_requests **************************** EC2.Client.describe_spot_fleet_requests(**kwargs) Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated. See also: AWS API Documentation **Request Syntax** response = client.describe_spot_fleet_requests( DryRun=True|False, SpotFleetRequestIds=[ 'string', ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotFleetRequestIds** (*list*) -- The IDs of the Spot Fleet requests. * *(string) --* * **NextToken** (*string*) -- The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'SpotFleetRequestConfigs': [ { 'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled', 'CreateTime': datetime(2015, 1, 1), 'SpotFleetRequestConfig': { 'AllocationStrategy': 'lowestPrice'|'diversified'|'capacityOptimized'|'capacityOptimizedPrioritized'|'priceCapacityOptimized', 'OnDemandAllocationStrategy': 'lowestPrice'|'prioritized', 'SpotMaintenanceStrategies': { 'CapacityRebalance': { 'ReplacementStrategy': 'launch'|'launch-before-terminate', 'TerminationDelay': 123 } }, 'ClientToken': 'string', 'ExcessCapacityTerminationPolicy': 'noTermination'|'default', 'FulfilledCapacity': 123.0, 'OnDemandFulfilledCapacity': 123.0, 'IamFleetRole': 'string', 'LaunchSpecifications': [ { 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SpotPrice': 'string', 'SubnetId': 'string', 'UserData': 'string', 'WeightedCapacity': 123.0, 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ] }, ], 'LaunchTemplateConfigs': [ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'SpotPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } } }, ] }, ], 'SpotPrice': 'string', 'TargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'OnDemandMaxTotalPrice': 'string', 'SpotMaxTotalPrice': 'string', 'TerminateInstancesWithExpiration': True|False, 'Type': 'request'|'maintain'|'instant', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'ReplaceUnhealthyInstances': True|False, 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate', 'LoadBalancersConfig': { 'ClassicLoadBalancersConfig': { 'ClassicLoadBalancers': [ { 'Name': 'string' }, ] }, 'TargetGroupsConfig': { 'TargetGroups': [ { 'Arn': 'string' }, ] } }, 'InstancePoolsToUseCount': 123, 'Context': 'string', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units', 'TagSpecifications': [ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] }, 'SpotFleetRequestId': 'string', 'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeSpotFleetRequests. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **SpotFleetRequestConfigs** *(list) --* Information about the configuration of your Spot Fleet. * *(dict) --* Describes a Spot Fleet request. * **ActivityStatus** *(string) --* The progress of the Spot Fleet request. If there is an error, the status is "error". After all requests are placed, the status is "pending_fulfillment". If the size of the fleet is equal to or greater than its target capacity, the status is "fulfilled". If the size of the fleet is decreased, the status is "pending_termination" while Spot Instances are terminating. * **CreateTime** *(datetime) --* The creation date and time of the request. * **SpotFleetRequestConfig** *(dict) --* The configuration of the Spot Fleet request. * **AllocationStrategy** *(string) --* The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the *Amazon EC2 User Guide*. priceCapacityOptimized (recommended) Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools. capacityOptimized Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use "capacityOptimizedPrioritized". Set a priority for each instance type by using the "Priority" parameter for "LaunchTemplateOverrides". You can assign the same priority to different "LaunchTemplateOverrides". EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. "capacityOptimizedPrioritized" is supported only if your Spot Fleet uses a launch template. Note that if the "OnDemandAllocationStrategy" is set to "prioritized", the same priority is applied when fulfilling On-Demand capacity. diversified Spot Fleet requests instances from all of the Spot Instance pools that you specify. lowestPrice (not recommended) Warning: We don't recommend the "lowestPrice" allocation strategy because it has the highest risk of interruption for your Spot Instances. Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates. Default: "lowestPrice" * **OnDemandAllocationStrategy** *(string) --* The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify "lowestPrice", Spot Fleet uses price to determine the order, launching the lowest price first. If you specify "prioritized", Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to "lowestPrice". * **SpotMaintenanceStrategies** *(dict) --* The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. * **CapacityRebalance** *(dict) --* The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the *Amazon EC2 User Guide*. * **ReplacementStrategy** *(string) --* The replacement strategy to use. Only available for fleets of type "maintain". "launch" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running. "launch-before-terminate" - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in "TerminationDelay"), terminates the instances that received a rebalance notification. * **TerminationDelay** *(integer) --* The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance. Required when "ReplacementStrategy" is set to "launch-before-terminate". Not valid when "ReplacementStrategy" is set to "launch". Valid values: Minimum value of "120" seconds. Maximum value of "7200" seconds. * **ClientToken** *(string) --* A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency. * **ExcessCapacityTerminationPolicy** *(string) --* Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. Supported only for fleets of type "maintain". * **FulfilledCapacity** *(float) --* The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. * **OnDemandFulfilledCapacity** *(float) --* The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. * **IamFleetRole** *(string) --* The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the *Amazon EC2 User Guide*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set "TerminateInstancesWithExpiration". * **LaunchSpecifications** *(list) --* The launch specifications for the Spot Fleet request. If you specify "LaunchSpecifications", you can't specify "LaunchTemplateConfigs". If you include On- Demand capacity in your request, you must use "LaunchTemplateConfigs". Note: If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type "maintain", the target capacity will not be maintained. * *(dict) --* Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use "SpotFleetLaunchSpecification"; you must use LaunchTemplateConfig. * **AddressingType** *(string) --* Deprecated. * **BlockDeviceMappings** *(list) --* One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **EbsOptimized** *(boolean) --* Indicates whether the instances are optimized for 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. Default: "false" * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **ImageId** *(string) --* The ID of the AMI. * **InstanceType** *(string) --* The instance type. * **KernelId** *(string) --* The ID of the kernel. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* Enable or disable monitoring for the instances. * **Enabled** *(boolean) --* Enables monitoring for the instance. Default: "false" * **NetworkInterfaces** *(list) --* The network interfaces. Note: "SpotFleetLaunchSpecification" does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead. * *(dict) --* Describes a network interface. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is "true". Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* If set to "true", the interface is deleted when the instance is terminated. You can specify "true" only if creating a new network interface when launching an instance. * **Description** *(string) --* The description of the network interface. Applies only if creating a network interface when launching an instance. * **DeviceIndex** *(integer) --* The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index. * **Groups** *(list) --* The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. * *(string) --* * **Ipv6AddressCount** *(integer) --* A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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. * **Ipv6Addresses** *(list) --* The IPv6 addresses to assign to the 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the "PrivateIpAddress" parameter. * **SubnetId** *(string) --* The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the *Amazon Web Services Wavelength Developer Guide*. * **InterfaceType** *(string) --* The type of network interface. If you specify "efa-only", do not assign any IP addresses to the network interface. EFA- only network interfaces do not support IP addresses. Valid values: "interface" | "efa" | "efa-only" * **NetworkCardIndex** *(integer) --* 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. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances. * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv4PrefixCount" option. * *(dict) --* Describes the IPv4 prefix option for a network interface. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv4Prefix" option. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv6PrefixCount" option. * *(dict) --* Describes the IPv6 prefix option for a network interface. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv6Prefix" option. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Specifies the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Specifies whether ENA Express is enabled for the network interface when you launch an instance. * **EnaSrdUdpSpecification** *(dict) --* Contains ENA Express settings for UDP network traffic for the network interface attached to the instance. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set **EnaSrdEnabled** in the **EnaSrdSpecificationRequest** to "true". * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **Placement** *(dict) --* The placement information. * **AvailabilityZone** *(string) --* The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b". * **GroupName** *(string) --* The name of the placement group. * **Tenancy** *(string) --* The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of "dedicated" runs on single-tenant hardware. The "host" tenancy is not supported for Spot Instances. * **RamdiskId** *(string) --* The ID of the RAM disk. 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, refer to the Amazon Web Services Resource Center and search for the kernel ID. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet- 1234abcdeexample1, subnet-0987cdef6example2". If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter. * **UserData** *(string) --* The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **TagSpecifications** *(list) --* The tags to apply during creation. * *(dict) --* The tags for a Spot Fleet resource. * **ResourceType** *(string) --* The type of resource. Currently, the only resource type that is supported is "instance". To tag the Spot Fleet request on creation, use the "TagSpecifications" parameter in >>``<>``<<. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "M axSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPric e** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "M axSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SecurityGroups** *(list) --* The security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **LaunchTemplateConfigs** *(list) --* The launch template and overrides. If you specify "LaunchTemplateConfigs", you can't specify "LaunchSpecifications". If you include On-Demand capacity in your request, you must use "LaunchTemplateConfigs". * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template to use. Make sure that the launch template does not contain the "NetworkInterfaceId" parameter because you can't specify a network interface ID in a Spot Fleet. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowestPrice" and "priceCapacityOptimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If "OnDemandAllocationStrategy" is set to "prioritized", Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacityOptimizedPrioritized", Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides. * **InstanceRequirements** *(dict) --* The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web- services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per- instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDeman dPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice ** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On- Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web- services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemand Price** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDeman dPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in- 24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetIn stanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **SpotPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **TargetCapacity** *(integer) --* The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **OnDemandMaxTotalPrice** *(string) --* The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the "onDemandMaxTotalPrice" parameter, the "spotMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "onDemandMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "onDemandMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **SpotMaxTotalPrice** *(string) --* The maximum amount per hour for Spot Instances that you're willing to pay. You can use the "spotMaxTotalPrice" parameter, the "onDemandMaxTotalPrice" parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. Note: If your fleet includes T instances that are configured as "unlimited", and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The "spotMaxTotalPrice" does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for "spotMaxTotalPrice". For more information, see Surplus credits can incur charges in the *Amazon EC2 User Guide*. * **TerminateInstancesWithExpiration** *(boolean) --* Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. * **Type** *(string) --* The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is "request", the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is "maintain", the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: "maintain". "instant" is listed but is not used by Spot Fleet. * **ValidFrom** *(datetime) --* The start date and time of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<Consumers of the endpoint service can use the private name only when the state is "verified". * **Type** *(string) --* The endpoint service verification type, for example TXT. * **Value** *(string) --* The value the service provider adds to the private DNS name domain record before verification. * **Name** *(string) --* The name of the record subdomain the service provider needs to create. The service provider adds the "value" text to the "name". * **PayerResponsibility** *(string) --* The payer responsibility. * **Tags** *(list) --* The tags assigned to the service. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SupportedRegions** *(list) --* The supported Regions. * *(dict) --* Describes a supported Region. * **Region** *(string) --* The Region code. * **ServiceState** *(string) --* The service state. The possible values are "Pending", "Available", "Deleting", "Deleted", "Failed", and "Closed". * **RemoteAccessEnabled** *(boolean) --* Indicates whether consumers can access the service from a Region other than the Region where the service is hosted. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. EC2 / Client / delete_flow_logs delete_flow_logs **************** EC2.Client.delete_flow_logs(**kwargs) Deletes one or more flow logs. See also: AWS API Documentation **Request Syntax** response = client.delete_flow_logs( DryRun=True|False, FlowLogIds=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FlowLogIds** (*list*) -- **[REQUIRED]** One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **Unsuccessful** *(list) --* Information about the flow logs that could not be deleted successfully. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / modify_instance_attribute modify_instance_attribute ************************* EC2.Client.modify_instance_attribute(**kwargs) Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. >>**<>**< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Tags': [ { 'Key': 'string', 'ResourceId': 'string', 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The tag key. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. * **Value** *(string) --* The tag value. **Examples** This example describes the tags for the specified instance. response = client.describe_tags( Filters=[ { 'Name': 'resource-id', 'Values': [ 'i-1234567890abcdef8', ], }, ], ) print(response) Expected Output: { 'Tags': [ { 'Key': 'Stack', 'ResourceId': 'i-1234567890abcdef8', 'ResourceType': 'instance', 'Value': 'test', }, { 'Key': 'Name', 'ResourceId': 'i-1234567890abcdef8', 'ResourceType': 'instance', 'Value': 'Beta Server', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / disassociate_route_table disassociate_route_table ************************ EC2.Client.disassociate_route_table(**kwargs) Disassociates a subnet or gateway from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.disassociate_route_table( DryRun=True|False, AssociationId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AssociationId** (*string*) -- **[REQUIRED]** The association ID representing the current association between the route table and subnet or gateway. Returns: None **Examples** This example disassociates the specified route table from its associated subnet. response = client.disassociate_route_table( AssociationId='rtbassoc-781d0d1a', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_vpc_endpoint_service_configurations delete_vpc_endpoint_service_configurations ****************************************** EC2.Client.delete_vpc_endpoint_service_configurations(**kwargs) Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any "Available" or "PendingAcceptance" interface endpoint connections that are attached to the service. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_endpoint_service_configurations( DryRun=True|False, ServiceIds=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ServiceIds** (*list*) -- **[REQUIRED]** The IDs of the services. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **Unsuccessful** *(list) --* Information about the service configurations that were not deleted, if applicable. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / replace_image_criteria_in_allowed_images_settings replace_image_criteria_in_allowed_images_settings ************************************************* EC2.Client.replace_image_criteria_in_allowed_images_settings(**kwargs) Sets or replaces the criteria for Allowed AMIs. Note: The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.replace_image_criteria_in_allowed_images_settings( ImageCriteria=[ { 'ImageProviders': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **ImageCriteria** (*list*) -- The list of criteria that are evaluated to determine whether AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. * *(dict) --* The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers. Up to 10 "imageCriteria" objects can be specified, and up to a total of 200 values for all "imageProviders". For more information, see JSON configuration for the Allowed AMIs criteria in the *Amazon EC2 User Guide*. * **ImageProviders** *(list) --* A list of image providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified. Possible values: "amazon": Allow AMIs created by Amazon Web Services. "aws-marketplace": Allow AMIs created by verified providers in the Amazon Web Services Marketplace. "aws-backup-vault": Allow AMIs created by Amazon Web Services Backup. 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified. "none": Allow AMIs created by your own account only. When "none" is specified, no other values can be specified. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'ReturnValue': True|False } **Response Structure** * *(dict) --* * **ReturnValue** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / run_instances run_instances ************* EC2.Client.run_instances(**kwargs) Launches the specified number of instances using an AMI for which you have permissions. You can specify a number of options, or leave the default options. The following rules apply: * If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request. * All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet. * Not all instance types support IPv6 addresses. For more information, see Instance types. * If you don't specify a security group ID, we use the default security group for the VPC. For more information, see Security groups. * If any of the AMIs have a product code attached for which the user has not subscribed, the request fails. You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters. To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances. "RunInstances" is subject to both request rate limiting and resource rate limiting. For more information, see Request throttling. An instance is ready for you to use when it's in the "running" state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources. Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs. For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance. See also: AWS API Documentation **Request Syntax** response = client.run_instances( BlockDeviceMappings=[ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], ImageId='string', InstanceType='a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', Ipv6AddressCount=123, Ipv6Addresses=[ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], KernelId='string', KeyName='string', MaxCount=123, MinCount=123, Monitoring={ 'Enabled': True|False }, Placement={ 'Affinity': 'string', 'GroupName': 'string', 'PartitionNumber': 123, 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'GroupId': 'string', 'AvailabilityZone': 'string' }, RamdiskId='string', SecurityGroupIds=[ 'string', ], SecurityGroups=[ 'string', ], SubnetId='string', UserData='string', ElasticGpuSpecification=[ { 'Type': 'string' }, ], ElasticInferenceAccelerators=[ { 'Type': 'string', 'Count': 123 }, ], TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], LaunchTemplate={ 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, InstanceMarketOptions={ 'MarketType': 'spot'|'capacity-block', 'SpotOptions': { 'MaxPrice': 'string', 'SpotInstanceType': 'one-time'|'persistent', 'BlockDurationMinutes': 123, 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' } }, CreditSpecification={ 'CpuCredits': 'string' }, CpuOptions={ 'CoreCount': 123, 'ThreadsPerCore': 123, 'AmdSevSnp': 'enabled'|'disabled' }, CapacityReservationSpecification={ 'CapacityReservationPreference': 'capacity-reservations-only'|'open'|'none', 'CapacityReservationTarget': { 'CapacityReservationId': 'string', 'CapacityReservationResourceGroupArn': 'string' } }, HibernationOptions={ 'Configured': True|False }, LicenseSpecifications=[ { 'LicenseConfigurationArn': 'string' }, ], MetadataOptions={ 'HttpTokens': 'optional'|'required', 'HttpPutResponseHopLimit': 123, 'HttpEndpoint': 'disabled'|'enabled', 'HttpProtocolIpv6': 'disabled'|'enabled', 'InstanceMetadataTags': 'disabled'|'enabled' }, EnclaveOptions={ 'Enabled': True|False }, PrivateDnsNameOptions={ 'HostnameType': 'ip-name'|'resource-name', 'EnableResourceNameDnsARecord': True|False, 'EnableResourceNameDnsAAAARecord': True|False }, MaintenanceOptions={ 'AutoRecovery': 'disabled'|'default' }, DisableApiStop=True|False, EnablePrimaryIpv6=True|False, NetworkPerformanceOptions={ 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' }, Operator={ 'Principal': 'string' }, DryRun=True|False, DisableApiTermination=True|False, InstanceInitiatedShutdownBehavior='stop'|'terminate', PrivateIpAddress='string', ClientToken='string', AdditionalInfo='string', NetworkInterfaces=[ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], IamInstanceProfile={ 'Arn': 'string', 'Name': 'string' }, EbsOptimized=True|False ) Parameters: * **BlockDeviceMappings** (*list*) -- The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the *Amazon EC2 User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **ImageId** (*string*) -- The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. * **InstanceType** (*string*) -- The instance type. For more information, see Amazon EC2 Instance Types Guide. * **Ipv6AddressCount** (*integer*) -- 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. * **Ipv6Addresses** (*list*) -- 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **KernelId** (*string*) -- The ID of the kernel. Warning: 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** (*string*) -- The name of the key pair. For more information, see Create a key pair for your EC2 instance. Warning: 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. * **MaxCount** (*integer*) -- **[REQUIRED]** The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count. Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas. * **MinCount** (*integer*) -- **[REQUIRED]** The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances. Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas. * **Monitoring** (*dict*) -- Specifies whether detailed monitoring is enabled for the instance. * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **Placement** (*dict*) -- The placement for the instance. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. * **RamdiskId** (*string*) -- 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 Amazon Web Services Resource Center and search for the kernel ID. Warning: 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*. * **SecurityGroupIds** (*list*) -- The IDs of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. * *(string) --* * **SecurityGroups** (*list*) -- [Default VPC] The names of the security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter. Default: Amazon EC2 uses the default security group. * *(string) --* * **SubnetId** (*string*) -- 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 instead of using this parameter. * **UserData** (*string*) -- The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Run commands at launch using instance user data. **This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.** * **ElasticGpuSpecification** (*list*) -- An elastic GPU to associate with the instance. Note: Amazon Elastic Graphics reached end of life on January 8, 2024. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. A specification for an Elastic Graphics accelerator. * **Type** *(string) --* **[REQUIRED]** The type of Elastic Graphics accelerator. * **ElasticInferenceAccelerators** (*list*) -- An elastic inference accelerator to associate with the instance. Note: Amazon Elastic Inference is no longer available. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes an elastic inference accelerator. * **Type** *(string) --* **[REQUIRED]** The type of elastic inference accelerator. The possible values are "eia1.medium", "eia1.large", "eia1.xlarge", "eia2.medium", "eia2.large", and "eia2.xlarge". * **Count** *(integer) --* The number of elastic inference accelerators to attach to the instance. Default: 1 * **TagSpecifications** (*list*) -- The tags to apply to the resources that are created during instance launch. You can specify tags for the following resources only: * Instances * Volumes * Spot Instance requests * Network interfaces To tag a resource after it has been created, see CreateTags. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **LaunchTemplate** (*dict*) -- The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". A value of "$Latest" uses the latest version of the launch template. A value of "$Default" uses the default version of the launch template. Default: The default version of the launch template. * **InstanceMarketOptions** (*dict*) -- 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". * **MarketType** *(string) --* The market type. * **SpotOptions** *(dict) --* The options for Spot Instances. * **MaxPrice** *(string) --* The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message. * **SpotInstanceType** *(string) --* The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either "hibernate" or "stop". * **BlockDurationMinutes** *(integer) --* Deprecated. * **ValidUntil** *(datetime) --* The end date of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token to request the next page of results. * **MaxResults** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'LaunchTemplates': [ { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersionNumber': 123, 'LatestVersionNumber': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LaunchTemplates** *(list) --* Information about the launch templates. * *(dict) --* Describes a launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **CreateTime** *(datetime) --* The time launch template was created. * **CreatedBy** *(string) --* The principal that created the launch template. * **DefaultVersionNumber** *(integer) --* The version number of the default version of the launch template. * **LatestVersionNumber** *(integer) --* The version number of the latest version of the launch template. * **Tags** *(list) --* The tags for the launch template. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. **Examples** This example describes the specified launch template. response = client.describe_launch_templates( LaunchTemplateIds=[ 'lt-01238c059e3466abc', ], ) print(response) Expected Output: { 'LaunchTemplates': [ { 'CreateTime': datetime(2018, 1, 16, 4, 32, 57, 1, 16, 0), 'CreatedBy': 'arn:aws:iam::123456789012:root', 'DefaultVersionNumber': 1, 'LatestVersionNumber': 1, 'LaunchTemplateId': 'lt-01238c059e3466abc', 'LaunchTemplateName': 'my-template', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_locked_snapshots describe_locked_snapshots ************************* EC2.Client.describe_locked_snapshots(**kwargs) Describes the lock status for a snapshot. See also: AWS API Documentation **Request Syntax** response = client.describe_locked_snapshots( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', SnapshotIds=[ 'string', ], DryRun=True|False ) Parameters: * **Filters** (*list*) -- The filters. * "lock-state" - The state of the snapshot lock ( "compliance- cooloff" | "governance" | "compliance" | "expired"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **SnapshotIds** (*list*) -- The IDs of the snapshots for which to view the lock status. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Snapshots': [ { 'OwnerId': 'string', 'SnapshotId': 'string', 'LockState': 'compliance'|'governance'|'compliance-cooloff'|'expired', 'LockDuration': 123, 'CoolOffPeriod': 123, 'CoolOffPeriodExpiresOn': datetime(2015, 1, 1), 'LockCreatedOn': datetime(2015, 1, 1), 'LockDurationStartTime': datetime(2015, 1, 1), 'LockExpiresOn': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Snapshots** *(list) --* Information about the snapshots. * *(dict) --* Information about a locked snapshot. * **OwnerId** *(string) --* The account ID of the Amazon Web Services account that owns the snapshot. * **SnapshotId** *(string) --* The ID of the snapshot. * **LockState** *(string) --* The state of the snapshot lock. Valid states include: * "compliance-cooloff" - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions. * "governance" - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions. * "compliance" - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions. * "expired" - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted. * **LockDuration** *(integer) --* The period of time for which the snapshot is locked, in days. * **CoolOffPeriod** *(integer) --* The compliance mode cooling-off period, in hours. * **CoolOffPeriodExpiresOn** *(datetime) --* The date and time at which the compliance mode cooling- off period expires, in the UTC time zone ( "YYYY-MM- DDThh:mm:ss.sssZ"). * **LockCreatedOn** *(datetime) --* The date and time at which the snapshot was locked, in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). * **LockDurationStartTime** *(datetime) --* The date and time at which the lock duration started, in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). If you lock a snapshot that is in the "pending" state, the lock duration starts only once the snapshot enters the "completed" state. * **LockExpiresOn** *(datetime) --* The date and time at which the lock will expire, in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / describe_ipam_resource_discovery_associations describe_ipam_resource_discovery_associations ********************************************* EC2.Client.describe_ipam_resource_discovery_associations(**kwargs) Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM.. See also: AWS API Documentation **Request Syntax** response = client.describe_ipam_resource_discovery_associations( DryRun=True|False, IpamResourceDiscoveryAssociationIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryAssociationIds** (*list*) -- The resource discovery association IDs. * *(string) --* * **NextToken** (*string*) -- Specify the pagination token from a previous request to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of resource discovery associations to return in one page of results. * **Filters** (*list*) -- The resource discovery association filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'IpamResourceDiscoveryAssociations': [ { 'OwnerId': 'string', 'IpamResourceDiscoveryAssociationId': 'string', 'IpamResourceDiscoveryAssociationArn': 'string', 'IpamResourceDiscoveryId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'IsDefault': True|False, 'ResourceDiscoveryStatus': 'active'|'not-found', 'State': 'associate-in-progress'|'associate-complete'|'associate-failed'|'disassociate-in-progress'|'disassociate-complete'|'disassociate-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IpamResourceDiscoveryAssociations** *(list) --* The resource discovery associations. * *(dict) --* An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery. * **OwnerId** *(string) --* The Amazon Web Services account ID of the resource discovery owner. * **IpamResourceDiscoveryAssociationId** *(string) --* The resource discovery association ID. * **IpamResourceDiscoveryAssociationArn** *(string) --* The resource discovery association Amazon Resource Name (ARN). * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **IpamId** *(string) --* The IPAM ID. * **IpamArn** *(string) --* The IPAM ARN. * **IpamRegion** *(string) --* The IPAM home Region. * **IsDefault** *(boolean) --* Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM. * **ResourceDiscoveryStatus** *(string) --* The resource discovery status. * "active" - Connection or permissions required to read the results of the resource discovery are intact. * "not-found" - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact. * **State** *(string) --* The lifecycle state of the association when you associate or disassociate a resource discovery. * "associate-in-progress" - Resource discovery is being associated. * "associate-complete" - Resource discovery association is complete. * "associate-failed" - Resource discovery association has failed. * "disassociate-in-progress" - Resource discovery is being disassociated. * "disassociate-complete" - Resource discovery disassociation is complete. * "disassociate-failed" - Resource discovery disassociation has failed. * "isolate-in-progress" - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated. * "isolate-complete" - Resource discovery isolation is complete.. * "restore-in-progress" - Resource discovery is being restored. * **Tags** *(list) --* A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* Specify the pagination token from a previous request to retrieve the next page of results. EC2 / Client / create_transit_gateway_route_table_announcement create_transit_gateway_route_table_announcement *********************************************** EC2.Client.create_transit_gateway_route_table_announcement(**kwargs) Advertises a new transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.create_transit_gateway_route_table_announcement( TransitGatewayRouteTableId='string', PeeringAttachmentId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **PeeringAttachmentId** (*string*) -- **[REQUIRED]** The ID of the peering attachment. * **TagSpecifications** (*list*) -- The tags specifications applied to the transit gateway route table announcement. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTableAnnouncement': { 'TransitGatewayRouteTableAnnouncementId': 'string', 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'PeerTransitGatewayId': 'string', 'PeerCoreNetworkId': 'string', 'PeeringAttachmentId': 'string', 'AnnouncementDirection': 'outgoing'|'incoming', 'TransitGatewayRouteTableId': 'string', 'State': 'available'|'pending'|'failing'|'failed'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayRouteTableAnnouncement** *(dict) --* Provides details about the transit gateway route table announcement. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network for the transit gateway route table announcement. * **PeerTransitGatewayId** *(string) --* The ID of the peer transit gateway. * **PeerCoreNetworkId** *(string) --* The ID of the core network ID for the peer. * **PeeringAttachmentId** *(string) --* The ID of the peering attachment. * **AnnouncementDirection** *(string) --* The direction for the route table announcement. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **State** *(string) --* The state of the transit gateway announcement. * **CreationTime** *(datetime) --* The timestamp when the transit gateway route table announcement was created. * **Tags** *(list) --* The key-value pairs associated with the route table announcement. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_transit_gateway_policy_tables describe_transit_gateway_policy_tables ************************************** EC2.Client.describe_transit_gateway_policy_tables(**kwargs) Describes one or more transit gateway route policy tables. See also: AWS API Documentation **Request Syntax** response = client.describe_transit_gateway_policy_tables( TransitGatewayPolicyTableIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayPolicyTableIds** (*list*) -- The IDs of the transit gateway policy tables. * *(string) --* * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPolicyTables': [ { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayPolicyTables** *(list) --* Describes the transit gateway policy tables. * *(dict) --* Describes a transit gateway policy table. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway policy table * **CreationTime** *(datetime) --* The timestamp when the transit gateway policy table was created. * **Tags** *(list) --* he key-value pairs associated with the transit gateway policy table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token for the next page of results. EC2 / Client / disassociate_enclave_certificate_iam_role disassociate_enclave_certificate_iam_role ***************************************** EC2.Client.disassociate_enclave_certificate_iam_role(**kwargs) Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate. See also: AWS API Documentation **Request Syntax** response = client.disassociate_enclave_certificate_iam_role( CertificateArn='string', RoleArn='string', DryRun=True|False ) Parameters: * **CertificateArn** (*string*) -- **[REQUIRED]** The ARN of the ACM certificate from which to disassociate the IAM role. * **RoleArn** (*string*) -- **[REQUIRED]** The ARN of the IAM role to disassociate. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / export_transit_gateway_routes export_transit_gateway_routes ***************************** EC2.Client.export_transit_gateway_routes(**kwargs) Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range. The routes are saved to the specified bucket in a JSON file. For more information, see Export route tables to Amazon S3 in the *Amazon Web Services Transit Gateways Guide*. See also: AWS API Documentation **Request Syntax** response = client.export_transit_gateway_routes( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], S3Bucket='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. * **Filters** (*list*) -- 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"). * "transit-gateway-route-destination-cidr-block" - The CIDR range. * "type" - The type of route ( "propagated" | "static"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **S3Bucket** (*string*) -- **[REQUIRED]** The name of the S3 bucket. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'S3Location': 'string' } **Response Structure** * *(dict) --* * **S3Location** *(string) --* The URL of the exported file in Amazon S3. For example, s3: //*bucket_name*/VPCTransitGateway/TransitGatewayRouteTables /*file_name*. EC2 / Client / enable_aws_network_performance_metric_subscription enable_aws_network_performance_metric_subscription ************************************************** EC2.Client.enable_aws_network_performance_metric_subscription(**kwargs) Enables Infrastructure Performance subscriptions. See also: AWS API Documentation **Request Syntax** response = client.enable_aws_network_performance_metric_subscription( Source='string', Destination='string', Metric='aggregate-latency', Statistic='p50', DryRun=True|False ) Parameters: * **Source** (*string*) -- The source Region (like "us-east-1") or Availability Zone ID (like "use1-az1") that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region. * **Destination** (*string*) -- The target Region (like "us- east-2") or Availability Zone ID (like "use2-az2") that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region. * **Metric** (*string*) -- The metric used for the enabled subscription. * **Statistic** (*string*) -- The statistic used for the enabled subscription. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Output': True|False } **Response Structure** * *(dict) --* * **Output** *(boolean) --* Indicates whether the subscribe action was successful. EC2 / Client / describe_traffic_mirror_filters describe_traffic_mirror_filters ******************************* EC2.Client.describe_traffic_mirror_filters(**kwargs) Describes one or more Traffic Mirror filters. See also: AWS API Documentation **Request Syntax** response = client.describe_traffic_mirror_filters( TrafficMirrorFilterIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **TrafficMirrorFilterIds** (*list*) -- The ID of the Traffic Mirror filter. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'TrafficMirrorFilters': [ { 'TrafficMirrorFilterId': 'string', 'IngressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'EgressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NetworkServices': [ 'amazon-dns', ], 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TrafficMirrorFilters** *(list) --* Information about one or more Traffic Mirror filters. * *(dict) --* Describes the Traffic Mirror filter. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter. * **IngressFilterRules** *(list) --* Information about the ingress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **EgressFilterRules** *(list) --* Information about the egress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NetworkServices** *(list) --* The network service traffic that is associated with the Traffic Mirror filter. * *(string) --* * **Description** *(string) --* The description of the Traffic Mirror filter. * **Tags** *(list) --* The tags assigned to the Traffic Mirror filter. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. The value is "null" when there are no more results to return. EC2 / Client / create_replace_root_volume_task create_replace_root_volume_task ******************************* EC2.Client.create_replace_root_volume_task(**kwargs) Replaces the EBS-backed root volume for a "running" instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance. For more information, see Replace a root volume in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_replace_root_volume_task( InstanceId='string', SnapshotId='string', ClientToken='string', DryRun=True|False, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ImageId='string', DeleteReplacedRootVolume=True|False, VolumeInitializationRate=123 ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance for which to replace the root volume. * **SnapshotId** (*string*) -- The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter. * **ClientToken** (*string*) -- 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. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The tags to apply to the root volume replacement task. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ImageId** (*string*) -- The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter. * **DeleteReplacedRootVolume** (*boolean*) -- Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify "true". If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it. * **VolumeInitializationRate** (*integer*) -- Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. Valid range: 100 - 300 MiB/s Return type: dict Returns: **Response Syntax** { 'ReplaceRootVolumeTask': { 'ReplaceRootVolumeTaskId': 'string', 'InstanceId': 'string', 'TaskState': 'pending'|'in-progress'|'failing'|'succeeded'|'failed'|'failed-detached', 'StartTime': 'string', 'CompleteTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ImageId': 'string', 'SnapshotId': 'string', 'DeleteReplacedRootVolume': True|False } } **Response Structure** * *(dict) --* * **ReplaceRootVolumeTask** *(dict) --* Information about the root volume replacement task. * **ReplaceRootVolumeTaskId** *(string) --* The ID of the root volume replacement task. * **InstanceId** *(string) --* The ID of the instance for which the root volume replacement task was created. * **TaskState** *(string) --* The state of the task. The task can be in one of the following states: * "pending" - the replacement volume is being created. * "in-progress" - the original volume is being detached and the replacement volume is being attached. * "succeeded" - the replacement volume has been successfully attached to the instance and the instance is available. * "failing" - the replacement task is in the process of failing. * "failed" - the replacement task has failed but the original root volume is still attached. * "failing-detached" - the replacement task is in the process of failing. The instance might have no root volume attached. * "failed-detached" - the replacement task has failed and the instance has no root volume attached. * **StartTime** *(string) --* The time the task was started. * **CompleteTime** *(string) --* The time the task completed. * **Tags** *(list) --* The tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ImageId** *(string) --* The ID of the AMI used to create the replacement root volume. * **SnapshotId** *(string) --* The ID of the snapshot used to create the replacement root volume. * **DeleteReplacedRootVolume** *(boolean) --* Indicates whether the original root volume is to be deleted after the root volume replacement task completes. EC2 / Client / list_images_in_recycle_bin list_images_in_recycle_bin ************************** EC2.Client.list_images_in_recycle_bin(**kwargs) Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.list_images_in_recycle_bin( ImageIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **ImageIds** (*list*) -- The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Images': [ { 'ImageId': 'string', 'Name': 'string', 'Description': 'string', 'RecycleBinEnterTime': datetime(2015, 1, 1), 'RecycleBinExitTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Images** *(list) --* Information about the AMIs. * *(dict) --* Information about an AMI that is currently in the Recycle Bin. * **ImageId** *(string) --* The ID of the AMI. * **Name** *(string) --* The name of the AMI. * **Description** *(string) --* The description of the AMI. * **RecycleBinEnterTime** *(datetime) --* The date and time when the AMI entered the Recycle Bin. * **RecycleBinExitTime** *(datetime) --* The date and time when the AMI is to be permanently deleted from the Recycle Bin. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / describe_transit_gateway_multicast_domains describe_transit_gateway_multicast_domains ****************************************** EC2.Client.describe_transit_gateway_multicast_domains(**kwargs) Describes one or more transit gateway multicast domains. See also: AWS API Documentation **Request Syntax** response = client.describe_transit_gateway_multicast_domains( TransitGatewayMulticastDomainIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainIds** (*list*) -- The ID of the transit gateway multicast domain. * *(string) --* * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayMulticastDomains': [ { 'TransitGatewayMulticastDomainId': 'string', 'TransitGatewayId': 'string', 'TransitGatewayMulticastDomainArn': 'string', 'OwnerId': 'string', 'Options': { 'Igmpv2Support': 'enable'|'disable', 'StaticSourcesSupport': 'enable'|'disable', 'AutoAcceptSharedAssociations': 'enable'|'disable' }, 'State': 'pending'|'available'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayMulticastDomains** *(list) --* Information about the transit gateway multicast domains. * *(dict) --* Describes the transit gateway multicast domain. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **TransitGatewayMulticastDomainArn** *(string) --* The Amazon Resource Name (ARN) of the transit gateway multicast domain. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway multicast domain. * **Options** *(dict) --* The options for the transit gateway multicast domain. * **Igmpv2Support** *(string) --* Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. * **StaticSourcesSupport** *(string) --* Indicates whether support for statically configuring transit gateway multicast group sources is turned on. * **AutoAcceptSharedAssociations** *(string) --* Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. * **State** *(string) --* The state of the transit gateway multicast domain. * **CreationTime** *(datetime) --* The time the transit gateway multicast domain was created. * **Tags** *(list) --* The tags for the transit gateway multicast domain. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / release_address release_address *************** EC2.Client.release_address(**kwargs) Releases the specified Elastic IP address. [Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it. [Nondefault VPC] You must disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error ( "InvalidIPAddress.InUse"). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an "AuthFailure" error if the address is already allocated to another Amazon Web Services account. After you release an Elastic IP address, you might be able to recover it. For more information, see Release an Elastic IP address. See also: AWS API Documentation **Request Syntax** response = client.release_address( AllocationId='string', PublicIp='string', NetworkBorderGroup='string', DryRun=True|False ) Parameters: * **AllocationId** (*string*) -- The allocation ID. This parameter is required. * **PublicIp** (*string*) -- Deprecated. * **NetworkBorderGroup** (*string*) -- The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. If you provide an incorrect network border group, you receive an "InvalidAddress.NotFound" error. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None **Examples** This example releases an Elastic IP address for use with instances in a VPC. response = client.release_address( AllocationId='eipalloc-64d5890a', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example releases an Elastic IP address for use with instances in EC2-Classic. response = client.release_address( PublicIp='198.51.100.0', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / detach_volume detach_volume ************* EC2.Client.detach_volume(**kwargs) Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the "busy" state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance. You can't detach or force detach volumes that are attached to Amazon Web Services-managed resources. Attempting to do this results in the "UnsupportedOperationException" exception. For more information, see Detach an Amazon EBS volume in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.detach_volume( Device='string', Force=True|False, InstanceId='string', VolumeId='string', DryRun=True|False ) Parameters: * **Device** (*string*) -- The device name. * **Force** (*boolean*) -- 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** (*string*) -- The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID. * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the volume. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services-managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. **Examples** This example detaches the volume ("vol-049df61146c4d7901") from the instance it is attached to. response = client.detach_volume( VolumeId='vol-1234567890abcdef0', ) print(response) Expected Output: { 'AttachTime': datetime(2014, 2, 27, 19, 23, 6, 3, 58, 0), 'Device': '/dev/sdb', 'InstanceId': 'i-1234567890abcdef0', 'State': 'detaching', 'VolumeId': 'vol-049df61146c4d7901', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / accept_transit_gateway_multicast_domain_associations accept_transit_gateway_multicast_domain_associations **************************************************** EC2.Client.accept_transit_gateway_multicast_domain_associations(**kwargs) Accepts a request to associate subnets with a transit gateway multicast domain. See also: AWS API Documentation **Request Syntax** response = client.accept_transit_gateway_multicast_domain_associations( TransitGatewayMulticastDomainId='string', TransitGatewayAttachmentId='string', SubnetIds=[ 'string', ], DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- The ID of the transit gateway multicast domain. * **TransitGatewayAttachmentId** (*string*) -- The ID of the transit gateway attachment. * **SubnetIds** (*list*) -- The IDs of the subnets to associate with the transit gateway multicast domain. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Associations': { 'TransitGatewayMulticastDomainId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceOwnerId': 'string', 'Subnets': [ { 'SubnetId': 'string', 'State': 'pendingAcceptance'|'associating'|'associated'|'disassociating'|'disassociated'|'rejected'|'failed' }, ] } } **Response Structure** * *(dict) --* * **Associations** *(dict) --* Information about the multicast domain associations. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource, for example a VPC attachment. * **ResourceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the resource. * **Subnets** *(list) --* The subnets associated with the multicast domain. * *(dict) --* Describes the subnet association with the transit gateway multicast domain. * **SubnetId** *(string) --* The ID of the subnet. * **State** *(string) --* The state of the subnet association. EC2 / Client / describe_network_interface_permissions describe_network_interface_permissions ************************************** EC2.Client.describe_network_interface_permissions(**kwargs) Describes the permissions for your network interfaces. See also: AWS API Documentation **Request Syntax** response = client.describe_network_interface_permissions( NetworkInterfacePermissionIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **NetworkInterfacePermissionIds** (*list*) -- The network interface permission IDs. * *(string) --* * **Filters** (*list*) -- 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 Amazon Web Services account ID. * "network-interface-permission.aws-service" - The Amazon Web Services service. * "network-interface-permission.permission" - The type of permission ( "INSTANCE-ATTACH" | "EIP-ASSOCIATE"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. If this parameter is not specified, up to 50 results are returned by default. For more information, see Pagination. Return type: dict Returns: **Response Syntax** { 'NetworkInterfacePermissions': [ { 'NetworkInterfacePermissionId': 'string', 'NetworkInterfaceId': 'string', 'AwsAccountId': 'string', 'AwsService': 'string', 'Permission': 'INSTANCE-ATTACH'|'EIP-ASSOCIATE', 'PermissionState': { 'State': 'pending'|'granted'|'revoking'|'revoked', 'StatusMessage': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the output for DescribeNetworkInterfacePermissions. * **NetworkInterfacePermissions** *(list) --* The network interface permissions. * *(dict) --* Describes a permission for a network interface. * **NetworkInterfacePermissionId** *(string) --* The ID of the network interface permission. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **AwsAccountId** *(string) --* The Amazon Web Services account ID. * **AwsService** *(string) --* The Amazon Web Services service. * **Permission** *(string) --* The type of permission. * **PermissionState** *(dict) --* Information about the state of the permission. * **State** *(string) --* The state of the permission. * **StatusMessage** *(string) --* A status message, if applicable. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / disable_image_deregistration_protection disable_image_deregistration_protection *************************************** EC2.Client.disable_image_deregistration_protection(**kwargs) Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered. If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI. For more information, see Protect an Amazon EC2 AMI from deregistration in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.disable_image_deregistration_protection( ImageId='string', DryRun=True|False ) Parameters: * **ImageId** (*string*) -- **[REQUIRED]** The ID of the AMI. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': 'string' } **Response Structure** * *(dict) --* * **Return** *(string) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / modify_capacity_reservation modify_capacity_reservation *************************** EC2.Client.modify_capacity_reservation(**kwargs) Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. For more information, see Modify an active Capacity Reservation. The allowed modifications depend on the state of the Capacity Reservation: * "assessing" or "scheduled" state - You can modify the tags only. * "pending" state - You can't modify the Capacity Reservation in any way. * "active" state but still within the commitment duration - You can't decrease the instance count or set an end date that is within the commitment duration. All other modifications are allowed. * "active" state with no commitment duration or elapsed commitment duration - All modifications are allowed. * "expired", "cancelled", "unsupported", or "failed" state - You can't modify the Capacity Reservation in any way. See also: AWS API Documentation **Request Syntax** response = client.modify_capacity_reservation( CapacityReservationId='string', InstanceCount=123, EndDate=datetime(2015, 1, 1), EndDateType='unlimited'|'limited', Accept=True|False, DryRun=True|False, AdditionalInfo='string', InstanceMatchCriteria='open'|'targeted' ) Parameters: * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation. * **InstanceCount** (*integer*) -- The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than "1000" in a single request. * **EndDate** (*datetime*) -- 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** (*string*) -- 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". * **Accept** (*boolean*) -- Reserved. Capacity Reservations you have created are accepted by default. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AdditionalInfo** (*string*) -- Reserved for future use. * **InstanceMatchCriteria** (*string*) -- The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from "targeted" to "open", any running instances that match the attributes of the Capacity Reservation, have the "CapacityReservationPreference" set to "open", and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation. To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage). Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / get_vpn_connection_device_sample_configuration get_vpn_connection_device_sample_configuration ********************************************** EC2.Client.get_vpn_connection_device_sample_configuration(**kwargs) Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection. See also: AWS API Documentation **Request Syntax** response = client.get_vpn_connection_device_sample_configuration( VpnConnectionId='string', VpnConnectionDeviceTypeId='string', InternetKeyExchangeVersion='string', SampleType='string', DryRun=True|False ) Parameters: * **VpnConnectionId** (*string*) -- **[REQUIRED]** The "VpnConnectionId" specifies the Site-to-Site VPN connection used for the sample configuration. * **VpnConnectionDeviceTypeId** (*string*) -- **[REQUIRED]** Device identifier provided by the "GetVpnConnectionDeviceTypes" API. * **InternetKeyExchangeVersion** (*string*) -- The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: "ikev1" or "ikev2". * **SampleType** (*string*) -- The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1). * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VpnConnectionDeviceSampleConfiguration': 'string' } **Response Structure** * *(dict) --* * **VpnConnectionDeviceSampleConfiguration** *(string) --* Sample configuration file for the specified customer gateway device. EC2 / Client / get_transit_gateway_attachment_propagations get_transit_gateway_attachment_propagations ******************************************* EC2.Client.get_transit_gateway_attachment_propagations(**kwargs) Lists the route tables to which the specified resource attachment propagates routes. See also: AWS API Documentation **Request Syntax** response = client.get_transit_gateway_attachment_propagations( TransitGatewayAttachmentId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the attachment. * **Filters** (*list*) -- One or more filters. The possible values are: * "transit-gateway-route-table-id" - The ID of the transit gateway route table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayAttachmentPropagations': [ { 'TransitGatewayRouteTableId': 'string', 'State': 'enabling'|'enabled'|'disabling'|'disabled' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayAttachmentPropagations** *(list) --* Information about the propagation route tables. * *(dict) --* Describes a propagation route table. * **TransitGatewayRouteTableId** *(string) --* The ID of the propagation route table. * **State** *(string) --* The state of the propagation route table. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / associate_route_table associate_route_table ********************* EC2.Client.associate_route_table(**kwargs) Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.associate_route_table( GatewayId='string', DryRun=True|False, SubnetId='string', RouteTableId='string' ) Parameters: * **GatewayId** (*string*) -- The ID of the internet gateway or virtual private gateway. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the subnet. * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. Return type: dict Returns: **Response Syntax** { 'AssociationId': 'string', 'AssociationState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failed', 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **AssociationId** *(string) --* The route table association ID. This ID is required for disassociating the route table. * **AssociationState** *(dict) --* The state of the association. * **State** *(string) --* The state of the association. * **StatusMessage** *(string) --* The status message, if applicable. **Examples** This example associates the specified route table with the specified subnet. response = client.associate_route_table( RouteTableId='rtb-22574640', SubnetId='subnet-9d4a7b6', ) print(response) Expected Output: { 'AssociationId': 'rtbassoc-781d0d1a', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_reserved_instances modify_reserved_instances ************************* EC2.Client.modify_reserved_instances(**kwargs) Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see Modify Reserved Instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_reserved_instances( ReservedInstancesIds=[ 'string', ], ClientToken='string', TargetConfigurations=[ { 'AvailabilityZone': 'string', 'InstanceCount': 123, 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'Platform': 'string', 'Scope': 'Availability Zone'|'Region', 'AvailabilityZoneId': 'string' }, ] ) Parameters: * **ReservedInstancesIds** (*list*) -- **[REQUIRED]** The IDs of the Reserved Instances to modify. * *(string) --* * **ClientToken** (*string*) -- A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. * **TargetConfigurations** (*list*) -- **[REQUIRED]** The configuration settings for the Reserved Instances to modify. * *(dict) --* Describes the configuration settings for the modified Reserved Instances. * **AvailabilityZone** *(string) --* The Availability Zone for the modified Reserved Instances. * **InstanceCount** *(integer) --* The number of modified Reserved Instances. Note: This is a required field for a request. * **InstanceType** *(string) --* The instance type for the modified Reserved Instances. * **Platform** *(string) --* The network platform of the modified Reserved Instances. * **Scope** *(string) --* Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. Return type: dict Returns: **Response Syntax** { 'ReservedInstancesModificationId': 'string' } **Response Structure** * *(dict) --* Contains the output of ModifyReservedInstances. * **ReservedInstancesModificationId** *(string) --* The ID for the modification. EC2 / Client / modify_volume modify_volume ************* EC2.Client.modify_volume(**kwargs) You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes in the *Amazon EBS User Guide*. When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see Extend the file system. For more information, see Monitor the progress of volume modifications in the *Amazon EBS User Guide*. With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. After modifying a volume, you must wait at least six hours and ensure that the volume is in the "in-use" or "available" state before you can modify the same volume. This is sometimes referred to as a cooldown period. See also: AWS API Documentation **Request Syntax** response = client.modify_volume( DryRun=True|False, VolumeId='string', Size=123, VolumeType='standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', Iops=123, Throughput=123, MultiAttachEnabled=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VolumeId** (*string*) -- **[REQUIRED]** The ID of the volume. * **Size** (*integer*) -- 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 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB Default: The existing size is retained. * **VolumeType** (*string*) -- The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. Default: The existing type is retained. * **Iops** (*integer*) -- 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. Default: The existing value is retained if you keep the same volume type. If you change the volume type to "io1", "io2", or "gp3", the default is 3,000. * **Throughput** (*integer*) -- The target throughput of the volume, in MiB/s. This parameter is valid only for "gp3" volumes. The maximum value is 1,000. Default: The existing value is retained if the source and target volume type is "gp3". Otherwise, the default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000. * **MultiAttachEnabled** (*boolean*) -- 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 EBS User Guide*. Return type: dict Returns: **Response Syntax** { 'VolumeModification': { 'VolumeId': 'string', 'ModificationState': 'modifying'|'optimizing'|'completed'|'failed', 'StatusMessage': 'string', 'TargetSize': 123, 'TargetIops': 123, 'TargetVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'TargetThroughput': 123, 'TargetMultiAttachEnabled': True|False, 'OriginalSize': 123, 'OriginalIops': 123, 'OriginalVolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'OriginalThroughput': 123, 'OriginalMultiAttachEnabled': True|False, 'Progress': 123, 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **VolumeModification** *(dict) --* Information about the volume modification. * **VolumeId** *(string) --* The ID of the volume. * **ModificationState** *(string) --* The current modification state. * **StatusMessage** *(string) --* A status message about the modification progress or failure. * **TargetSize** *(integer) --* The target size of the volume, in GiB. * **TargetIops** *(integer) --* The target IOPS rate of the volume. * **TargetVolumeType** *(string) --* The target EBS volume type of the volume. * **TargetThroughput** *(integer) --* The target throughput of the volume, in MiB/s. * **TargetMultiAttachEnabled** *(boolean) --* The target setting for Amazon EBS Multi-Attach. * **OriginalSize** *(integer) --* The original size of the volume, in GiB. * **OriginalIops** *(integer) --* The original IOPS rate of the volume. * **OriginalVolumeType** *(string) --* The original EBS volume type of the volume. * **OriginalThroughput** *(integer) --* The original throughput of the volume, in MiB/s. * **OriginalMultiAttachEnabled** *(boolean) --* The original setting for Amazon EBS Multi-Attach. * **Progress** *(integer) --* The modification progress, from 0 to 100 percent complete. * **StartTime** *(datetime) --* The modification start time. * **EndTime** *(datetime) --* The modification completion or failure time. EC2 / Client / get_ebs_default_kms_key_id get_ebs_default_kms_key_id ************************** EC2.Client.get_ebs_default_kms_key_id(**kwargs) Describes the default KMS key for EBS encryption by default for your account in this Region. For more information, see Amazon EBS encryption in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_ebs_default_kms_key_id( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'KmsKeyId': 'string' } **Response Structure** * *(dict) --* * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the default KMS key for encryption by default. EC2 / Client / enable_image enable_image ************ EC2.Client.enable_image(**kwargs) Re-enables a disabled AMI. The re-enabled AMI is marked as "available" and can be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again. Only the AMI owner can re-enable a disabled AMI. For more information, see Disable an Amazon EC2 AMI in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.enable_image( ImageId='string', DryRun=True|False ) Parameters: * **ImageId** (*string*) -- **[REQUIRED]** The ID of the AMI. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / associate_transit_gateway_policy_table associate_transit_gateway_policy_table ************************************** EC2.Client.associate_transit_gateway_policy_table(**kwargs) Associates the specified transit gateway attachment with a transit gateway policy table. See also: AWS API Documentation **Request Syntax** response = client.associate_transit_gateway_policy_table( TransitGatewayPolicyTableId='string', TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayPolicyTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway policy table to associate with the transit gateway attachment. * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the transit gateway attachment to associate with the policy table. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Association': { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' } } **Response Structure** * *(dict) --* * **Association** *(dict) --* Describes the association of a transit gateway and a transit gateway policy table. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The resource ID of the transit gateway attachment. * **ResourceType** *(string) --* The resource type for the transit gateway policy table association. * **State** *(string) --* The state of the transit gateway policy table association. EC2 / Client / describe_instance_types describe_instance_types *********************** EC2.Client.describe_instance_types(**kwargs) Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results. See also: AWS API Documentation **Request Syntax** response = client.describe_instance_types( DryRun=True|False, InstanceTypes=[ 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceTypes** (*list*) -- The instance types. * *(string) --* * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * "auto-recovery-supported" - Indicates whether Amazon CloudWatch action based recovery is supported ( "true" | "false"). * "bare-metal" - Indicates whether it is a bare metal instance type ( "true" | "false"). * "burstable-performance-supported" - Indicates whether the instance type is a burstable performance T instance type ( "true" | "false"). * "current-generation" - Indicates whether this instance type is the latest generation instance type of an instance family ( "true" | "false"). * "dedicated-hosts-supported" - Indicates whether the instance type supports Dedicated Hosts. ( "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" | "unsupported"). * "ebs-info.nvme-support" - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes ( "required" | "supported" | "unsupported"). * "free-tier-eligible" - A Boolean that indicates whether this instance type can be used under the Amazon Web Services Free Tier ( "true" | "false"). * "hibernation-supported" - Indicates whether On-Demand hibernation is supported ( "true" | "false"). * "hypervisor" - The hypervisor ( "nitro" | "xen"). * "instance-storage-info.disk.count" - The number of local disks. * "instance-storage-info.disk.size-in-gb" - The storage size of each instance storage disk, in GB. * "instance-storage-info.disk.type" - The storage technology for the local instance storage disks ( "hdd" | "ssd"). * "instance-storage-info.encryption-support" - Indicates whether data is encrypted at rest ( "required" | "supported" | "unsupported"). * "instance-storage-info.nvme-support" - Indicates whether non-volatile memory express (NVMe) is supported for instance store ( "required" | "supported" | "unsupported"). * "instance-storage-info.total-size-in-gb" - The total amount of storage available from all local instance storage, in GB. * "instance-storage-supported" - Indicates whether the instance type has local instance storage ( "true" | "false"). * "instance-type" - The instance type (for example "c5.2xlarge" or c5*). * "memory-info.size-in-mib" - The memory size. * "network-info.bandwidth-weightings" - For instances that support bandwidth weighting to boost performance ( "default", "vpc-1", "ebs-1"). * "network-info.efa-info.maximum-efa-interfaces" - The maximum number of Elastic Fabric Adapters (EFAs) per instance. * "network-info.efa-supported" - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) ( "true" | "false"). * "network-info.ena-support" - Indicates whether Elastic Network Adapter (ENA) is supported or required ( "required" | "supported" | "unsupported"). * "network-info.flexible-ena-queues-support" - Indicates whether an instance supports flexible ENA queues ( "supported" | "unsupported"). * "network-info.encryption-in-transit-supported" - Indicates whether the instance type automatically encrypts in-transit traffic between instances ( "true" | "false"). * "network-info.ipv4-addresses-per-interface" - The maximum number of private IPv4 addresses per network interface. * "network-info.ipv6-addresses-per-interface" - The maximum number of private IPv6 addresses per network interface. * "network-info.ipv6-supported" - Indicates whether the instance type supports IPv6 ( "true" | "false"). * "network-info.maximum-network-cards" - The maximum number of network cards per instance. * "network-info.maximum-network-interfaces" - The maximum number of network interfaces per instance. * "network-info.network-performance" - The network performance (for example, "25 Gigabit"). * "nitro-enclaves-support" - Indicates whether Nitro Enclaves is supported ( "supported" | "unsupported"). * "nitro-tpm-support" - Indicates whether NitroTPM is supported ( "supported" | "unsupported"). * "nitro-tpm-info.supported-versions" - The supported NitroTPM version ( "2.0"). * "processor-info.supported-architecture" - The CPU architecture ( "arm64" | "i386" | "x86_64"). * "processor-info.sustained-clock-speed-in-ghz" - The CPU clock speed, in GHz. * "processor-info.supported-features" - The supported CPU features ( "amd-sev-snp"). * "reboot-migration-support" - Indicates whether enabling reboot migration is supported ( "supported" | "unsupported"). * "supported-boot-mode" - The boot mode ( "legacy-bios" | "uefi"). * "supported-root-device-type" - The root device type ( "ebs" | "instance-store"). * "supported-usage-class" - The usage class ( "on-demand" | "spot" | "capacity-block"). * "supported-virtualization-type" - The virtualization type ( "hvm" | "paravirtual"). * "vcpu-info.default-cores" - The default number of cores for the instance type. * "vcpu-info.default-threads-per-core" - The default number of threads per core for the instance type. * "vcpu-info.default-vcpus" - The default number of vCPUs for the instance type. * "vcpu-info.valid-cores" - The number of cores that can be configured for the instance type. * "vcpu-info.valid-threads-per-core" - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'InstanceTypes': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'CurrentGeneration': True|False, 'FreeTierEligible': True|False, 'SupportedUsageClasses': [ 'spot'|'on-demand'|'capacity-block', ], 'SupportedRootDeviceTypes': [ 'ebs'|'instance-store', ], 'SupportedVirtualizationTypes': [ 'hvm'|'paravirtual', ], 'BareMetal': True|False, 'Hypervisor': 'nitro'|'xen', 'ProcessorInfo': { 'SupportedArchitectures': [ 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', ], 'SustainedClockSpeedInGhz': 123.0, 'SupportedFeatures': [ 'amd-sev-snp', ], 'Manufacturer': 'string' }, 'VCpuInfo': { 'DefaultVCpus': 123, 'DefaultCores': 123, 'DefaultThreadsPerCore': 123, 'ValidCores': [ 123, ], 'ValidThreadsPerCore': [ 123, ] }, 'MemoryInfo': { 'SizeInMiB': 123 }, 'InstanceStorageSupported': True|False, 'InstanceStorageInfo': { 'TotalSizeInGB': 123, 'Disks': [ { 'SizeInGB': 123, 'Count': 123, 'Type': 'hdd'|'ssd' }, ], 'NvmeSupport': 'unsupported'|'supported'|'required', 'EncryptionSupport': 'unsupported'|'required' }, 'EbsInfo': { 'EbsOptimizedSupport': 'unsupported'|'supported'|'default', 'EncryptionSupport': 'unsupported'|'supported', 'EbsOptimizedInfo': { 'BaselineBandwidthInMbps': 123, 'BaselineThroughputInMBps': 123.0, 'BaselineIops': 123, 'MaximumBandwidthInMbps': 123, 'MaximumThroughputInMBps': 123.0, 'MaximumIops': 123 }, 'NvmeSupport': 'unsupported'|'supported'|'required' }, 'NetworkInfo': { 'NetworkPerformance': 'string', 'MaximumNetworkInterfaces': 123, 'MaximumNetworkCards': 123, 'DefaultNetworkCardIndex': 123, 'NetworkCards': [ { 'NetworkCardIndex': 123, 'NetworkPerformance': 'string', 'MaximumNetworkInterfaces': 123, 'BaselineBandwidthInGbps': 123.0, 'PeakBandwidthInGbps': 123.0, 'DefaultEnaQueueCountPerInterface': 123, 'MaximumEnaQueueCount': 123, 'MaximumEnaQueueCountPerInterface': 123 }, ], 'Ipv4AddressesPerInterface': 123, 'Ipv6AddressesPerInterface': 123, 'Ipv6Supported': True|False, 'EnaSupport': 'unsupported'|'supported'|'required', 'EfaSupported': True|False, 'EfaInfo': { 'MaximumEfaInterfaces': 123 }, 'EncryptionInTransitSupported': True|False, 'EnaSrdSupported': True|False, 'BandwidthWeightings': [ 'default'|'vpc-1'|'ebs-1', ], 'FlexibleEnaQueuesSupport': 'unsupported'|'supported' }, 'GpuInfo': { 'Gpus': [ { 'Name': 'string', 'Manufacturer': 'string', 'Count': 123, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalGpuMemoryInMiB': 123 }, 'FpgaInfo': { 'Fpgas': [ { 'Name': 'string', 'Manufacturer': 'string', 'Count': 123, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalFpgaMemoryInMiB': 123 }, 'PlacementGroupInfo': { 'SupportedStrategies': [ 'cluster'|'partition'|'spread', ] }, 'InferenceAcceleratorInfo': { 'Accelerators': [ { 'Count': 123, 'Name': 'string', 'Manufacturer': 'string', 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalInferenceMemoryInMiB': 123 }, 'HibernationSupported': True|False, 'BurstablePerformanceSupported': True|False, 'DedicatedHostsSupported': True|False, 'AutoRecoverySupported': True|False, 'SupportedBootModes': [ 'legacy-bios'|'uefi', ], 'NitroEnclavesSupport': 'unsupported'|'supported', 'NitroTpmSupport': 'unsupported'|'supported', 'NitroTpmInfo': { 'SupportedVersions': [ 'string', ] }, 'MediaAcceleratorInfo': { 'Accelerators': [ { 'Count': 123, 'Name': 'string', 'Manufacturer': 'string', 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalMediaMemoryInMiB': 123 }, 'NeuronInfo': { 'NeuronDevices': [ { 'Count': 123, 'Name': 'string', 'CoreInfo': { 'Count': 123, 'Version': 123 }, 'MemoryInfo': { 'SizeInMiB': 123 } }, ], 'TotalNeuronDeviceMemoryInMiB': 123 }, 'PhcSupport': 'unsupported'|'supported', 'RebootMigrationSupport': 'unsupported'|'supported' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceTypes** *(list) --* The instance type. * *(dict) --* Describes the instance type. * **InstanceType** *(string) --* The instance type. For more information, see Instance types in the *Amazon EC2 User Guide*. * **CurrentGeneration** *(boolean) --* Indicates whether the instance type is current generation. * **FreeTierEligible** *(boolean) --* Indicates whether the instance type is eligible for the free tier. * **SupportedUsageClasses** *(list) --* Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks. * *(string) --* * **SupportedRootDeviceTypes** *(list) --* The supported root device types. * *(string) --* * **SupportedVirtualizationTypes** *(list) --* The supported virtualization types. * *(string) --* * **BareMetal** *(boolean) --* Indicates whether the instance is a bare metal instance type. * **Hypervisor** *(string) --* The hypervisor for the instance type. * **ProcessorInfo** *(dict) --* Describes the processor. * **SupportedArchitectures** *(list) --* The architectures supported by the instance type. * *(string) --* * **SustainedClockSpeedInGhz** *(float) --* The speed of the processor, in GHz. * **SupportedFeatures** *(list) --* Indicates whether the instance type supports AMD SEV- SNP. If the request returns "amd-sev-snp", AMD SEV-SNP is supported. Otherwise, it is not supported. For more information, see AMD SEV-SNP. * *(string) --* * **Manufacturer** *(string) --* The manufacturer of the processor. * **VCpuInfo** *(dict) --* Describes the vCPU configurations for the instance type. * **DefaultVCpus** *(integer) --* The default number of vCPUs for the instance type. * **DefaultCores** *(integer) --* The default number of cores for the instance type. * **DefaultThreadsPerCore** *(integer) --* The default number of threads per core for the instance type. * **ValidCores** *(list) --* The valid number of cores that can be configured for the instance type. * *(integer) --* * **ValidThreadsPerCore** *(list) --* The valid number of threads per core that can be configured for the instance type. * *(integer) --* * **MemoryInfo** *(dict) --* Describes the memory for the instance type. * **SizeInMiB** *(integer) --* The size of the memory, in MiB. * **InstanceStorageSupported** *(boolean) --* Indicates whether instance storage is supported. * **InstanceStorageInfo** *(dict) --* Describes the instance storage for the instance type. * **TotalSizeInGB** *(integer) --* The total size of the disks, in GB. * **Disks** *(list) --* Describes the disks that are available for the instance type. * *(dict) --* Describes a disk. * **SizeInGB** *(integer) --* The size of the disk in GB. * **Count** *(integer) --* The number of disks with this configuration. * **Type** *(string) --* The type of disk. * **NvmeSupport** *(string) --* Indicates whether non-volatile memory express (NVMe) is supported. * **EncryptionSupport** *(string) --* Indicates whether data is encrypted at rest. * **EbsInfo** *(dict) --* Describes the Amazon EBS settings for the instance type. * **EbsOptimizedSupport** *(string) --* Indicates whether the instance type is Amazon EBS- optimized. For more information, see Amazon EBS- optimized instances in *Amazon EC2 User Guide*. * **EncryptionSupport** *(string) --* Indicates whether Amazon EBS encryption is supported. * **EbsOptimizedInfo** *(dict) --* Describes the optimized EBS performance for the instance type. * **BaselineBandwidthInMbps** *(integer) --* The baseline bandwidth performance for an EBS- optimized instance type, in Mbps. * **BaselineThroughputInMBps** *(float) --* The baseline throughput performance for an EBS- optimized instance type, in MB/s. * **BaselineIops** *(integer) --* The baseline input/output storage operations per seconds for an EBS-optimized instance type. * **MaximumBandwidthInMbps** *(integer) --* The maximum bandwidth performance for an EBS- optimized instance type, in Mbps. * **MaximumThroughputInMBps** *(float) --* The maximum throughput performance for an EBS- optimized instance type, in MB/s. * **MaximumIops** *(integer) --* The maximum input/output storage operations per second for an EBS-optimized instance type. * **NvmeSupport** *(string) --* Indicates whether non-volatile memory express (NVMe) is supported. * **NetworkInfo** *(dict) --* Describes the network settings for the instance type. * **NetworkPerformance** *(string) --* The network performance. * **MaximumNetworkInterfaces** *(integer) --* The maximum number of network interfaces for the instance type. * **MaximumNetworkCards** *(integer) --* The maximum number of physical network cards that can be allocated to the instance. * **DefaultNetworkCardIndex** *(integer) --* The index of the default network card, starting at 0. * **NetworkCards** *(list) --* Describes the network cards for the instance type. * *(dict) --* Describes the network card support of the instance type. * **NetworkCardIndex** *(integer) --* The index of the network card. * **NetworkPerformance** *(string) --* The network performance of the network card. * **MaximumNetworkInterfaces** *(integer) --* The maximum number of network interfaces for the network card. * **BaselineBandwidthInGbps** *(float) --* The baseline network performance of the network card, in Gbps. * **PeakBandwidthInGbps** *(float) --* The peak (burst) network performance of the network card, in Gbps. * **DefaultEnaQueueCountPerInterface** *(integer) --* The default number of the ENA queues for each interface. * **MaximumEnaQueueCount** *(integer) --* The maximum number of the ENA queues. * **MaximumEnaQueueCountPerInterface** *(integer) --* The maximum number of the ENA queues for each interface. * **Ipv4AddressesPerInterface** *(integer) --* The maximum number of IPv4 addresses per network interface. * **Ipv6AddressesPerInterface** *(integer) --* The maximum number of IPv6 addresses per network interface. * **Ipv6Supported** *(boolean) --* Indicates whether IPv6 is supported. * **EnaSupport** *(string) --* Indicates whether Elastic Network Adapter (ENA) is supported. * **EfaSupported** *(boolean) --* Indicates whether Elastic Fabric Adapter (EFA) is supported. * **EfaInfo** *(dict) --* Describes the Elastic Fabric Adapters for the instance type. * **MaximumEfaInterfaces** *(integer) --* The maximum number of Elastic Fabric Adapters for the instance type. * **EncryptionInTransitSupported** *(boolean) --* Indicates whether the instance type automatically encrypts in-transit traffic between instances. * **EnaSrdSupported** *(boolean) --* Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. * **BandwidthWeightings** *(list) --* A list of valid settings for configurable bandwidth weighting for the instance type, if supported. * *(string) --* * **FlexibleEnaQueuesSupport** *(string) --* Indicates whether changing the number of ENA queues is supported. * **GpuInfo** *(dict) --* Describes the GPU accelerator settings for the instance type. * **Gpus** *(list) --* Describes the GPU accelerators for the instance type. * *(dict) --* Describes the GPU accelerators for the instance type. * **Name** *(string) --* The name of the GPU accelerator. * **Manufacturer** *(string) --* The manufacturer of the GPU accelerator. * **Count** *(integer) --* The number of GPUs for the instance type. * **MemoryInfo** *(dict) --* Describes the memory available to the GPU accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the GPU accelerator, in MiB. * **TotalGpuMemoryInMiB** *(integer) --* The total size of the memory for the GPU accelerators for the instance type, in MiB. * **FpgaInfo** *(dict) --* Describes the FPGA accelerator settings for the instance type. * **Fpgas** *(list) --* Describes the FPGAs for the instance type. * *(dict) --* Describes the FPGA accelerator for the instance type. * **Name** *(string) --* The name of the FPGA accelerator. * **Manufacturer** *(string) --* The manufacturer of the FPGA accelerator. * **Count** *(integer) --* The count of FPGA accelerators for the instance type. * **MemoryInfo** *(dict) --* Describes the memory for the FPGA accelerator for the instance type. * **SizeInMiB** *(integer) --* The size of the memory available to the FPGA accelerator, in MiB. * **TotalFpgaMemoryInMiB** *(integer) --* The total memory of all FPGA accelerators for the instance type. * **PlacementGroupInfo** *(dict) --* Describes the placement group settings for the instance type. * **SupportedStrategies** *(list) --* The supported placement group types. * *(string) --* * **InferenceAcceleratorInfo** *(dict) --* Describes the Inference accelerator settings for the instance type. * **Accelerators** *(list) --* Describes the Inference accelerators for the instance type. * *(dict) --* Note: Amazon Elastic Inference is no longer available. Describes the Inference accelerators for the instance type. * **Count** *(integer) --* The number of Inference accelerators for the instance type. * **Name** *(string) --* The name of the Inference accelerator. * **Manufacturer** *(string) --* The manufacturer of the Inference accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to the inference accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the inference accelerator, in MiB. * **TotalInferenceMemoryInMiB** *(integer) --* The total size of the memory for the inference accelerators for the instance type, in MiB. * **HibernationSupported** *(boolean) --* Indicates whether On-Demand hibernation is supported. * **BurstablePerformanceSupported** *(boolean) --* Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances. * **DedicatedHostsSupported** *(boolean) --* Indicates whether Dedicated Hosts are supported on the instance type. * **AutoRecoverySupported** *(boolean) --* Indicates whether Amazon CloudWatch action based recovery is supported. * **SupportedBootModes** *(list) --* The supported boot modes. For more information, see Boot modes in the *Amazon EC2 User Guide*. * *(string) --* * **NitroEnclavesSupport** *(string) --* Indicates whether Nitro Enclaves is supported. * **NitroTpmSupport** *(string) --* Indicates whether NitroTPM is supported. * **NitroTpmInfo** *(dict) --* Describes the supported NitroTPM versions for the instance type. * **SupportedVersions** *(list) --* Indicates the supported NitroTPM versions. * *(string) --* * **MediaAcceleratorInfo** *(dict) --* Describes the media accelerator settings for the instance type. * **Accelerators** *(list) --* Describes the media accelerators for the instance type. * *(dict) --* Describes the media accelerators for the instance type. * **Count** *(integer) --* The number of media accelerators for the instance type. * **Name** *(string) --* The name of the media accelerator. * **Manufacturer** *(string) --* The manufacturer of the media accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to the media accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to each media accelerator, in MiB. * **TotalMediaMemoryInMiB** *(integer) --* The total size of the memory for the media accelerators for the instance type, in MiB. * **NeuronInfo** *(dict) --* Describes the Neuron accelerator settings for the instance type. * **NeuronDevices** *(list) --* Describes the neuron accelerators for the instance type. * *(dict) --* Describes the neuron accelerators for the instance type. * **Count** *(integer) --* The number of neuron accelerators for the instance type. * **Name** *(string) --* The name of the neuron accelerator. * **CoreInfo** *(dict) --* Describes the cores available to each neuron accelerator. * **Count** *(integer) --* The number of cores available to the neuron accelerator. * **Version** *(integer) --* The version of the neuron accelerator. * **MemoryInfo** *(dict) --* Describes the memory available to each neuron accelerator. * **SizeInMiB** *(integer) --* The size of the memory available to the neuron accelerator, in MiB. * **TotalNeuronDeviceMemoryInMiB** *(integer) --* The total size of the memory for the neuron accelerators for the instance type, in MiB. * **PhcSupport** *(string) --* Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported. * **RebootMigrationSupport** *(string) --* Indicates whether reboot migration during a user- initiated reboot is supported for instances that have a scheduled "system-reboot" event. For more information, see Enable or disable reboot migration in the *Amazon EC2 User Guide*. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / describe_client_vpn_authorization_rules describe_client_vpn_authorization_rules *************************************** EC2.Client.describe_client_vpn_authorization_rules(**kwargs) Describes the authorization rules for a specified Client VPN endpoint. See also: AWS API Documentation **Request Syntax** response = client.describe_client_vpn_authorization_rules( ClientVpnEndpointId='string', DryRun=True|False, NextToken='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123 ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token to retrieve the next page of results. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'AuthorizationRules': [ { 'ClientVpnEndpointId': 'string', 'Description': 'string', 'GroupId': 'string', 'AccessAll': True|False, 'DestinationCidr': 'string', 'Status': { 'Code': 'authorizing'|'active'|'failed'|'revoking', 'Message': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AuthorizationRules** *(list) --* Information about the authorization rules. * *(dict) --* Information about an authorization rule. * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint with which the authorization rule is associated. * **Description** *(string) --* A brief description of the authorization rule. * **GroupId** *(string) --* The ID of the Active Directory group to which the authorization rule grants access. * **AccessAll** *(boolean) --* Indicates whether the authorization rule grants access to all clients. * **DestinationCidr** *(string) --* The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. * **Status** *(dict) --* The current state of the authorization rule. * **Code** *(string) --* The state of the authorization rule. * **Message** *(string) --* A message about the status of the authorization rule, if applicable. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / get_host_reservation_purchase_preview get_host_reservation_purchase_preview ************************************* EC2.Client.get_host_reservation_purchase_preview(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_host_reservation_purchase_preview( HostIdSet=[ 'string', ], OfferingId='string' ) Parameters: * **HostIdSet** (*list*) -- **[REQUIRED]** The IDs of the Dedicated Hosts with which the reservation is associated. * *(string) --* * **OfferingId** (*string*) -- **[REQUIRED]** The offering ID of the reservation. Return type: dict Returns: **Response Syntax** { 'CurrencyCode': 'USD', 'Purchase': [ { 'CurrencyCode': 'USD', 'Duration': 123, 'HostIdSet': [ 'string', ], 'HostReservationId': 'string', 'HourlyPrice': 'string', 'InstanceFamily': 'string', 'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront', 'UpfrontPrice': 'string' }, ], 'TotalHourlyPrice': 'string', 'TotalUpfrontPrice': 'string' } **Response Structure** * *(dict) --* * **CurrencyCode** *(string) --* The currency in which the "totalUpfrontPrice" and "totalHourlyPrice" amounts are specified. At this time, the only supported currency is "USD". * **Purchase** *(list) --* The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. * *(dict) --* Describes the result of the purchase. * **CurrencyCode** *(string) --* The currency in which the "UpfrontPrice" and "HourlyPrice" amounts are specified. At this time, the only supported currency is "USD". * **Duration** *(integer) --* The duration of the reservation's term in seconds. * **HostIdSet** *(list) --* The IDs of the Dedicated Hosts associated with the reservation. * *(string) --* * **HostReservationId** *(string) --* The ID of the reservation. * **HourlyPrice** *(string) --* The hourly price of the reservation per hour. * **InstanceFamily** *(string) --* The instance family on the Dedicated Host that the reservation can be associated with. * **PaymentOption** *(string) --* The payment option for the reservation. * **UpfrontPrice** *(string) --* The upfront price of the reservation. * **TotalHourlyPrice** *(string) --* The potential total hourly price of the reservation per hour. * **TotalUpfrontPrice** *(string) --* The potential total upfront price. This is billed immediately. EC2 / Client / create_local_gateway_route_table_virtual_interface_group_association create_local_gateway_route_table_virtual_interface_group_association ******************************************************************** EC2.Client.create_local_gateway_route_table_virtual_interface_group_association(**kwargs) Creates a local gateway route table virtual interface group association. See also: AWS API Documentation **Request Syntax** response = client.create_local_gateway_route_table_virtual_interface_group_association( LocalGatewayRouteTableId='string', LocalGatewayVirtualInterfaceGroupId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **LocalGatewayVirtualInterfaceGroupId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table virtual interface group association. * **TagSpecifications** (*list*) -- The tags assigned to the local gateway route table virtual interface group association. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTableVirtualInterfaceGroupAssociation': { 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayId': 'string', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **LocalGatewayRouteTableVirtualInterfaceGroupAssociation** *(dict) --* Information about the local gateway route table virtual interface group association. * **LocalGatewayRouteTableVirtualInterfaceGroupAssociationI d** *(string) --* The ID of the association. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. * **State** *(string) --* The state of the association. * **Tags** *(list) --* The tags assigned to the association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_network_insights_paths describe_network_insights_paths ******************************* EC2.Client.describe_network_insights_paths(**kwargs) Describes one or more of your paths. See also: AWS API Documentation **Request Syntax** response = client.describe_network_insights_paths( NetworkInsightsPathIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, DryRun=True|False, NextToken='string' ) Parameters: * **NetworkInsightsPathIds** (*list*) -- The IDs of the paths. * *(string) --* * **Filters** (*list*) -- The filters. The following are the possible values: * destination - The ID of the resource. * filter-at-source.source-address - The source IPv4 address at the source. * filter-at-source.source-port-range - The source port range at the source. * filter-at-source.destination-address - The destination IPv4 address at the source. * filter-at-source.destination-port-range - The destination port range at the source. * filter-at-destination.source-address - The source IPv4 address at the destination. * filter-at-destination.source-port-range - The source port range at the destination. * filter-at-destination.destination-address - The destination IPv4 address at the destination. * filter-at-destination.destination-port-range - The destination port range at the destination. * protocol - The protocol. * source - The ID of the resource. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsPaths': [ { 'NetworkInsightsPathId': 'string', 'NetworkInsightsPathArn': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Source': 'string', 'Destination': 'string', 'SourceArn': 'string', 'DestinationArn': 'string', 'SourceIp': 'string', 'DestinationIp': 'string', 'Protocol': 'tcp'|'udp', 'DestinationPort': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FilterAtSource': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } }, 'FilterAtDestination': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NetworkInsightsPaths** *(list) --* Information about the paths. * *(dict) --* Describes a path. * **NetworkInsightsPathId** *(string) --* The ID of the path. * **NetworkInsightsPathArn** *(string) --* The Amazon Resource Name (ARN) of the path. * **CreatedDate** *(datetime) --* The time stamp when the path was created. * **Source** *(string) --* The ID of the source. * **Destination** *(string) --* The ID of the destination. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the source. * **DestinationArn** *(string) --* The Amazon Resource Name (ARN) of the destination. * **SourceIp** *(string) --* The IP address of the source. * **DestinationIp** *(string) --* The IP address of the destination. * **Protocol** *(string) --* The protocol. * **DestinationPort** *(integer) --* The destination port. * **Tags** *(list) --* The tags associated with the path. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **FilterAtSource** *(dict) --* Scopes the analysis to network paths that match specific filters at the source. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **FilterAtDestination** *(dict) --* Scopes the analysis to network paths that match specific filters at the destination. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_capacity_reservation_fleets describe_capacity_reservation_fleets ************************************ EC2.Client.describe_capacity_reservation_fleets(**kwargs) Describes one or more Capacity Reservation Fleets. See also: AWS API Documentation **Request Syntax** response = client.describe_capacity_reservation_fleets( CapacityReservationFleetIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CapacityReservationFleetIds** (*list*) -- The IDs of the Capacity Reservation Fleets to describe. * *(string) --* * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **Filters** (*list*) -- One or more filters. * "state" - The state of the Fleet ( "submitted" | "modifying" | "active" | "partially_fulfilled" | "expiring" | "expired" | "cancelling" | "cancelled" | "failed"). * "instance-match-criteria" - The instance matching criteria for the Fleet. Only "open" is supported. * "tenancy" - The tenancy of the Fleet ( "default" | "dedicated"). * "allocation-strategy" - The allocation strategy used by the Fleet. Only "prioritized" is supported. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CapacityReservationFleets': [ { 'CapacityReservationFleetId': 'string', 'CapacityReservationFleetArn': 'string', 'State': 'submitted'|'modifying'|'active'|'partially_fulfilled'|'expiring'|'expired'|'cancelling'|'cancelled'|'failed', 'TotalTargetCapacity': 123, 'TotalFulfilledCapacity': 123.0, 'Tenancy': 'default', 'EndDate': datetime(2015, 1, 1), 'CreateTime': datetime(2015, 1, 1), 'InstanceMatchCriteria': 'open', 'AllocationStrategy': 'string', 'InstanceTypeSpecifications': [ { 'CapacityReservationId': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'TotalInstanceCount': 123, 'FulfilledCapacity': 123.0, 'EbsOptimized': True|False, 'CreateDate': datetime(2015, 1, 1), 'Weight': 123.0, 'Priority': 123 }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CapacityReservationFleets** *(list) --* Information about the Capacity Reservation Fleets. * *(dict) --* Information about a Capacity Reservation Fleet. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet. * **CapacityReservationFleetArn** *(string) --* The ARN of the Capacity Reservation Fleet. * **State** *(string) --* The state of the Capacity Reservation Fleet. Possible states include: * "submitted" - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations. * "modifying" - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete. * "active" - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted. * "partially_fulfilled" - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity. * "expiring" - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active. * "expired" - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations. * "cancelling" - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active. * "cancelled" - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations. * "failed" - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types. * **TotalTargetCapacity** *(integer) --* The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **TotalFulfilledCapacity** *(float) --* The capacity units that have been fulfilled. * **Tenancy** *(string) --* The tenancy of the Capacity Reservation Fleet. Tenancies include: * "default" - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. * "dedicated" - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **EndDate** *(datetime) --* The date and time at which the Capacity Reservation Fleet expires. * **CreateTime** *(datetime) --* The date and time at which the Capacity Reservation Fleet was created. * **InstanceMatchCriteria** *(string) --* Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria. Currently, Capacity Reservation Fleets support "open" instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity. * **AllocationStrategy** *(string) --* The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the *Amazon EC2 User Guide*. * **InstanceTypeSpecifications** *(list) --* Information about the instance types for which to reserve the capacity. * *(dict) --* Information about a Capacity Reservation in a Capacity Reservation Fleet. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone in which the Capacity Reservation reserves capacity. * **InstanceType** *(string) --* The instance type for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the Capacity Reservation reserves capacity. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **FulfilledCapacity** *(float) --* The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **EbsOptimized** *(boolean) --* Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Weight** *(float) --* The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the *Amazon EC2 User Guide*. * **Priority** *(integer) --* The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the *Amazon EC2 User Guide*. * **Tags** *(list) --* The tags assigned to the Capacity Reservation Fleet. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / create_vpc_endpoint_connection_notification create_vpc_endpoint_connection_notification ******************************************* EC2.Client.create_vpc_endpoint_connection_notification(**kwargs) Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Creating an Amazon SNS topic in the *Amazon SNS Developer Guide*. You can create a connection notification for interface endpoints only. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_endpoint_connection_notification( DryRun=True|False, ServiceId='string', VpcEndpointId='string', ConnectionNotificationArn='string', ConnectionEvents=[ 'string', ], ClientToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the endpoint service. * **VpcEndpointId** (*string*) -- The ID of the endpoint. * **ConnectionNotificationArn** (*string*) -- **[REQUIRED]** The ARN of the SNS topic for the notifications. * **ConnectionEvents** (*list*) -- **[REQUIRED]** The endpoint events for which to receive notifications. Valid values are "Accept", "Connect", "Delete", and "Reject". * *(string) --* * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. Return type: dict Returns: **Response Syntax** { 'ConnectionNotification': { 'ConnectionNotificationId': 'string', 'ServiceId': 'string', 'VpcEndpointId': 'string', 'ConnectionNotificationType': 'Topic', 'ConnectionNotificationArn': 'string', 'ConnectionEvents': [ 'string', ], 'ConnectionNotificationState': 'Enabled'|'Disabled', 'ServiceRegion': 'string' }, 'ClientToken': 'string' } **Response Structure** * *(dict) --* * **ConnectionNotification** *(dict) --* Information about the notification. * **ConnectionNotificationId** *(string) --* The ID of the notification. * **ServiceId** *(string) --* The ID of the endpoint service. * **VpcEndpointId** *(string) --* The ID of the VPC endpoint. * **ConnectionNotificationType** *(string) --* The type of notification. * **ConnectionNotificationArn** *(string) --* The ARN of the SNS topic for the notification. * **ConnectionEvents** *(list) --* The events for the notification. Valid values are "Accept", "Connect", "Delete", and "Reject". * *(string) --* * **ConnectionNotificationState** *(string) --* The state of the notification. * **ServiceRegion** *(string) --* The Region for the endpoint service. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. EC2 / Client / create_network_insights_path create_network_insights_path **************************** EC2.Client.create_network_insights_path(**kwargs) Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer Guide. See also: AWS API Documentation **Request Syntax** response = client.create_network_insights_path( SourceIp='string', DestinationIp='string', Source='string', Destination='string', Protocol='tcp'|'udp', DestinationPort=123, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, ClientToken='string', FilterAtSource={ 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } }, FilterAtDestination={ 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } } ) Parameters: * **SourceIp** (*string*) -- The IP address of the source. * **DestinationIp** (*string*) -- The IP address of the destination. * **Source** (*string*) -- **[REQUIRED]** The ID or ARN of the source. If the resource is in another account, you must specify an ARN. * **Destination** (*string*) -- The ID or ARN of the destination. If the resource is in another account, you must specify an ARN. * **Protocol** (*string*) -- **[REQUIRED]** The protocol. * **DestinationPort** (*integer*) -- The destination port. * **TagSpecifications** (*list*) -- The tags to add to the path. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. This field is autopopulated if not provided. * **FilterAtSource** (*dict*) -- Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **FilterAtDestination** (*dict*) -- Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsPath': { 'NetworkInsightsPathId': 'string', 'NetworkInsightsPathArn': 'string', 'CreatedDate': datetime(2015, 1, 1), 'Source': 'string', 'Destination': 'string', 'SourceArn': 'string', 'DestinationArn': 'string', 'SourceIp': 'string', 'DestinationIp': 'string', 'Protocol': 'tcp'|'udp', 'DestinationPort': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FilterAtSource': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } }, 'FilterAtDestination': { 'SourceAddress': 'string', 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationAddress': 'string', 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 } } } } **Response Structure** * *(dict) --* * **NetworkInsightsPath** *(dict) --* Information about the path. * **NetworkInsightsPathId** *(string) --* The ID of the path. * **NetworkInsightsPathArn** *(string) --* The Amazon Resource Name (ARN) of the path. * **CreatedDate** *(datetime) --* The time stamp when the path was created. * **Source** *(string) --* The ID of the source. * **Destination** *(string) --* The ID of the destination. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the source. * **DestinationArn** *(string) --* The Amazon Resource Name (ARN) of the destination. * **SourceIp** *(string) --* The IP address of the source. * **DestinationIp** *(string) --* The IP address of the destination. * **Protocol** *(string) --* The protocol. * **DestinationPort** *(integer) --* The destination port. * **Tags** *(list) --* The tags associated with the path. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **FilterAtSource** *(dict) --* Scopes the analysis to network paths that match specific filters at the source. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **FilterAtDestination** *(dict) --* Scopes the analysis to network paths that match specific filters at the destination. * **SourceAddress** *(string) --* The source IPv4 address. * **SourcePortRange** *(dict) --* The source port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. * **DestinationAddress** *(string) --* The destination IPv4 address. * **DestinationPortRange** *(dict) --* The destination port range. * **FromPort** *(integer) --* The first port in the range. * **ToPort** *(integer) --* The last port in the range. EC2 / Client / modify_vpc_endpoint_connection_notification modify_vpc_endpoint_connection_notification ******************************************* EC2.Client.modify_vpc_endpoint_connection_notification(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_vpc_endpoint_connection_notification( DryRun=True|False, ConnectionNotificationId='string', ConnectionNotificationArn='string', ConnectionEvents=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ConnectionNotificationId** (*string*) -- **[REQUIRED]** The ID of the notification. * **ConnectionNotificationArn** (*string*) -- The ARN for the SNS topic for the notification. * **ConnectionEvents** (*list*) -- The events for the endpoint. Valid values are "Accept", "Connect", "Delete", and "Reject". * *(string) --* Return type: dict Returns: **Response Syntax** { 'ReturnValue': True|False } **Response Structure** * *(dict) --* * **ReturnValue** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / describe_addresses_attribute describe_addresses_attribute **************************** EC2.Client.describe_addresses_attribute(**kwargs) Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications. See also: AWS API Documentation **Request Syntax** response = client.describe_addresses_attribute( AllocationIds=[ 'string', ], Attribute='domain-name', NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **AllocationIds** (*list*) -- [EC2-VPC] The allocation IDs. * *(string) --* * **Attribute** (*string*) -- The attribute of the IP address. * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Addresses': [ { 'PublicIp': 'string', 'AllocationId': 'string', 'PtrRecord': 'string', 'PtrRecordUpdate': { 'Value': 'string', 'Status': 'string', 'Reason': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Addresses** *(list) --* Information about the IP addresses. * *(dict) --* The attributes associated with an Elastic IP address. * **PublicIp** *(string) --* The public IP address. * **AllocationId** *(string) --* [EC2-VPC] The allocation ID. * **PtrRecord** *(string) --* The pointer (PTR) record for the IP address. * **PtrRecordUpdate** *(dict) --* The updated PTR record for the IP address. * **Value** *(string) --* The value for the PTR record update. * **Status** *(string) --* The status of the PTR record update. * **Reason** *(string) --* The reason for the PTR record update. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / import_key_pair import_key_pair *************** EC2.Client.import_key_pair(**kwargs) Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services. For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.import_key_pair( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, KeyName='string', PublicKeyMaterial=b'bytes' ) Parameters: * **TagSpecifications** (*list*) -- The tags to apply to the imported key pair. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **KeyName** (*string*) -- **[REQUIRED]** A unique name for the key pair. * **PublicKeyMaterial** (*bytes*) -- **[REQUIRED]** The public key. Return type: dict Returns: **Response Syntax** { 'KeyFingerprint': 'string', 'KeyName': 'string', 'KeyPairId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **KeyFingerprint** *(string) --* * For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. * **KeyName** *(string) --* The key pair name that you provided. * **KeyPairId** *(string) --* The ID of the resulting key pair. * **Tags** *(list) --* The tags applied to the imported key pair. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / deregister_transit_gateway_multicast_group_sources deregister_transit_gateway_multicast_group_sources ************************************************** EC2.Client.deregister_transit_gateway_multicast_group_sources(**kwargs) Deregisters the specified sources (network interfaces) from the transit gateway multicast group. See also: AWS API Documentation **Request Syntax** response = client.deregister_transit_gateway_multicast_group_sources( TransitGatewayMulticastDomainId='string', GroupIpAddress='string', NetworkInterfaceIds=[ 'string', ], DryRun=True|False ) Parameters: * **TransitGatewayMulticastDomainId** (*string*) -- The ID of the transit gateway multicast domain. * **GroupIpAddress** (*string*) -- The IP address assigned to the transit gateway multicast group. * **NetworkInterfaceIds** (*list*) -- The IDs of the group sources' network interfaces. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DeregisteredMulticastGroupSources': { 'TransitGatewayMulticastDomainId': 'string', 'DeregisteredNetworkInterfaceIds': [ 'string', ], 'GroupIpAddress': 'string' } } **Response Structure** * *(dict) --* * **DeregisteredMulticastGroupSources** *(dict) --* Information about the deregistered group sources. * **TransitGatewayMulticastDomainId** *(string) --* The ID of the transit gateway multicast domain. * **DeregisteredNetworkInterfaceIds** *(list) --* The network interface IDs of the non-registered members. * *(string) --* * **GroupIpAddress** *(string) --* The IP address assigned to the transit gateway multicast group. EC2 / Client / create_vpn_connection_route create_vpn_connection_route *************************** EC2.Client.create_vpn_connection_route(**kwargs) Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see Amazon Web Services Site-to-Site VPN in the *Amazon Web Services Site-to-Site VPN User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_vpn_connection_route( DestinationCidrBlock='string', VpnConnectionId='string' ) Parameters: * **DestinationCidrBlock** (*string*) -- **[REQUIRED]** The CIDR block associated with the local subnet of the customer network. * **VpnConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPN connection. Returns: None EC2 / Client / get_waiter get_waiter ********** EC2.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" EC2 / Client / get_coip_pool_usage get_coip_pool_usage ******************* EC2.Client.get_coip_pool_usage(**kwargs) Describes the allocations from the specified customer-owned address pool. See also: AWS API Documentation **Request Syntax** response = client.get_coip_pool_usage( PoolId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **PoolId** (*string*) -- **[REQUIRED]** The ID of the address pool. * **Filters** (*list*) -- One or more filters. * "coip-address-usage.allocation-id" - The allocation ID of the address. * "coip-address-usage.aws-account-id" - The ID of the Amazon Web Services account that is using the customer-owned IP address. * "coip-address-usage.aws-service" - The Amazon Web Services service that is using the customer-owned IP address. * "coip-address-usage.co-ip" - The customer-owned IP address. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CoipPoolId': 'string', 'CoipAddressUsages': [ { 'AllocationId': 'string', 'AwsAccountId': 'string', 'AwsService': 'string', 'CoIp': 'string' }, ], 'LocalGatewayRouteTableId': 'string', 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CoipPoolId** *(string) --* The ID of the customer-owned address pool. * **CoipAddressUsages** *(list) --* Information about the address usage. * *(dict) --* Describes address usage for a customer-owned address pool. * **AllocationId** *(string) --* The allocation ID of the address. * **AwsAccountId** *(string) --* The Amazon Web Services account ID. * **AwsService** *(string) --* The Amazon Web Services service. * **CoIp** *(string) --* The customer-owned IP address. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_instance_image_metadata describe_instance_image_metadata ******************************** EC2.Client.describe_instance_image_metadata(**kwargs) Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed. If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error ( "InvalidInstanceID.NotFound") is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_instance_image_metadata( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceIds=[ 'string', ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **Filters** (*list*) -- The filters. * "availability-zone" - The name of the Availability Zone (for example, "us-west-2a") or Local Zone (for example, "us- west-2-lax-1b") of the instance. * "instance-id" - The ID of the instance. * "image-allowed" - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. * "instance-state-name" - The state of the instance ( "pending" | "running" | "shutting-down" | "terminated" | "stopping" | "stopped"). * "instance-type" - The type of instance (for example, "t3.micro"). * "launch-time" - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM- DDThh:mm:ss.sssZ), for example, "2023-09-29T11:04:43.305Z". You can use a wildcard ( "*"), for example, "2023-09-29T*", which matches an entire day. * "owner-alias" - The owner alias ( "amazon" | "aws- marketplace" | "aws-backup-vault"). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the "Owner" request parameter instead of this filter. * "tag:" - 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. * "zone-id" - The ID of the Availability Zone (for example, "usw2-az2") or Local Zone (for example, "usw2-lax1-az1") of the instance. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceIds** (*list*) -- The instance IDs. If you don't specify an instance ID or filters, the output includes information for all instances. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Default: 1000 * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceImageMetadata': [ { 'InstanceId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'LaunchTime': datetime(2015, 1, 1), 'AvailabilityZone': 'string', 'ZoneId': 'string', 'State': { 'Code': 123, 'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped' }, 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ImageMetadata': { 'ImageId': 'string', 'Name': 'string', 'OwnerId': 'string', 'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error'|'disabled', 'ImageOwnerAlias': 'string', 'CreationDate': 'string', 'DeprecationTime': 'string', 'ImageAllowed': True|False, 'IsPublic': True|False }, 'Operator': { 'Managed': True|False, 'Principal': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceImageMetadata** *(list) --* Information about the instance and the AMI used to launch the instance. * *(dict) --* Information about the instance and the AMI used to launch the instance. * **InstanceId** *(string) --* The ID of the instance. * **InstanceType** *(string) --* The instance type. * **LaunchTime** *(datetime) --* The time the instance was launched. * **AvailabilityZone** *(string) --* The Availability Zone or Local Zone of the instance. * **ZoneId** *(string) --* The ID of the Availability Zone or Local Zone of the instance. * **State** *(dict) --* The current state of the instance. * **Code** *(integer) --* The state of the instance as a 16-bit unsigned integer. The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. The valid values for instance-state-code will all be in the range of the low byte and they are: * "0" : "pending" * "16" : "running" * "32" : "shutting-down" * "48" : "terminated" * "64" : "stopping" * "80" : "stopped" You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal. * **Name** *(string) --* The current state of the instance. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the instance. * **Tags** *(list) --* Any tags assigned to the instance. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ImageMetadata** *(dict) --* Information about the AMI used to launch the instance. * **ImageId** *(string) --* The ID of the AMI. * **Name** *(string) --* The name of the AMI. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the AMI. * **State** *(string) --* The current state of the AMI. If the state is "available", the AMI is successfully registered and can be used to launch an instance. * **ImageOwnerAlias** *(string) --* The alias of the AMI owner. Valid values: "amazon" | "aws-backup-vault" | "aws- marketplace" * **CreationDate** *(string) --* The date and time the AMI was created. * **DeprecationTime** *(string) --* The deprecation date and time of the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next set of items to return. (You received this token from a prior call.) * **ServiceRegions** (*list*) -- The service Regions. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ServiceNames': [ 'string', ], 'ServiceDetails': [ { 'ServiceName': 'string', 'ServiceId': 'string', 'ServiceType': [ { 'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer' }, ], 'ServiceRegion': 'string', 'AvailabilityZones': [ 'string', ], 'Owner': 'string', 'BaseEndpointDnsNames': [ 'string', ], 'PrivateDnsName': 'string', 'PrivateDnsNames': [ { 'PrivateDnsName': 'string' }, ], 'VpcEndpointPolicySupported': True|False, 'AcceptanceRequired': True|False, 'ManagesVpcEndpoints': True|False, 'PayerResponsibility': 'ServiceOwner', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PrivateDnsNameVerificationState': 'pendingVerification'|'verified'|'failed', 'SupportedIpAddressTypes': [ 'ipv4'|'ipv6', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ServiceNames** *(list) --* The supported services. * *(string) --* * **ServiceDetails** *(list) --* Information about the service. * *(dict) --* Describes a VPC endpoint service. * **ServiceName** *(string) --* The name of the service. * **ServiceId** *(string) --* The ID of the endpoint service. * **ServiceType** *(list) --* The type of service. * *(dict) --* Describes the type of service for a VPC endpoint. * **ServiceType** *(string) --* The type of service. * **ServiceRegion** *(string) --* The Region where the service is hosted. * **AvailabilityZones** *(list) --* The Availability Zones in which the service is available. * *(string) --* * **Owner** *(string) --* The Amazon Web Services account ID of the service owner. * **BaseEndpointDnsNames** *(list) --* The DNS names for the service. * *(string) --* * **PrivateDnsName** *(string) --* The private DNS name for the service. * **PrivateDnsNames** *(list) --* The private DNS names assigned to the VPC endpoint service. * *(dict) --* Information about the Private DNS name for interface endpoints. * **PrivateDnsName** *(string) --* The private DNS name assigned to the VPC endpoint service. * **VpcEndpointPolicySupported** *(boolean) --* Indicates whether the service supports endpoint policies. * **AcceptanceRequired** *(boolean) --* Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. * **ManagesVpcEndpoints** *(boolean) --* Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. * **PayerResponsibility** *(string) --* The payer responsibility. * **Tags** *(list) --* The tags assigned to the service. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PrivateDnsNameVerificationState** *(string) --* The verification state of the VPC endpoint service. Consumers of the endpoint service cannot use the private name when the state is not "verified". * **SupportedIpAddressTypes** *(list) --* The supported IP address types. * *(string) --* * **NextToken** *(string) --* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. EC2 / Client / release_ipam_pool_allocation release_ipam_pool_allocation **************************** EC2.Client.release_ipam_pool_allocation(**kwargs) Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the *Amazon VPC IPAM User Guide*. Note: All EC2 API actions follow an eventual consistency model. See also: AWS API Documentation **Request Syntax** response = client.release_ipam_pool_allocation( DryRun=True|False, IpamPoolId='string', Cidr='string', IpamPoolAllocationId='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamPoolId** (*string*) -- **[REQUIRED]** The ID of the IPAM pool which contains the allocation you want to release. * **Cidr** (*string*) -- **[REQUIRED]** The CIDR of the allocation you want to release. * **IpamPoolAllocationId** (*string*) -- **[REQUIRED]** The ID of the allocation. Return type: dict Returns: **Response Syntax** { 'Success': True|False } **Response Structure** * *(dict) --* * **Success** *(boolean) --* Indicates if the release was successful. EC2 / Client / describe_fleet_history describe_fleet_history ********************** EC2.Client.describe_fleet_history(**kwargs) Describes the events for the specified EC2 Fleet during the specified time. EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours. For more information, see Monitor fleet events using Amazon EventBridge in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_fleet_history( DryRun=True|False, EventType='instance-change'|'fleet-change'|'service-error', MaxResults=123, NextToken='string', FleetId='string', StartTime=datetime(2015, 1, 1) ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The type of events to describe. By default, all events are described. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **FleetId** (*string*) -- **[REQUIRED]** The ID of the EC2 Fleet. * **StartTime** (*datetime*) -- **[REQUIRED]** The start date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'KeyPairs': [ { 'KeyPairId': 'string', 'KeyType': 'rsa'|'ed25519', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PublicKey': 'string', 'CreateTime': datetime(2015, 1, 1), 'KeyName': 'string', 'KeyFingerprint': 'string' }, ] } **Response Structure** * *(dict) --* * **KeyPairs** *(list) --* Information about the key pairs. * *(dict) --* Describes a key pair. * **KeyPairId** *(string) --* The ID of the key pair. * **KeyType** *(string) --* The type of key pair. * **Tags** *(list) --* Any tags applied to the key pair. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PublicKey** *(string) --* The public key material. * **CreateTime** *(datetime) --* If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone. If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone. * **KeyName** *(string) --* The name of the key pair. * **KeyFingerprint** *(string) --* If you used CreateKeyPair to create the key pair: * For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. If you used ImportKeyPair to provide Amazon Web Services the public key: * For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. **Examples** This example displays the fingerprint for the specified key. response = client.describe_key_pairs( KeyNames=[ 'my-key-pair', ], ) print(response) Expected Output: { 'KeyPairs': [ { 'KeyFingerprint': '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f', 'KeyName': 'my-key-pair', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / enable_image_deprecation enable_image_deprecation ************************ EC2.Client.enable_image_deprecation(**kwargs) Enables deprecation of the specified AMI at the specified date and time. For more information, see Deprecate an AMI in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.enable_image_deprecation( ImageId='string', DeprecateAt=datetime(2015, 1, 1), DryRun=True|False ) Parameters: * **ImageId** (*string*) -- **[REQUIRED]** The ID of the AMI. * **DeprecateAt** (*datetime*) -- **[REQUIRED]** The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token to retrieve the next page of results. Return type: dict Returns: **Response Syntax** { 'ServiceConfigurations': [ { 'ServiceType': [ { 'ServiceType': 'Interface'|'Gateway'|'GatewayLoadBalancer' }, ], 'ServiceId': 'string', 'ServiceName': 'string', 'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed', 'AvailabilityZones': [ 'string', ], 'AcceptanceRequired': True|False, 'ManagesVpcEndpoints': True|False, 'NetworkLoadBalancerArns': [ 'string', ], 'GatewayLoadBalancerArns': [ 'string', ], 'SupportedIpAddressTypes': [ 'ipv4'|'ipv6', ], 'BaseEndpointDnsNames': [ 'string', ], 'PrivateDnsName': 'string', 'PrivateDnsNameConfiguration': { 'State': 'pendingVerification'|'verified'|'failed', 'Type': 'string', 'Value': 'string', 'Name': 'string' }, 'PayerResponsibility': 'ServiceOwner', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SupportedRegions': [ { 'Region': 'string', 'ServiceState': 'string' }, ], 'RemoteAccessEnabled': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ServiceConfigurations** *(list) --* Information about the services. * *(dict) --* Describes a service configuration for a VPC endpoint service. * **ServiceType** *(list) --* The type of service. * *(dict) --* Describes the type of service for a VPC endpoint. * **ServiceType** *(string) --* The type of service. * **ServiceId** *(string) --* The ID of the service. * **ServiceName** *(string) --* The name of the service. * **ServiceState** *(string) --* The service state. * **AvailabilityZones** *(list) --* The Availability Zones in which the service is available. * *(string) --* * **AcceptanceRequired** *(boolean) --* Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted. * **ManagesVpcEndpoints** *(boolean) --* Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. * **NetworkLoadBalancerArns** *(list) --* The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. * *(string) --* * **GatewayLoadBalancerArns** *(list) --* The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. * *(string) --* * **SupportedIpAddressTypes** *(list) --* The supported IP address types. * *(string) --* * **BaseEndpointDnsNames** *(list) --* The DNS names for the service. * *(string) --* * **PrivateDnsName** *(string) --* The private DNS name for the service. * **PrivateDnsNameConfiguration** *(dict) --* Information about the endpoint service private DNS name configuration. * **State** *(string) --* The verification state of the VPC endpoint service. >Consumers of the endpoint service can use the private name only when the state is "verified". * **Type** *(string) --* The endpoint service verification type, for example TXT. * **Value** *(string) --* The value the service provider adds to the private DNS name domain record before verification. * **Name** *(string) --* The name of the record subdomain the service provider needs to create. The service provider adds the "value" text to the "name". * **PayerResponsibility** *(string) --* The payer responsibility. * **Tags** *(list) --* The tags assigned to the service. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SupportedRegions** *(list) --* The supported Regions. * *(dict) --* Describes a supported Region. * **Region** *(string) --* The Region code. * **ServiceState** *(string) --* The service state. The possible values are "Pending", "Available", "Deleting", "Deleted", "Failed", and "Closed". * **RemoteAccessEnabled** *(boolean) --* Indicates whether consumers can access the service from a Region other than the Region where the service is hosted. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / modify_ipam_resource_discovery modify_ipam_resource_discovery ****************************** EC2.Client.modify_ipam_resource_discovery(**kwargs) Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. See also: AWS API Documentation **Request Syntax** response = client.modify_ipam_resource_discovery( DryRun=True|False, IpamResourceDiscoveryId='string', Description='string', AddOperatingRegions=[ { 'RegionName': 'string' }, ], RemoveOperatingRegions=[ { 'RegionName': 'string' }, ], AddOrganizationalUnitExclusions=[ { 'OrganizationsEntityPath': 'string' }, ], RemoveOrganizationalUnitExclusions=[ { 'OrganizationsEntityPath': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** A resource discovery ID. * **Description** (*string*) -- A resource discovery description. * **AddOperatingRegions** (*list*) -- Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. * *(dict) --* Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **RemoveOperatingRegions** (*list*) -- Remove operating Regions. * *(dict) --* Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide* * **RegionName** *(string) --* The name of the operating Region you want to remove. * **AddOrganizationalUnitExclusions** (*list*) -- Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. Note: The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in Add or remove OU exclusions in the *Amazon VPC User Guide*. * *(dict) --* Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. * **OrganizationsEntityPath** *(string) --* An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a "/". Include all child OUs by ending the path with "/*". * Example 1 * Path to a child OU: "o-a1b2c3d4e5/r-f6g7h8i9j0example /ou-ghi0-awsccccc/ou-jkl0-awsddddd/" * In this example, "o-a1b2c3d4e5" is the organization ID, "r-f6g7h8i9j0example" is the root ID , "ou- ghi0-awsccccc" is an OU ID, and "ou-jkl0-awsddddd" is a child OU ID. * IPAM will not manage the IP addresses in accounts in the child OU. * Example 2 * Path where all child OUs will be part of the exclusion: "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou- ghi0-awsccccc/*" * In this example, IPAM will not manage the IP addresses in accounts in the OU ( "ou-ghi0-awsccccc") or in accounts in any OUs that are children of the OU. For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the *Amazon Web Services Identity and Access Management User Guide*. * **RemoveOrganizationalUnitExclusions** (*list*) -- Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. Note: The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in Add or remove OU exclusions in the *Amazon VPC User Guide*. * *(dict) --* Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the *Amazon VPC IPAM User Guide*. * **OrganizationsEntityPath** *(string) --* An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a "/". Include all child OUs by ending the path with "/*". * Example 1 * Path to a child OU: "o-a1b2c3d4e5/r-f6g7h8i9j0example /ou-ghi0-awsccccc/ou-jkl0-awsddddd/" * In this example, "o-a1b2c3d4e5" is the organization ID, "r-f6g7h8i9j0example" is the root ID , "ou- ghi0-awsccccc" is an OU ID, and "ou-jkl0-awsddddd" is a child OU ID. * IPAM will not manage the IP addresses in accounts in the child OU. * Example 2 * Path where all child OUs will be part of the exclusion: "o-a1b2c3d4e5/r-f6g7h8i9j0example/ou- ghi0-awsccccc/*" * In this example, IPAM will not manage the IP addresses in accounts in the OU ( "ou-ghi0-awsccccc") or in accounts in any OUs that are children of the OU. For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the *Amazon Web Services Identity and Access Management User Guide*. Return type: dict Returns: **Response Syntax** { 'IpamResourceDiscovery': { 'OwnerId': 'string', 'IpamResourceDiscoveryId': 'string', 'IpamResourceDiscoveryArn': 'string', 'IpamResourceDiscoveryRegion': 'string', 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'IsDefault': True|False, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OrganizationalUnitExclusions': [ { 'OrganizationsEntityPath': 'string' }, ] } } **Response Structure** * *(dict) --* * **IpamResourceDiscovery** *(dict) --* A resource discovery. * **OwnerId** *(string) --* The ID of the owner. * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **IpamResourceDiscoveryArn** *(string) --* The resource discovery Amazon Resource Name (ARN). * **IpamResourceDiscoveryRegion** *(string) --* The resource discovery Region. * **Description** *(string) --* The resource discovery description. * **OperatingRegions** *(list) --* The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **IsDefault** *(boolean) --* Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM. * **State** *(string) --* The lifecycle state of the resource discovery. * "create-in-progress" - Resource discovery is being created. * "create-complete" - Resource discovery creation is complete. * "create-failed" - Resource discovery creation has failed. * "modify-in-progress" - Resource discovery is being modified. * "modify-complete" - Resource discovery modification is complete. * "modify-failed" - Resource discovery modification has failed. * "delete-in-progress" - Resource discovery is being deleted. * "delete-complete" - Resource discovery deletion is complete. * "delete-failed" - Resource discovery deletion has failed. * "isolate-in-progress" - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. * "isolate-complete" - Resource discovery isolation is complete. * "restore-in-progress" - Amazon Web Services account that created the resource discovery and was isolated has been restored. * **Tags** *(list) --* A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OrganizationalUnitExclusions** *(list) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * *(dict) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * **OrganizationsEntityPath** *(string) --* An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the *Amazon Web Services Identity and Access Management User Guide*. EC2 / Client / send_diagnostic_interrupt send_diagnostic_interrupt ************************* EC2.Client.send_diagnostic_interrupt(**kwargs) Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a *kernel panic* (on Linux instances), or a *blue screen*/*stop error* (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a *non- maskable interrupt* (NMI). In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace. Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks. For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.send_diagnostic_interrupt( InstanceId='string', DryRun=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None EC2 / Client / start_network_insights_access_scope_analysis start_network_insights_access_scope_analysis ******************************************** EC2.Client.start_network_insights_access_scope_analysis(**kwargs) Starts analyzing the specified Network Access Scope. See also: AWS API Documentation **Request Syntax** response = client.start_network_insights_access_scope_analysis( NetworkInsightsAccessScopeId='string', DryRun=True|False, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string' ) Parameters: * **NetworkInsightsAccessScopeId** (*string*) -- **[REQUIRED]** The ID of the Network Access Scope. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The tags to apply. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- **[REQUIRED]** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAccessScopeAnalysis': { 'NetworkInsightsAccessScopeAnalysisId': 'string', 'NetworkInsightsAccessScopeAnalysisArn': 'string', 'NetworkInsightsAccessScopeId': 'string', 'Status': 'running'|'succeeded'|'failed', 'StatusMessage': 'string', 'WarningMessage': 'string', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'FindingsFound': 'true'|'false'|'unknown', 'AnalyzedEniCount': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **NetworkInsightsAccessScopeAnalysis** *(dict) --* The Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisId** *(string) --* The ID of the Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisArn** *(string) --* The Amazon Resource Name (ARN) of the Network Access Scope analysis. * **NetworkInsightsAccessScopeId** *(string) --* The ID of the Network Access Scope. * **Status** *(string) --* The status. * **StatusMessage** *(string) --* The status message. * **WarningMessage** *(string) --* The warning message. * **StartDate** *(datetime) --* The analysis start date. * **EndDate** *(datetime) --* The analysis end date. * **FindingsFound** *(string) --* Indicates whether there are findings. * **AnalyzedEniCount** *(integer) --* The number of network interfaces analyzed. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / search_transit_gateway_routes search_transit_gateway_routes ***************************** EC2.Client.search_transit_gateway_routes(**kwargs) Searches for routes in the specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.search_transit_gateway_routes( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- **[REQUIRED]** 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" | "static"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of routes to return. If a value is not provided, the default is 1000. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Routes': [ { 'DestinationCidrBlock': 'string', 'PrefixListId': 'string', 'TransitGatewayRouteTableAnnouncementId': 'string', 'TransitGatewayAttachments': [ { 'ResourceId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function' }, ], 'Type': 'static'|'propagated', 'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted' }, ], 'AdditionalRoutesAvailable': True|False } **Response Structure** * *(dict) --* * **Routes** *(list) --* Information about the routes. * *(dict) --* Describes a route for a transit gateway route table. * **DestinationCidrBlock** *(string) --* The CIDR block used for destination matches. * **PrefixListId** *(string) --* The ID of the prefix list used for destination matches. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. * **TransitGatewayAttachments** *(list) --* The attachments. * *(dict) --* Describes a route attachment. * **ResourceId** *(string) --* The ID of the resource. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **Type** *(string) --* The route type. * **State** *(string) --* The state of the route. * **AdditionalRoutesAvailable** *(boolean) --* Indicates whether there are additional routes available. EC2 / Client / describe_import_snapshot_tasks describe_import_snapshot_tasks ****************************** EC2.Client.describe_import_snapshot_tasks(**kwargs) Describes your import snapshot tasks. See also: AWS API Documentation **Request Syntax** response = client.describe_import_snapshot_tasks( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ImportTaskIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ImportTaskIds** (*list*) -- A list of import snapshot task IDs. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- A token that indicates the next page of results. Return type: dict Returns: **Response Syntax** { 'ImportSnapshotTasks': [ { 'Description': 'string', 'ImportTaskId': 'string', 'SnapshotTaskDetail': { 'Description': 'string', 'DiskImageSize': 123.0, 'Encrypted': True|False, 'Format': 'string', 'KmsKeyId': 'string', 'Progress': 'string', 'SnapshotId': 'string', 'Status': 'string', 'StatusMessage': 'string', 'Url': 'string', 'UserBucket': { 'S3Bucket': 'string', 'S3Key': 'string' } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ImportSnapshotTasks** *(list) --* A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. * *(dict) --* Describes an import snapshot task. * **Description** *(string) --* A description of the import snapshot task. * **ImportTaskId** *(string) --* The ID of the import snapshot task. * **SnapshotTaskDetail** *(dict) --* Describes an import snapshot task. * **Description** *(string) --* The description of the disk image being imported. * **DiskImageSize** *(float) --* The size of the disk in the snapshot, in GiB. * **Encrypted** *(boolean) --* Indicates whether the snapshot is encrypted. * **Format** *(string) --* The format of the disk image from which the snapshot is created. * **KmsKeyId** *(string) --* The identifier for the KMS key that was used to create the encrypted snapshot. * **Progress** *(string) --* The percentage of completion for the import snapshot task. * **SnapshotId** *(string) --* The snapshot ID of the disk being imported. * **Status** *(string) --* A brief status for the import snapshot task. * **StatusMessage** *(string) --* A detailed status message for the import snapshot task. * **Url** *(string) --* The URL of the disk image from which the snapshot is created. * **UserBucket** *(dict) --* The Amazon S3 bucket for the disk image. * **S3Bucket** *(string) --* The Amazon S3 bucket from which the disk image was created. * **S3Key** *(string) --* The file name of the disk image. * **Tags** *(list) --* The tags for the import snapshot task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to get the next page of results. This value is "null" when there are no more results to return. EC2 / Client / describe_elastic_gpus describe_elastic_gpus ********************* EC2.Client.describe_elastic_gpus(**kwargs) Note: Amazon Elastic Graphics reached end of life on January 8, 2024. Describes the Elastic Graphics accelerator associated with your instances. See also: AWS API Documentation **Request Syntax** response = client.describe_elastic_gpus( ElasticGpuIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **ElasticGpuIds** (*list*) -- The Elastic Graphics accelerator IDs. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'ElasticGpuSet': [ { 'ElasticGpuId': 'string', 'AvailabilityZone': 'string', 'ElasticGpuType': 'string', 'ElasticGpuHealth': { 'Status': 'OK'|'IMPAIRED' }, 'ElasticGpuState': 'ATTACHED', 'InstanceId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'MaxResults': 123, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ElasticGpuSet** *(list) --* Information about the Elastic Graphics accelerators. * *(dict) --* Note: Amazon Elastic Graphics reached end of life on January 8, 2024. Describes an Elastic Graphics accelerator. * **ElasticGpuId** *(string) --* The ID of the Elastic Graphics accelerator. * **AvailabilityZone** *(string) --* The Availability Zone in the which the Elastic Graphics accelerator resides. * **ElasticGpuType** *(string) --* The type of Elastic Graphics accelerator. * **ElasticGpuHealth** *(dict) --* The status of the Elastic Graphics accelerator. * **Status** *(string) --* The health status. * **ElasticGpuState** *(string) --* The state of the Elastic Graphics accelerator. * **InstanceId** *(string) --* The ID of the instance to which the Elastic Graphics accelerator is attached. * **Tags** *(list) --* The tags assigned to the Elastic Graphics accelerator. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **MaxResults** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a Next-Token will be provided in the output that you can use to resume pagination. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / modify_instance_metadata_defaults modify_instance_metadata_defaults ********************************* EC2.Client.modify_instance_metadata_defaults(**kwargs) Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region. Note: To remove a parameter's account-level default setting, specify "no-preference". If an account-level setting is cleared with "no- preference", then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_instance_metadata_defaults( HttpTokens='optional'|'required'|'no-preference', HttpPutResponseHopLimit=123, HttpEndpoint='disabled'|'enabled'|'no-preference', InstanceMetadataTags='disabled'|'enabled'|'no-preference', DryRun=True|False ) Parameters: * **HttpTokens** (*string*) -- Indicates whether IMDSv2 is required. * "optional" – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. * "required" – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. * **HttpPutResponseHopLimit** (*integer*) -- The maximum number of hops that the metadata token can travel. To indicate no preference, specify "-1". Possible values: Integers from "1" to "64", and "-1" to indicate no preference * **HttpEndpoint** (*string*) -- Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed. * **InstanceMetadataTags** (*string*) -- Enables or disables access to an instance's tags from the instance metadata. For more information, see Work with instance tags using the instance metadata in the *Amazon EC2 User Guide*. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* If the request succeeds, the response returns "true". If the request fails, no response is returned, and instead an error message is returned. EC2 / Client / modify_transit_gateway modify_transit_gateway ********************** EC2.Client.modify_transit_gateway(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_transit_gateway( TransitGatewayId='string', Description='string', Options={ 'AddTransitGatewayCidrBlocks': [ 'string', ], 'RemoveTransitGatewayCidrBlocks': [ 'string', ], 'VpnEcmpSupport': 'enable'|'disable', 'DnsSupport': 'enable'|'disable', 'SecurityGroupReferencingSupport': 'enable'|'disable', 'AutoAcceptSharedAttachments': 'enable'|'disable', 'DefaultRouteTableAssociation': 'enable'|'disable', 'AssociationDefaultRouteTableId': 'string', 'DefaultRouteTablePropagation': 'enable'|'disable', 'PropagationDefaultRouteTableId': 'string', 'AmazonSideAsn': 123 }, DryRun=True|False ) Parameters: * **TransitGatewayId** (*string*) -- **[REQUIRED]** The ID of the transit gateway. * **Description** (*string*) -- The description for the transit gateway. * **Options** (*dict*) -- The options to modify. * **AddTransitGatewayCidrBlocks** *(list) --* Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6. * *(string) --* * **RemoveTransitGatewayCidrBlocks** *(list) --* Removes CIDR blocks for the transit gateway. * *(string) --* * **VpnEcmpSupport** *(string) --* Enable or disable Equal Cost Multipath Protocol support. * **DnsSupport** *(string) --* Enable or disable DNS support. * **SecurityGroupReferencingSupport** *(string) --* Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is disabled by default. For more information about security group referencing, see Security group referencing in the *Amazon Web Services Transit Gateways Guide*. * **AutoAcceptSharedAttachments** *(string) --* Enable or disable automatic acceptance of attachment requests. * **DefaultRouteTableAssociation** *(string) --* Enable or disable automatic association with the default association route table. * **AssociationDefaultRouteTableId** *(string) --* The ID of the default association route table. * **DefaultRouteTablePropagation** *(string) --* Enable or disable automatic propagation of routes to the default propagation route table. * **PropagationDefaultRouteTableId** *(string) --* The ID of the default propagation route table. * **AmazonSideAsn** *(integer) --* A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The modify ASN operation is not allowed on a transit gateway if it has the following attachments: * Dynamic VPN * Static VPN * Direct Connect Gateway * Connect You must first delete all transit gateway attachments configured prior to modifying the ASN on the transit gateway. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGateway': { 'TransitGatewayId': 'string', 'TransitGatewayArn': 'string', 'State': 'pending'|'available'|'modifying'|'deleting'|'deleted', 'OwnerId': 'string', 'Description': 'string', 'CreationTime': datetime(2015, 1, 1), 'Options': { 'AmazonSideAsn': 123, 'TransitGatewayCidrBlocks': [ 'string', ], 'AutoAcceptSharedAttachments': 'enable'|'disable', 'DefaultRouteTableAssociation': 'enable'|'disable', 'AssociationDefaultRouteTableId': 'string', 'DefaultRouteTablePropagation': 'enable'|'disable', 'PropagationDefaultRouteTableId': 'string', 'VpnEcmpSupport': 'enable'|'disable', 'DnsSupport': 'enable'|'disable', 'SecurityGroupReferencingSupport': 'enable'|'disable', 'MulticastSupport': 'enable'|'disable' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGateway** *(dict) --* Information about the transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **TransitGatewayArn** *(string) --* The Amazon Resource Name (ARN) of the transit gateway. * **State** *(string) --* The state of the transit gateway. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Description** *(string) --* The description of the transit gateway. * **CreationTime** *(datetime) --* The creation time. * **Options** *(dict) --* The transit gateway options. * **AmazonSideAsn** *(integer) --* A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. * **TransitGatewayCidrBlocks** *(list) --* The transit gateway CIDR blocks. * *(string) --* * **AutoAcceptSharedAttachments** *(string) --* Indicates whether attachment requests are automatically accepted. * **DefaultRouteTableAssociation** *(string) --* Indicates whether resource attachments are automatically associated with the default association route table. Enabled by default. If "defaultRouteTableAssociation" is set to "enable", Amazon Web Services Transit Gateway will create the default transit gateway route table. * **AssociationDefaultRouteTableId** *(string) --* The ID of the default association route table. * **DefaultRouteTablePropagation** *(string) --* Indicates whether resource attachments automatically propagate routes to the default propagation route table. Enabled by default. If "defaultRouteTablePropagation" is set to "enable", Amazon Web Services Transit Gateway will create the default transit gateway route table. * **PropagationDefaultRouteTableId** *(string) --* The ID of the default propagation route table. * **VpnEcmpSupport** *(string) --* Indicates whether Equal Cost Multipath Protocol support is enabled. * **DnsSupport** *(string) --* Indicates whether DNS support is enabled. * **SecurityGroupReferencingSupport** *(string) --* Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is disabled by default. * **MulticastSupport** *(string) --* Indicates whether multicast is enabled on the transit gateway * **Tags** *(list) --* The tags for the transit gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / delete_transit_gateway_route_table delete_transit_gateway_route_table ********************************** EC2.Client.delete_transit_gateway_route_table(**kwargs) Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.delete_transit_gateway_route_table( TransitGatewayRouteTableId='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTable': { 'TransitGatewayRouteTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'DefaultAssociationRouteTable': True|False, 'DefaultPropagationRouteTable': True|False, 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayRouteTable** *(dict) --* Information about the deleted transit gateway route table. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway route table. * **DefaultAssociationRouteTable** *(boolean) --* Indicates whether this is the default association route table for the transit gateway. * **DefaultPropagationRouteTable** *(boolean) --* Indicates whether this is the default propagation route table for the transit gateway. * **CreationTime** *(datetime) --* The creation time. * **Tags** *(list) --* Any tags assigned to the route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / import_volume import_volume ************* EC2.Client.import_volume(**kwargs) Note: 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. Creates an import volume task using metadata from the specified disk image. For information about the import manifest referenced by this API action, see VM Import Manifest. This API action is not supported by the Command Line Interface (CLI). See also: AWS API Documentation **Request Syntax** response = client.import_volume( DryRun=True|False, AvailabilityZone='string', Image={ 'Format': 'VMDK'|'RAW'|'VHD', 'Bytes': 123, 'ImportManifestUrl': 'string' }, Description='string', Volume={ 'Size': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AvailabilityZone** (*string*) -- **[REQUIRED]** The Availability Zone for the resulting EBS volume. * **Image** (*dict*) -- **[REQUIRED]** The disk image. * **Format** *(string) --* **[REQUIRED]** The disk image format. * **Bytes** *(integer) --* **[REQUIRED]** The size of the disk image, in GiB. * **ImportManifestUrl** *(string) --* **[REQUIRED]** A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the *Amazon Simple Storage Service Developer Guide*. For information about the import manifest referenced by this API action, see VM Import Manifest. * **Description** (*string*) -- A description of the volume. * **Volume** (*dict*) -- **[REQUIRED]** The volume size. * **Size** *(integer) --* **[REQUIRED]** The size of the volume, in GiB. Return type: dict Returns: **Response Syntax** { 'ConversionTask': { 'ConversionTaskId': 'string', 'ExpirationTime': 'string', 'ImportInstance': { 'Description': 'string', 'InstanceId': 'string', 'Platform': 'Windows', 'Volumes': [ { 'AvailabilityZone': 'string', 'BytesConverted': 123, 'Description': 'string', 'Image': { 'Checksum': 'string', 'Format': 'VMDK'|'RAW'|'VHD', 'ImportManifestUrl': 'string', 'Size': 123 }, 'Status': 'string', 'StatusMessage': 'string', 'Volume': { 'Id': 'string', 'Size': 123 } }, ] }, 'ImportVolume': { 'AvailabilityZone': 'string', 'BytesConverted': 123, 'Description': 'string', 'Image': { 'Checksum': 'string', 'Format': 'VMDK'|'RAW'|'VHD', 'ImportManifestUrl': 'string', 'Size': 123 }, 'Volume': { 'Id': 'string', 'Size': 123 } }, 'State': 'active'|'cancelling'|'cancelled'|'completed', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **ConversionTask** *(dict) --* Information about the conversion task. * **ConversionTaskId** *(string) --* The ID of the conversion task. * **ExpirationTime** *(string) --* The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task. * **ImportInstance** *(dict) --* If the task is for importing an instance, this contains information about the import instance task. * **Description** *(string) --* A description of the task. * **InstanceId** *(string) --* The ID of the instance. * **Platform** *(string) --* The instance operating system. * **Volumes** *(list) --* The volumes. * *(dict) --* Describes an import volume task. * **AvailabilityZone** *(string) --* The Availability Zone where the resulting instance will reside. * **BytesConverted** *(integer) --* The number of bytes converted so far. * **Description** *(string) --* A description of the task. * **Image** *(dict) --* The image. * **Checksum** *(string) --* The checksum computed for the disk image. * **Format** *(string) --* The disk image format. * **ImportManifestUrl** *(string) --* A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the *Amazon Simple Storage Service Developer Guide*. For information about the import manifest referenced by this API action, see VM Import Manifest. * **Size** *(integer) --* The size of the disk image, in GiB. * **Status** *(string) --* The status of the import of this particular disk image. * **StatusMessage** *(string) --* The status information or errors related to the disk image. * **Volume** *(dict) --* The volume. * **Id** *(string) --* The volume identifier. * **Size** *(integer) --* The size of the volume, in GiB. * **ImportVolume** *(dict) --* If the task is for importing a volume, this contains information about the import volume task. * **AvailabilityZone** *(string) --* The Availability Zone where the resulting volume will reside. * **BytesConverted** *(integer) --* The number of bytes converted so far. * **Description** *(string) --* The description you provided when starting the import volume task. * **Image** *(dict) --* The image. * **Checksum** *(string) --* The checksum computed for the disk image. * **Format** *(string) --* The disk image format. * **ImportManifestUrl** *(string) --* A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the *Amazon Simple Storage Service Developer Guide*. For information about the import manifest referenced by this API action, see VM Import Manifest. * **Size** *(integer) --* The size of the disk image, in GiB. * **Volume** *(dict) --* The volume. * **Id** *(string) --* The volume identifier. * **Size** *(integer) --* The size of the volume, in GiB. * **State** *(string) --* The state of the conversion task. * **StatusMessage** *(string) --* The status message related to the conversion task. * **Tags** *(list) --* Any tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / modify_fleet modify_fleet ************ EC2.Client.modify_fleet(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_fleet( DryRun=True|False, ExcessCapacityTerminationPolicy='no-termination'|'termination', LaunchTemplateConfigs=[ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'Affinity': 'string', 'GroupName': 'string', 'PartitionNumber': 123, 'HostId': 'string', 'Tenancy': 'default'|'dedicated'|'host', 'SpreadDomain': 'string', 'HostResourceGroupArn': 'string', 'GroupId': 'string', 'AvailabilityZone': 'string' }, 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ], 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string' }, ] }, ], FleetId='string', TargetCapacitySpecification={ 'TotalTargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'SpotTargetCapacity': 123, 'DefaultTargetCapacityType': 'spot'|'on-demand'|'capacity-block', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units' }, Context='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- 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. Supported only for fleets of type "maintain". * **LaunchTemplateConfigs** (*list*) -- The launch template and overrides. * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template to use. You must specify either the launch template ID or launch template name in the request. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. For fleets of type "request" and "maintain", a maximum of 300 items is allowed across all launch templates. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. "mac1.metal" is not supported as a launch template override. Note: If you specify "InstanceType", you can't specify "InstanceRequirements". * **MaxPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message. * **SubnetId** *(string) --* The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, "subnet-1234abcdeexample1, subnet- 0987cdef6example2"). A request of type "instant" can have only one subnet ID. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowest-price" and "price-capacity-optimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If the On-Demand "AllocationStrategy" is set to "prioritized", EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacity- optimized-prioritized", EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides. * **Placement** *(dict) --* The location where the instance launched, if applicable. * **Affinity** *(string) --* The affinity setting for the instance on the Dedicated Host. This parameter is not supported for CreateFleet or ImportInstance. * **GroupName** *(string) --* The name of the placement group that the instance is in. If you specify "GroupName", you can't specify "GroupId". * **PartitionNumber** *(integer) --* The number of the partition that the instance is in. Valid only if the placement group strategy is set to "partition". This parameter is not supported for CreateFleet. * **HostId** *(string) --* The ID of the Dedicated Host on which the instance resides. This parameter is not supported for CreateFleet or ImportInstance. * **Tenancy** *(string) --* The tenancy of the instance. An instance with a tenancy of "dedicated" runs on single-tenant hardware. This parameter is not supported for CreateFleet. The "host" tenancy is not supported for ImportInstance or for T3 instances that are configured for the "unlimited" CPU credit option. * **SpreadDomain** *(string) --* Reserved for future use. * **HostResourceGroupArn** *(string) --* The ARN of the host resource group in which to launch the instances. If you specify this parameter, either omit the **Tenancy** parameter or set it to "host". This parameter is not supported for CreateFleet. * **GroupId** *(string) --* The ID of the placement group that the instance is in. If you specify "GroupId", you can't specify "GroupName". * **AvailabilityZone** *(string) --* The Availability Zone of the instance. If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region. This parameter is not supported for CreateFleet. * **BlockDeviceMappings** *(list) --* The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch. Supported only for fleets of type "instant". For more information, see Block device mappings for volumes on Amazon EC2 instances in the *Amazon EC2 User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. To override a block device mapping specified in the launch template: * Specify the exact same "DeviceName" here as specified in the launch template. * Only specify the parameters you want to change. * Any parameters you don't specify here will keep their original launch template values. To add a new block device mapping: * Specify a "DeviceName" that doesn't exist in the launch template. * Specify all desired parameters here. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeralN"). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for "ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserve data when an instance is terminated in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by CreateFleet, RequestSpotInstances, and RunInstances. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* **[REQUIRED]** The minimum and maximum number of vCPUs. * **Min** *(integer) --* **[REQUIRED]** The minimum number of vCPUs. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum number of vCPUs. To specify no maximum limit, omit this parameter. * **MemoryMiB** *(dict) --* **[REQUIRED]** The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* **[REQUIRED]** The minimum amount of memory, in MiB. To specify no minimum limit, specify "0". * **Max** *(integer) --* The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance family, type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On- Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To indicate no price protection threshold, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of network interfaces. To specify no maximum limit, omit this parameter. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set "Max" to "0". * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i- 12tb" | "u7in-16tb" | "u7in-24tb" | "u7in- 32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **ImageId** *(string) --* The ID of the AMI in the format "ami- 17characters00000". Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter: * "resolve:ssm:public-parameter" To reference a parameter stored in the same account: * "resolve:ssm:parameter-name" * "resolve:ssm:parameter-name:version-number" * "resolve:ssm:parameter-name:label" To reference a parameter shared from another Amazon Web Services account: * "resolve:ssm:parameter-ARN" * "resolve:ssm:parameter-ARN:version-number" * "resolve:ssm:parameter-ARN:label" For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. Note: This parameter is only available for fleets of type "instant". For fleets of type "maintain" and "request", you must specify the AMI ID in the launch template. * **FleetId** (*string*) -- **[REQUIRED]** The ID of the EC2 Fleet. * **TargetCapacitySpecification** (*dict*) -- The size of the EC2 Fleet. * **TotalTargetCapacity** *(integer) --* **[REQUIRED]** The number of units to request, filled using the default target capacity type. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. * **SpotTargetCapacity** *(integer) --* The number of Spot units to request. * **DefaultTargetCapacityType** *(string) --* The default target capacity type. * **TargetCapacityUnitType** *(string) --* The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection. Default: "units" (the number of instances) * **Context** (*string*) -- Reserved. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* If the request succeeds, the response returns "true". If the request fails, no response is returned, and instead an error message is returned. EC2 / Client / get_groups_for_capacity_reservation get_groups_for_capacity_reservation *********************************** EC2.Client.get_groups_for_capacity_reservation(**kwargs) Lists the resource groups to which a Capacity Reservation has been added. See also: AWS API Documentation **Request Syntax** response = client.get_groups_for_capacity_reservation( CapacityReservationId='string', NextToken='string', MaxResults=123, DryRun=True|False ) Parameters: * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own. * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'CapacityReservationGroups': [ { 'GroupArn': 'string', 'OwnerId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **CapacityReservationGroups** *(list) --* Information about the resource groups to which the Capacity Reservation has been added. * *(dict) --* Describes a resource group to which a Capacity Reservation has been added. * **GroupArn** *(string) --* The ARN of the resource group. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the resource group. EC2 / Client / export_client_vpn_client_certificate_revocation_list export_client_vpn_client_certificate_revocation_list **************************************************** EC2.Client.export_client_vpn_client_certificate_revocation_list(**kwargs) Downloads the client certificate revocation list for the specified Client VPN endpoint. See also: AWS API Documentation **Request Syntax** response = client.export_client_vpn_client_certificate_revocation_list( ClientVpnEndpointId='string', DryRun=True|False ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CertificateRevocationList': 'string', 'Status': { 'Code': 'pending'|'active', 'Message': 'string' } } **Response Structure** * *(dict) --* * **CertificateRevocationList** *(string) --* Information about the client certificate revocation list. * **Status** *(dict) --* The current state of the client certificate revocation list. * **Code** *(string) --* The state of the client certificate revocation list. * **Message** *(string) --* A message about the status of the client certificate revocation list, if applicable. EC2 / Client / create_ipam_scope create_ipam_scope ***************** EC2.Client.create_ipam_scope(**kwargs) Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. For more information, see Add a scope in the *Amazon VPC IPAM User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_ipam_scope( DryRun=True|False, IpamId='string', Description='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamId** (*string*) -- **[REQUIRED]** The ID of the IPAM for which you're creating this scope. * **Description** (*string*) -- A description for the scope you're creating. * **TagSpecifications** (*list*) -- 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'IpamScope': { 'OwnerId': 'string', 'IpamScopeId': 'string', 'IpamScopeArn': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'IpamScopeType': 'public'|'private', 'IsDefault': True|False, 'Description': 'string', 'PoolCount': 123, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **IpamScope** *(dict) --* Information about the created scope. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the scope. * **IpamScopeId** *(string) --* The ID of the scope. * **IpamScopeArn** *(string) --* The Amazon Resource Name (ARN) of the scope. * **IpamArn** *(string) --* The ARN of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM scope. * **IpamScopeType** *(string) --* The type of the scope. * **IsDefault** *(boolean) --* Defines if the scope is the default scope or not. * **Description** *(string) --* The description of the scope. * **PoolCount** *(integer) --* The number of pools in the scope. * **State** *(string) --* The state of the IPAM scope. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_reserved_instances_offerings describe_reserved_instances_offerings ************************************* EC2.Client.describe_reserved_instances_offerings(**kwargs) Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances. For more information, see Sell in the Reserved Instance Marketplace in the *Amazon EC2 User Guide*. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_instances_offerings( AvailabilityZone='string', IncludeMarketplace=True|False, InstanceType='a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', MaxDuration=123, MaxInstanceCount=123, MinDuration=123, OfferingClass='standard'|'convertible', ProductDescription='Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)', ReservedInstancesOfferingIds=[ 'string', ], AvailabilityZoneId='string', DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], InstanceTenancy='default'|'dedicated'|'host', OfferingType='Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront', NextToken='string', MaxResults=123 ) Parameters: * **AvailabilityZone** (*string*) -- The Availability Zone in which the Reserved Instance can be used. Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. * **IncludeMarketplace** (*boolean*) -- Include Reserved Instance Marketplace offerings in the response. * **InstanceType** (*string*) -- The instance type that the reservation will cover (for example, "m1.small"). For more information, see Amazon EC2 instance types in the *Amazon EC2 User Guide*. * **MaxDuration** (*integer*) -- The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years) * **MaxInstanceCount** (*integer*) -- The maximum number of instances to filter when searching for offerings. Default: 20 * **MinDuration** (*integer*) -- The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month) * **OfferingClass** (*string*) -- The offering class of the Reserved Instance. Can be "standard" or "convertible". * **ProductDescription** (*string*) -- The Reserved Instance product platform description. Instances that include "(Amazon VPC)" in the description are for use with Amazon VPC. * **ReservedInstancesOfferingIds** (*list*) -- One or more Reserved Instances offering IDs. * *(string) --* * **AvailabilityZoneId** (*string*) -- The ID of the Availability Zone. Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "availability-zone" - The Availability Zone where the Reserved Instance can be used. * "availability-zone-id" - The ID of 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 Amazon Web Services and the Reserved Instance Marketplace are listed. * "product-description" - The Reserved Instance product platform description ( "Linux/UNIX" | "Linux with SQL Server Standard" | "Linux with SQL Server Web" | "Linux with SQL Server Enterprise" | "SUSE Linux" | "Red Hat Enterprise Linux" | "Red Hat Enterprise Linux with HA" | "Windows" | "Windows with SQL Server Standard" | "Windows with SQL Server Web" | "Windows with SQL Server Enterprise"). * "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). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceTenancy** (*string*) -- 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" * **OfferingType** (*string*) -- 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. * **NextToken** (*string*) -- The token to retrieve the next page of results. * **MaxResults** (*integer*) -- 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 Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ReservedInstancesOfferings': [ { 'CurrencyCode': 'USD', 'InstanceTenancy': 'default'|'dedicated'|'host', 'Marketplace': True|False, 'OfferingClass': 'standard'|'convertible', 'OfferingType': 'Heavy Utilization'|'Medium Utilization'|'Light Utilization'|'No Upfront'|'Partial Upfront'|'All Upfront', 'PricingDetails': [ { 'Count': 123, 'Price': 123.0 }, ], 'RecurringCharges': [ { 'Amount': 123.0, 'Frequency': 'Hourly' }, ], 'Scope': 'Availability Zone'|'Region', 'AvailabilityZoneId': 'string', 'ReservedInstancesOfferingId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'AvailabilityZone': 'string', 'Duration': 123, 'UsagePrice': ..., 'FixedPrice': ..., 'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)' }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeReservedInstancesOfferings. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **ReservedInstancesOfferings** *(list) --* A list of Reserved Instances offerings. * *(dict) --* Describes a Reserved Instance offering. * **CurrencyCode** *(string) --* The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is "USD". * **InstanceTenancy** *(string) --* The tenancy of the instance. * **Marketplace** *(boolean) --* Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it's a Reserved Instance Marketplace offering, this is "true". * **OfferingClass** *(string) --* If "convertible" it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If "standard", it is not possible to perform an exchange. * **OfferingType** *(string) --* The Reserved Instance offering type. * **PricingDetails** *(list) --* The pricing details of the Reserved Instance offering. * *(dict) --* Describes a Reserved Instance offering. * **Count** *(integer) --* The number of reservations available for the price. * **Price** *(float) --* The price per instance. * **RecurringCharges** *(list) --* The recurring charge tag assigned to the resource. * *(dict) --* Describes a recurring charge. * **Amount** *(float) --* The amount of the recurring charge. * **Frequency** *(string) --* The frequency of the recurring charge. * **Scope** *(string) --* Whether the Reserved Instance is applied to instances in a Region or an Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone. * **ReservedInstancesOfferingId** *(string) --* The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made. * **InstanceType** *(string) --* The instance type on which the Reserved Instance can be used. * **AvailabilityZone** *(string) --* The Availability Zone in which the Reserved Instance can be used. * **Duration** *(integer) --* The duration of the Reserved Instance, in seconds. * **UsagePrice** *(float) --* The usage price of the Reserved Instance, per hour. * **FixedPrice** *(float) --* The purchase price of the Reserved Instance. * **ProductDescription** *(string) --* The Reserved Instance product platform description. EC2 / Client / get_ipam_discovered_accounts get_ipam_discovered_accounts **************************** EC2.Client.get_ipam_discovered_accounts(**kwargs) Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_discovered_accounts( DryRun=True|False, IpamResourceDiscoveryId='string', DiscoveryRegion='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** A resource discovery ID. * **DiscoveryRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region that the account information is returned from. * **Filters** (*list*) -- Discovered account filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- Specify the pagination token from a previous request to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of discovered accounts to return in one page of results. Return type: dict Returns: **Response Syntax** { 'IpamDiscoveredAccounts': [ { 'AccountId': 'string', 'DiscoveryRegion': 'string', 'FailureReason': { 'Code': 'assume-role-failure'|'throttling-failure'|'unauthorized-failure', 'Message': 'string' }, 'LastAttemptedDiscoveryTime': datetime(2015, 1, 1), 'LastSuccessfulDiscoveryTime': datetime(2015, 1, 1), 'OrganizationalUnitId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IpamDiscoveredAccounts** *(list) --* Discovered accounts. * *(dict) --* An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. * **AccountId** *(string) --* The account ID. * **DiscoveryRegion** *(string) --* The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region. * **FailureReason** *(dict) --* The resource discovery failure reason. * **Code** *(string) --* The discovery failure code. * "assume-role-failure" - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following: * SLR has not been created yet and IPAM is still creating it. * You have opted-out of the IPAM home Region. * Account you are using as your IPAM account has been suspended. * "throttling-failure" - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR. * "unauthorized-failure" - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the *Amazon Elastic Compute Cloud API Reference*. * **Message** *(string) --* The discovery failure message. * **LastAttemptedDiscoveryTime** *(datetime) --* The last attempted resource discovery time. * **LastSuccessfulDiscoveryTime** *(datetime) --* The last successful resource discovery time. * **OrganizationalUnitId** *(string) --* The ID of an Organizational Unit in Amazon Web Services Organizations. * **NextToken** *(string) --* Specify the pagination token from a previous request to retrieve the next page of results. EC2 / Client / detach_classic_link_vpc detach_classic_link_vpc *********************** EC2.Client.detach_classic_link_vpc(**kwargs) Note: This action is deprecated. 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. See also: AWS API Documentation **Request Syntax** response = client.detach_classic_link_vpc( DryRun=True|False, InstanceId='string', VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance to unlink from the VPC. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC to which the instance is linked. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / reject_transit_gateway_peering_attachment reject_transit_gateway_peering_attachment ***************************************** EC2.Client.reject_transit_gateway_peering_attachment(**kwargs) Rejects a transit gateway peering attachment request. See also: AWS API Documentation **Request Syntax** response = client.reject_transit_gateway_peering_attachment( TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the transit gateway peering attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPeeringAttachment': { 'TransitGatewayAttachmentId': 'string', 'AccepterTransitGatewayAttachmentId': 'string', 'RequesterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'AccepterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'Options': { 'DynamicRouting': 'enable'|'disable' }, 'Status': { 'Code': 'string', 'Message': 'string' }, 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayPeeringAttachment** *(dict) --* The transit gateway peering attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway peering attachment. * **AccepterTransitGatewayAttachmentId** *(string) --* The ID of the accepter transit gateway attachment. * **RequesterTgwInfo** *(dict) --* Information about the requester transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **AccepterTgwInfo** *(dict) --* Information about the accepter transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **Options** *(dict) --* Details about the transit gateway peering attachment. * **DynamicRouting** *(string) --* Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment. * **Status** *(dict) --* The status of the transit gateway peering attachment. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message, if applicable. * **State** *(string) --* The state of the transit gateway peering attachment. Note that the "initiating" state has been deprecated. * **CreationTime** *(datetime) --* The time the transit gateway peering attachment was created. * **Tags** *(list) --* The tags for the transit gateway peering attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / get_transit_gateway_policy_table_associations get_transit_gateway_policy_table_associations ********************************************* EC2.Client.get_transit_gateway_policy_table_associations(**kwargs) Gets a list of the transit gateway policy table associations. See also: AWS API Documentation **Request Syntax** response = client.get_transit_gateway_policy_table_associations( TransitGatewayPolicyTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayPolicyTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway policy table. * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'TransitGatewayPolicyTableId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Associations** *(list) --* Returns details about the transit gateway policy table association. * *(dict) --* Describes a transit gateway policy table association. * **TransitGatewayPolicyTableId** *(string) --* The ID of the transit gateway policy table. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway attachment. * **ResourceId** *(string) --* The resource ID of the transit gateway attachment. * **ResourceType** *(string) --* The resource type for the transit gateway policy table association. * **State** *(string) --* The state of the transit gateway policy table association. * **NextToken** *(string) --* The token for the next page of results. EC2 / Client / modify_verified_access_endpoint modify_verified_access_endpoint ******************************* EC2.Client.modify_verified_access_endpoint(**kwargs) Modifies the configuration of the specified Amazon Web Services Verified Access endpoint. See also: AWS API Documentation **Request Syntax** response = client.modify_verified_access_endpoint( VerifiedAccessEndpointId='string', VerifiedAccessGroupId='string', LoadBalancerOptions={ 'SubnetIds': [ 'string', ], 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, NetworkInterfaceOptions={ 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, Description='string', ClientToken='string', DryRun=True|False, RdsOptions={ 'SubnetIds': [ 'string', ], 'Port': 123, 'RdsEndpoint': 'string' }, CidrOptions={ 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] } ) Parameters: * **VerifiedAccessEndpointId** (*string*) -- **[REQUIRED]** The ID of the Verified Access endpoint. * **VerifiedAccessGroupId** (*string*) -- The ID of the Verified Access group. * **LoadBalancerOptions** (*dict*) -- The load balancer details if creating the Verified Access endpoint as >>``<>``<= 2 hours, for example, "0-2" or "20-23". * The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours. For more information about cron expressions, see cron on the *Wikipedia website*. Return type: dict Returns: **Response Syntax** { 'InstanceEventWindow': { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **InstanceEventWindow** *(dict) --* Information about the event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / create_local_gateway_route_table_vpc_association create_local_gateway_route_table_vpc_association ************************************************ EC2.Client.create_local_gateway_route_table_vpc_association(**kwargs) Associates the specified VPC with the specified local gateway route table. See also: AWS API Documentation **Request Syntax** response = client.create_local_gateway_route_table_vpc_association( LocalGatewayRouteTableId='string', VpcId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. * **TagSpecifications** (*list*) -- The tags to assign to the local gateway route table VPC association. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTableVpcAssociation': { 'LocalGatewayRouteTableVpcAssociationId': 'string', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'VpcId': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **LocalGatewayRouteTableVpcAssociation** *(dict) --* Information about the association. * **LocalGatewayRouteTableVpcAssociationId** *(string) --* The ID of the association. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table for the association. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **VpcId** *(string) --* The ID of the VPC. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table for the association. * **State** *(string) --* The state of the association. * **Tags** *(list) --* The tags assigned to the association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_snapshot_attribute describe_snapshot_attribute *************************** EC2.Client.describe_snapshot_attribute(**kwargs) Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see Amazon EBS snapshots in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_snapshot_attribute( Attribute='productCodes'|'createVolumePermission', SnapshotId='string', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The snapshot attribute you would like to view. * **SnapshotId** (*string*) -- **[REQUIRED]** The ID of the EBS snapshot. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'SnapshotId': 'string', 'CreateVolumePermissions': [ { 'UserId': 'string', 'Group': 'all' }, ] } **Response Structure** * *(dict) --* * **ProductCodes** *(list) --* The product codes. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. * **SnapshotId** *(string) --* The ID of the EBS snapshot. * **CreateVolumePermissions** *(list) --* The users and groups that have the permissions for creating volumes from the snapshot. * *(dict) --* Describes the user or group to be added or removed from the list of create volume permissions for a volume. * **UserId** *(string) --* The ID of the Amazon Web Services account to be added or removed. * **Group** *(string) --* The group to be added or removed. The possible value is "all". **Examples** This example describes the "createVolumePermission" attribute on a snapshot with the snapshot ID of "snap-066877671789bd71b". response = client.describe_snapshot_attribute( Attribute='createVolumePermission', SnapshotId='snap-066877671789bd71b', ) print(response) Expected Output: { 'CreateVolumePermissions': [ ], 'SnapshotId': 'snap-066877671789bd71b', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / replace_network_acl_entry replace_network_acl_entry ************************* EC2.Client.replace_network_acl_entry(**kwargs) Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.replace_network_acl_entry( DryRun=True|False, NetworkAclId='string', RuleNumber=123, Protocol='string', RuleAction='allow'|'deny', Egress=True|False, CidrBlock='string', Ipv6CidrBlock='string', IcmpTypeCode={ 'Code': 123, 'Type': 123 }, PortRange={ 'From': 123, 'To': 123 } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclId** (*string*) -- **[REQUIRED]** The ID of the ACL. * **RuleNumber** (*integer*) -- **[REQUIRED]** The rule number of the entry to replace. * **Protocol** (*string*) -- **[REQUIRED]** 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. * **RuleAction** (*string*) -- **[REQUIRED]** Indicates whether to allow or deny the traffic that matches the rule. * **Egress** (*boolean*) -- **[REQUIRED]** Indicates whether to replace the egress rule. Default: If no value is specified, we replace the ingress rule. * **CidrBlock** (*string*) -- The IPv4 network range to allow or deny, in CIDR notation (for example "172.16.0.0/24"). * **Ipv6CidrBlock** (*string*) -- The IPv6 network range to allow or deny, in CIDR notation (for example "2001:bd8:1234:1a00::/64"). * **IcmpTypeCode** (*dict*) -- ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **PortRange** (*dict*) -- TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. Returns: None **Examples** This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet. response = client.replace_network_acl_entry( CidrBlock='203.0.113.12/24', Egress=False, NetworkAclId='acl-5fb85d36', PortRange={ 'From': 53, 'To': 53, }, Protocol='17', RuleAction='allow', RuleNumber=100, ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_local_gateway_virtual_interface_group delete_local_gateway_virtual_interface_group ******************************************** EC2.Client.delete_local_gateway_virtual_interface_group(**kwargs) Delete the specified local gateway interface group. See also: AWS API Documentation **Request Syntax** response = client.delete_local_gateway_virtual_interface_group( LocalGatewayVirtualInterfaceGroupId='string', DryRun=True|False ) Parameters: * **LocalGatewayVirtualInterfaceGroupId** (*string*) -- **[REQUIRED]** The ID of the local gateway virtual interface group to delete. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayVirtualInterfaceGroup': { 'LocalGatewayVirtualInterfaceGroupId': 'string', 'LocalGatewayVirtualInterfaceIds': [ 'string', ], 'LocalGatewayId': 'string', 'OwnerId': 'string', 'LocalBgpAsn': 123, 'LocalBgpAsnExtended': 123, 'LocalGatewayVirtualInterfaceGroupArn': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'ConfigurationState': 'pending'|'incomplete'|'available'|'deleting'|'deleted' } } **Response Structure** * *(dict) --* * **LocalGatewayVirtualInterfaceGroup** *(dict) --* Information about the deleted local gateway virtual interface group. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **LocalGatewayVirtualInterfaceIds** *(list) --* The IDs of the virtual interfaces. * *(string) --* * **LocalGatewayId** *(string) --* The ID of the local gateway. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway virtual interface group. * **LocalBgpAsn** *(integer) --* The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP). * **LocalBgpAsnExtended** *(integer) --* The extended 32-bit ASN for the local BGP configuration. * **LocalGatewayVirtualInterfaceGroupArn** *(string) --* The Amazon Resource Number (ARN) of the local gateway virtual interface group. * **Tags** *(list) --* The tags assigned to the virtual interface group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ConfigurationState** *(string) --* The current state of the local gateway virtual interface group. EC2 / Client / detach_internet_gateway detach_internet_gateway *********************** EC2.Client.detach_internet_gateway(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.detach_internet_gateway( DryRun=True|False, InternetGatewayId='string', VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the internet gateway. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Returns: None **Examples** This example detaches the specified Internet gateway from the specified VPC. response = client.detach_internet_gateway( InternetGatewayId='igw-c0a643a9', VpcId='vpc-a01106c2', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_ipam_resource_discovery delete_ipam_resource_discovery ****************************** EC2.Client.delete_ipam_resource_discovery(**kwargs) Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. See also: AWS API Documentation **Request Syntax** response = client.delete_ipam_resource_discovery( DryRun=True|False, IpamResourceDiscoveryId='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** The IPAM resource discovery ID. Return type: dict Returns: **Response Syntax** { 'IpamResourceDiscovery': { 'OwnerId': 'string', 'IpamResourceDiscoveryId': 'string', 'IpamResourceDiscoveryArn': 'string', 'IpamResourceDiscoveryRegion': 'string', 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'IsDefault': True|False, 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OrganizationalUnitExclusions': [ { 'OrganizationsEntityPath': 'string' }, ] } } **Response Structure** * *(dict) --* * **IpamResourceDiscovery** *(dict) --* The IPAM resource discovery. * **OwnerId** *(string) --* The ID of the owner. * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **IpamResourceDiscoveryArn** *(string) --* The resource discovery Amazon Resource Name (ARN). * **IpamResourceDiscoveryRegion** *(string) --* The resource discovery Region. * **Description** *(string) --* The resource discovery description. * **OperatingRegions** *(list) --* The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **IsDefault** *(boolean) --* Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM. * **State** *(string) --* The lifecycle state of the resource discovery. * "create-in-progress" - Resource discovery is being created. * "create-complete" - Resource discovery creation is complete. * "create-failed" - Resource discovery creation has failed. * "modify-in-progress" - Resource discovery is being modified. * "modify-complete" - Resource discovery modification is complete. * "modify-failed" - Resource discovery modification has failed. * "delete-in-progress" - Resource discovery is being deleted. * "delete-complete" - Resource discovery deletion is complete. * "delete-failed" - Resource discovery deletion has failed. * "isolate-in-progress" - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. * "isolate-complete" - Resource discovery isolation is complete. * "restore-in-progress" - Amazon Web Services account that created the resource discovery and was isolated has been restored. * **Tags** *(list) --* A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OrganizationalUnitExclusions** *(list) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * *(dict) --* If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. * **OrganizationsEntityPath** *(string) --* An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the *Amazon Web Services Identity and Access Management User Guide*. EC2 / Client / delete_local_gateway_route_table_vpc_association delete_local_gateway_route_table_vpc_association ************************************************ EC2.Client.delete_local_gateway_route_table_vpc_association(**kwargs) Deletes the specified association between a VPC and local gateway route table. See also: AWS API Documentation **Request Syntax** response = client.delete_local_gateway_route_table_vpc_association( LocalGatewayRouteTableVpcAssociationId='string', DryRun=True|False ) Parameters: * **LocalGatewayRouteTableVpcAssociationId** (*string*) -- **[REQUIRED]** The ID of the association. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTableVpcAssociation': { 'LocalGatewayRouteTableVpcAssociationId': 'string', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'VpcId': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **LocalGatewayRouteTableVpcAssociation** *(dict) --* Information about the association. * **LocalGatewayRouteTableVpcAssociationId** *(string) --* The ID of the association. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table for the association. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **VpcId** *(string) --* The ID of the VPC. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table for the association. * **State** *(string) --* The state of the association. * **Tags** *(list) --* The tags assigned to the association. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_export_image_tasks describe_export_image_tasks *************************** EC2.Client.describe_export_image_tasks(**kwargs) Describes the specified export image tasks or all of your export image tasks. See also: AWS API Documentation **Request Syntax** response = client.describe_export_image_tasks( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ExportImageTaskIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- Filter tasks using the "task-state" filter and one of the following values: "active", "completed", "deleting", or "deleted". * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ExportImageTaskIds** (*list*) -- The IDs of the export image tasks. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return in a single call. * **NextToken** (*string*) -- A token that indicates the next page of results. Return type: dict Returns: **Response Syntax** { 'ExportImageTasks': [ { 'Description': 'string', 'ExportImageTaskId': 'string', 'ImageId': 'string', 'Progress': 'string', 'S3ExportLocation': { 'S3Bucket': 'string', 'S3Prefix': 'string' }, 'Status': 'string', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ExportImageTasks** *(list) --* Information about the export image tasks. * *(dict) --* Describes an export image task. * **Description** *(string) --* A description of the image being exported. * **ExportImageTaskId** *(string) --* The ID of the export image task. * **ImageId** *(string) --* The ID of the image. * **Progress** *(string) --* The percent complete of the export image task. * **S3ExportLocation** *(dict) --* Information about the destination Amazon S3 bucket. * **S3Bucket** *(string) --* The destination Amazon S3 bucket. * **S3Prefix** *(string) --* The prefix (logical hierarchy) in the bucket. * **Status** *(string) --* The status of the export image task. The possible values are "active", "completed", "deleting", and "deleted". * **StatusMessage** *(string) --* The status message for the export image task. * **Tags** *(list) --* Any tags assigned to the export image task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to get the next page of results. This value is "null" when there are no more results to return. EC2 / Client / delete_vpn_connection delete_vpn_connection ********************* EC2.Client.delete_vpn_connection(**kwargs) Deletes the specified VPN connection. If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID. For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection. See also: AWS API Documentation **Request Syntax** response = client.delete_vpn_connection( VpnConnectionId='string', DryRun=True|False ) Parameters: * **VpnConnectionId** (*string*) -- **[REQUIRED]** The ID of the VPN connection. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None EC2 / Client / get_transit_gateway_route_table_associations get_transit_gateway_route_table_associations ******************************************** EC2.Client.get_transit_gateway_route_table_associations(**kwargs) Gets information about the associations for the specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.get_transit_gateway_route_table_associations( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Associations': [ { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Associations** *(list) --* Information about the associations. * *(dict) --* Describes an association between a route table and a resource attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the association. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / associate_subnet_cidr_block associate_subnet_cidr_block *************************** EC2.Client.associate_subnet_cidr_block(**kwargs) Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. See also: AWS API Documentation **Request Syntax** response = client.associate_subnet_cidr_block( Ipv6IpamPoolId='string', Ipv6NetmaskLength=123, SubnetId='string', Ipv6CidrBlock='string' ) Parameters: * **Ipv6IpamPoolId** (*string*) -- An IPv6 IPAM pool ID. * **Ipv6NetmaskLength** (*integer*) -- An IPv6 netmask length. * **SubnetId** (*string*) -- **[REQUIRED]** The ID of your subnet. * **Ipv6CidrBlock** (*string*) -- The IPv6 CIDR block for your subnet. Return type: dict Returns: **Response Syntax** { 'Ipv6CidrBlockAssociation': { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, 'SubnetId': 'string' } **Response Structure** * *(dict) --* * **Ipv6CidrBlockAssociation** *(dict) --* Information about the IPv6 association. * **AssociationId** *(string) --* The ID of the association. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* The state of the CIDR block. * **State** *(string) --* The state of a CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **SubnetId** *(string) --* The ID of the subnet. EC2 / Client / create_traffic_mirror_filter_rule create_traffic_mirror_filter_rule ********************************* EC2.Client.create_traffic_mirror_filter_rule(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_traffic_mirror_filter_rule( TrafficMirrorFilterId='string', TrafficDirection='ingress'|'egress', RuleNumber=123, RuleAction='accept'|'reject', DestinationPortRange={ 'FromPort': 123, 'ToPort': 123 }, SourcePortRange={ 'FromPort': 123, 'ToPort': 123 }, Protocol=123, DestinationCidrBlock='string', SourceCidrBlock='string', Description='string', DryRun=True|False, ClientToken='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **TrafficMirrorFilterId** (*string*) -- **[REQUIRED]** The ID of the filter that this rule is associated with. * **TrafficDirection** (*string*) -- **[REQUIRED]** The type of traffic. * **RuleNumber** (*integer*) -- **[REQUIRED]** 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. * **RuleAction** (*string*) -- **[REQUIRED]** The action to take on the filtered traffic. * **DestinationPortRange** (*dict*) -- The destination port range. * **FromPort** *(integer) --* The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** (*dict*) -- The source port range. * **FromPort** *(integer) --* The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **Protocol** (*integer*) -- 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. * **DestinationCidrBlock** (*string*) -- **[REQUIRED]** The destination CIDR block to assign to the Traffic Mirror rule. * **SourceCidrBlock** (*string*) -- **[REQUIRED]** The source CIDR block to assign to the Traffic Mirror rule. * **Description** (*string*) -- The description of the Traffic Mirror rule. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. This field is autopopulated if not provided. * **TagSpecifications** (*list*) -- Traffic Mirroring tags specifications. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'TrafficMirrorFilterRule': { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'ClientToken': 'string' } **Response Structure** * *(dict) --* * **TrafficMirrorFilterRule** *(dict) --* The Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. EC2 / Client / delete_transit_gateway_vpc_attachment delete_transit_gateway_vpc_attachment ************************************* EC2.Client.delete_transit_gateway_vpc_attachment(**kwargs) Deletes the specified VPC attachment. See also: AWS API Documentation **Request Syntax** response = client.delete_transit_gateway_vpc_attachment( TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayVpcAttachment': { 'TransitGatewayAttachmentId': 'string', 'TransitGatewayId': 'string', 'VpcId': 'string', 'VpcOwnerId': 'string', 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'SubnetIds': [ 'string', ], 'CreationTime': datetime(2015, 1, 1), 'Options': { 'DnsSupport': 'enable'|'disable', 'SecurityGroupReferencingSupport': 'enable'|'disable', 'Ipv6Support': 'enable'|'disable', 'ApplianceModeSupport': 'enable'|'disable' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayVpcAttachment** *(dict) --* Information about the deleted VPC attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **VpcId** *(string) --* The ID of the VPC. * **VpcOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **State** *(string) --* The state of the VPC attachment. Note that the "initiating" state has been deprecated. * **SubnetIds** *(list) --* The IDs of the subnets. * *(string) --* * **CreationTime** *(datetime) --* The creation time. * **Options** *(dict) --* The VPC attachment options. * **DnsSupport** *(string) --* Indicates whether DNS support is enabled. * **SecurityGroupReferencingSupport** *(string) --* Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management. This option is enabled by default. For more information about security group referencing, see Security group referencing in the *Amazon Web Services Transit Gateways Guide*. * **Ipv6Support** *(string) --* Indicates whether IPv6 support is disabled. * **ApplianceModeSupport** *(string) --* Indicates whether appliance mode support is enabled. * **Tags** *(list) --* The tags for the VPC attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_account_attributes describe_account_attributes *************************** EC2.Client.describe_account_attributes(**kwargs) Describes attributes of your Amazon Web Services account. The following are the supported account attributes: * "default-vpc": The ID of the default VPC for your account, 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*. * "max-elastic-ips": The maximum number of Elastic IP addresses that you can allocate. * "supported-platforms": This attribute is deprecated. * "vpc-max-elastic-ips": The maximum number of Elastic IP addresses that you can allocate. * "vpc-max-security-groups-per-interface": The maximum number of security groups that you can assign to a network interface. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_account_attributes( DryRun=True|False, AttributeNames=[ 'supported-platforms'|'default-vpc', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **AttributeNames** (*list*) -- The account attribute names. * *(string) --* Return type: dict Returns: **Response Syntax** { 'AccountAttributes': [ { 'AttributeName': 'string', 'AttributeValues': [ { 'AttributeValue': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **AccountAttributes** *(list) --* Information about the account attributes. * *(dict) --* Describes an account attribute. * **AttributeName** *(string) --* The name of the account attribute. * **AttributeValues** *(list) --* The values for the account attribute. * *(dict) --* Describes a value of an account attribute. * **AttributeValue** *(string) --* The value of the attribute. **Examples** This example describes the supported-platforms attribute for your AWS account. response = client.describe_account_attributes( AttributeNames=[ 'supported-platforms', ], ) print(response) Expected Output: { 'AccountAttributes': [ { 'AttributeName': 'supported-platforms', 'AttributeValues': [ { 'AttributeValue': 'EC2', }, { 'AttributeValue': 'VPC', }, ], }, ], 'ResponseMetadata': { '...': '...', }, } This example describes the attributes for your AWS account. response = client.describe_account_attributes( ) print(response) Expected Output: { 'AccountAttributes': [ { 'AttributeName': 'supported-platforms', 'AttributeValues': [ { 'AttributeValue': 'EC2', }, { 'AttributeValue': 'VPC', }, ], }, { 'AttributeName': 'vpc-max-security-groups-per-interface', 'AttributeValues': [ { 'AttributeValue': '5', }, ], }, { 'AttributeName': 'max-elastic-ips', 'AttributeValues': [ { 'AttributeValue': '5', }, ], }, { 'AttributeName': 'max-instances', 'AttributeValues': [ { 'AttributeValue': '20', }, ], }, { 'AttributeName': 'vpc-max-elastic-ips', 'AttributeValues': [ { 'AttributeValue': '5', }, ], }, { 'AttributeName': 'default-vpc', 'AttributeValues': [ { 'AttributeValue': 'none', }, ], }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_dhcp_options describe_dhcp_options ********************* EC2.Client.describe_dhcp_options(**kwargs) Describes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria. For more information, see DHCP option sets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_dhcp_options( DhcpOptionsIds=[ 'string', ], NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **DhcpOptionsIds** (*list*) -- The IDs of DHCP option sets. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The 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 Amazon Web Services account that owns the DHCP options set. * "tag" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'DhcpOptions': [ { 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DhcpOptionsId': 'string', 'DhcpConfigurations': [ { 'Key': 'string', 'Values': [ { 'Value': 'string' }, ] }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **DhcpOptions** *(list) --* Information about the DHCP options sets. * *(dict) --* The set of DHCP options. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the DHCP options set. * **Tags** *(list) --* Any tags assigned to the DHCP options set. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DhcpOptionsId** *(string) --* The ID of the set of DHCP options. * **DhcpConfigurations** *(list) --* The DHCP options in the set. * *(dict) --* Describes a DHCP configuration option. * **Key** *(string) --* The name of a DHCP option. * **Values** *(list) --* The values for the DHCP option. * *(dict) --* Describes a value for a resource attribute that is a String. * **Value** *(string) --* The attribute value. The value is case- sensitive. **Examples** This example describes the specified DHCP options set. response = client.describe_dhcp_options( DhcpOptionsIds=[ 'dopt-d9070ebb', ], ) print(response) Expected Output: { 'DhcpOptions': [ { 'DhcpConfigurations': [ { 'Key': 'domain-name-servers', 'Values': [ { 'Value': '10.2.5.2', }, { 'Value': '10.2.5.1', }, ], }, ], 'DhcpOptionsId': 'dopt-d9070ebb', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_vpn_gateways describe_vpn_gateways ********************* EC2.Client.describe_vpn_gateways(**kwargs) Describes one or more of your virtual private gateways. For more information, see Amazon Web Services Site-to-Site VPN in the *Amazon Web Services Site-to-Site VPN User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_vpn_gateways( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpnGatewayIds=[ 'string', ], DryRun=True|False ) Parameters: * **Filters** (*list*) -- 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpnGatewayIds** (*list*) -- One or more virtual private gateway IDs. Default: Describes all your virtual private gateways. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VpnGateways': [ { 'AmazonSideAsn': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpnGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Type': 'ipsec.1', 'AvailabilityZone': 'string', 'VpcAttachments': [ { 'VpcId': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached' }, ] }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeVpnGateways. * **VpnGateways** *(list) --* Information about one or more virtual private gateways. * *(dict) --* Describes a virtual private gateway. * **AmazonSideAsn** *(integer) --* The private Autonomous System Number (ASN) for the Amazon side of a BGP session. * **Tags** *(list) --* Any tags assigned to the virtual private gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpnGatewayId** *(string) --* The ID of the virtual private gateway. * **State** *(string) --* The current state of the virtual private gateway. * **Type** *(string) --* The type of VPN connection the virtual private gateway supports. * **AvailabilityZone** *(string) --* The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned. * **VpcAttachments** *(list) --* Any VPCs attached to the virtual private gateway. * *(dict) --* Describes an attachment between a virtual private gateway and a VPC. * **VpcId** *(string) --* The ID of the VPC. * **State** *(string) --* The current state of the attachment. EC2 / Client / get_ipam_discovered_public_addresses get_ipam_discovered_public_addresses ************************************ EC2.Client.get_ipam_discovered_public_addresses(**kwargs) Gets the public IP addresses that have been discovered by IPAM. See also: AWS API Documentation **Request Syntax** response = client.get_ipam_discovered_public_addresses( DryRun=True|False, IpamResourceDiscoveryId='string', AddressRegion='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamResourceDiscoveryId** (*string*) -- **[REQUIRED]** An IPAM resource discovery ID. * **AddressRegion** (*string*) -- **[REQUIRED]** The Amazon Web Services Region for the IP address. * **Filters** (*list*) -- Filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of IPAM discovered public addresses to return in one page of results. Return type: dict Returns: **Response Syntax** { 'IpamDiscoveredPublicAddresses': [ { 'IpamResourceDiscoveryId': 'string', 'AddressRegion': 'string', 'Address': 'string', 'AddressOwnerId': 'string', 'AddressAllocationId': 'string', 'AssociationStatus': 'associated'|'disassociated', 'AddressType': 'service-managed-ip'|'service-managed-byoip'|'amazon-owned-eip'|'amazon-owned-contig'|'byoip'|'ec2-public-ip', 'Service': 'nat-gateway'|'database-migration-service'|'redshift'|'elastic-container-service'|'relational-database-service'|'site-to-site-vpn'|'load-balancer'|'global-accelerator'|'other', 'ServiceResource': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'PublicIpv4PoolId': 'string', 'NetworkInterfaceId': 'string', 'NetworkInterfaceDescription': 'string', 'InstanceId': 'string', 'Tags': { 'EipTags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'NetworkBorderGroup': 'string', 'SecurityGroups': [ { 'GroupName': 'string', 'GroupId': 'string' }, ], 'SampleTime': datetime(2015, 1, 1) }, ], 'OldestSampleTime': datetime(2015, 1, 1), 'NextToken': 'string' } **Response Structure** * *(dict) --* * **IpamDiscoveredPublicAddresses** *(list) --* IPAM discovered public addresses. * *(dict) --* A public IP Address discovered by IPAM. * **IpamResourceDiscoveryId** *(string) --* The resource discovery ID. * **AddressRegion** *(string) --* The Region of the resource the IP address is assigned to. * **Address** *(string) --* The IP address. * **AddressOwnerId** *(string) --* The ID of the owner of the resource the IP address is assigned to. * **AddressAllocationId** *(string) --* The allocation ID of the resource the IP address is assigned to. * **AssociationStatus** *(string) --* The association status. * **AddressType** *(string) --* The IP address type. * **Service** *(string) --* The Amazon Web Services service associated with the IP address. * **ServiceResource** *(string) --* The resource ARN or ID. * **VpcId** *(string) --* The ID of the VPC that the resource with the assigned IP address is in. * **SubnetId** *(string) --* The ID of the subnet that the resource with the assigned IP address is in. * **PublicIpv4PoolId** *(string) --* The ID of the public IPv4 pool that the resource with the assigned IP address is from. * **NetworkInterfaceId** *(string) --* The network interface ID of the resource with the assigned IP address. * **NetworkInterfaceDescription** *(string) --* The description of the network interface that IP address is assigned to. * **InstanceId** *(string) --* The instance ID of the instance the assigned IP address is assigned to. * **Tags** *(dict) --* Tags associated with the IP address. * **EipTags** *(list) --* Tags for an Elastic IP address. * *(dict) --* A tag for a public IP address discovered by IPAM. * **Key** *(string) --* The tag's key. * **Value** *(string) --* The tag's value. * **NetworkBorderGroup** *(string) --* The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see Local Zone availability in the *Amazon EC2 User Guide*. * **SecurityGroups** *(list) --* Security groups associated with the resource that the IP address is assigned to. * *(dict) --* The security group that the resource with the public IP address is in. * **GroupName** *(string) --* The security group's name. * **GroupId** *(string) --* The security group's ID. * **SampleTime** *(datetime) --* The last successful resource discovery time. * **OldestSampleTime** *(datetime) --* The oldest successful resource discovery time. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / get_transit_gateway_route_table_propagations get_transit_gateway_route_table_propagations ******************************************** EC2.Client.get_transit_gateway_route_table_propagations(**kwargs) Gets information about the route table propagations for the specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.get_transit_gateway_route_table_propagations( TransitGatewayRouteTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTablePropagations': [ { 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'TransitGatewayRouteTableAnnouncementId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayRouteTablePropagations** *(list) --* Information about the route table propagations. * *(dict) --* Describes a route table propagation. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of resource. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the resource. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / accept_vpc_peering_connection accept_vpc_peering_connection ***************************** EC2.Client.accept_vpc_peering_connection(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.accept_vpc_peering_connection( DryRun=True|False, VpcPeeringConnectionId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the VPC peering connection. You must specify this parameter in the request. Return type: dict Returns: **Response Syntax** { 'VpcPeeringConnection': { 'AccepterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'ExpirationTime': datetime(2015, 1, 1), 'RequesterVpcInfo': { 'CidrBlock': 'string', 'Ipv6CidrBlockSet': [ { 'Ipv6CidrBlock': 'string' }, ], 'CidrBlockSet': [ { 'CidrBlock': 'string' }, ], 'OwnerId': 'string', 'PeeringOptions': { 'AllowDnsResolutionFromRemoteVpc': True|False, 'AllowEgressFromLocalClassicLinkToRemoteVpc': True|False, 'AllowEgressFromLocalVpcToRemoteClassicLink': True|False }, 'VpcId': 'string', 'Region': 'string' }, 'Status': { 'Code': 'initiating-request'|'pending-acceptance'|'active'|'deleted'|'rejected'|'failed'|'expired'|'provisioning'|'deleting', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcPeeringConnectionId': 'string' } } **Response Structure** * *(dict) --* * **VpcPeeringConnection** *(dict) --* Information about the VPC peering connection. * **AccepterVpcInfo** *(dict) --* Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **ExpirationTime** *(datetime) --* The time that an unaccepted VPC peering connection will expire. * **RequesterVpcInfo** *(dict) --* Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. * **CidrBlock** *(string) --* The IPv4 CIDR block for the VPC. * **Ipv6CidrBlockSet** *(list) --* The IPv6 CIDR block for the VPC. * *(dict) --* Describes an IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **CidrBlockSet** *(list) --* Information about the IPv4 CIDR blocks for the VPC. * *(dict) --* Describes an IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **PeeringOptions** *(dict) --* Information about the VPC peering connection options for the accepter or requester VPC. * **AllowDnsResolutionFromRemoteVpc** *(boolean) --* Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. * **AllowEgressFromLocalClassicLinkToRemoteVpc** *(boolean) --* Deprecated. * **AllowEgressFromLocalVpcToRemoteClassicLink** *(boolean) --* Deprecated. * **VpcId** *(string) --* The ID of the VPC. * **Region** *(string) --* The Region in which the VPC is located. * **Status** *(dict) --* The status of the VPC peering connection. * **Code** *(string) --* The status of the VPC peering connection. * **Message** *(string) --* A message that provides more information about the status, if applicable. * **Tags** *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection. EC2 / Client / delete_route_server delete_route_server ******************* EC2.Client.delete_route_server(**kwargs) Deletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: * VPC route tables not associated with subnets * Subnet route tables * Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_route_server( RouteServerId='string', DryRun=True|False ) Parameters: * **RouteServerId** (*string*) -- **[REQUIRED]** The ID of the route server to delete. * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RouteServer': { 'RouteServerId': 'string', 'AmazonSideAsn': 123, 'State': 'pending'|'available'|'modifying'|'deleting'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying', 'PersistRoutesDuration': 123, 'SnsNotificationsEnabled': True|False, 'SnsTopicArn': 'string' } } **Response Structure** * *(dict) --* * **RouteServer** *(dict) --* Information about the deleted route server. * **RouteServerId** *(string) --* The unique identifier of the route server. * **AmazonSideAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * **State** *(string) --* The current state of the route server. * **Tags** *(list) --* Any tags assigned to the route server. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PersistRoutesState** *(string) --* The current state of route persistence for the route server. * **PersistRoutesDuration** *(integer) --* The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if "persistRoutesState" is 'enabled'. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re- establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes. * **SnsNotificationsEnabled** *(boolean) --* Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services. * **SnsTopicArn** *(string) --* The ARN of the SNS topic where notifications are published. EC2 / Client / assign_private_ip_addresses assign_private_ip_addresses *************************** EC2.Client.assign_private_ip_addresses(**kwargs) Assigns the specified secondary private IP addresses to the specified network interface. You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the *Amazon EC2 User Guide*. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check "network/interfaces/macs/mac/local-ipv4s" in the instance metadata to confirm that the remapping is complete. You must specify either the IP addresses or the IP address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.assign_private_ip_addresses( Ipv4Prefixes=[ 'string', ], Ipv4PrefixCount=123, NetworkInterfaceId='string', PrivateIpAddresses=[ 'string', ], SecondaryPrivateIpAddressCount=123, AllowReassignment=True|False ) Parameters: * **Ipv4Prefixes** (*list*) -- One or more IPv4 prefixes assigned to the network interface. You can't use this option if you use the "Ipv4PrefixCount" option. * *(string) --* * **Ipv4PrefixCount** (*integer*) -- The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You can't use this option if you use the "Ipv4 Prefixes" option. * **NetworkInterfaceId** (*string*) -- **[REQUIRED]** The ID of the network interface. * **PrivateIpAddresses** (*list*) -- The 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. * *(string) --* * **SecondaryPrivateIpAddressCount** (*integer*) -- The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. * **AllowReassignment** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'NetworkInterfaceId': 'string', 'AssignedPrivateIpAddresses': [ { 'PrivateIpAddress': 'string' }, ], 'AssignedIpv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ] } **Response Structure** * *(dict) --* * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **AssignedPrivateIpAddresses** *(list) --* The private IP addresses assigned to the network interface. * *(dict) --* Describes the private IP addresses assigned to a network interface. * **PrivateIpAddress** *(string) --* The private IP address assigned to the network interface. * **AssignedIpv4Prefixes** *(list) --* The IPv4 prefixes that are assigned to the network interface. * *(dict) --* Describes an IPv4 prefix. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. **Examples** This example assigns the specified secondary private IP address to the specified network interface. response = client.assign_private_ip_addresses( NetworkInterfaceId='eni-e5aa89a3', PrivateIpAddresses=[ '10.0.0.82', ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with. response = client.assign_private_ip_addresses( NetworkInterfaceId='eni-e5aa89a3', SecondaryPrivateIpAddressCount=2, ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / delete_coip_cidr delete_coip_cidr **************** EC2.Client.delete_coip_cidr(**kwargs) Deletes a range of customer-owned IP addresses. See also: AWS API Documentation **Request Syntax** response = client.delete_coip_cidr( Cidr='string', CoipPoolId='string', DryRun=True|False ) Parameters: * **Cidr** (*string*) -- **[REQUIRED]** A customer-owned IP address range that you want to delete. * **CoipPoolId** (*string*) -- **[REQUIRED]** The ID of the customer-owned address pool. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CoipCidr': { 'Cidr': 'string', 'CoipPoolId': 'string', 'LocalGatewayRouteTableId': 'string' } } **Response Structure** * *(dict) --* * **CoipCidr** *(dict) --* Information about a range of customer-owned IP addresses. * **Cidr** *(string) --* An address range in a customer-owned IP address space. * **CoipPoolId** *(string) --* The ID of the address pool. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. EC2 / Client / get_route_server_routing_database get_route_server_routing_database ********************************* EC2.Client.get_route_server_routing_database(**kwargs) Gets the routing database for the specified route server. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: * VPC route tables not associated with subnets * Subnet route tables * Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. See also: AWS API Documentation **Request Syntax** response = client.get_route_server_routing_database( RouteServerId='string', NextToken='string', MaxResults=123, DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **RouteServerId** (*string*) -- **[REQUIRED]** The ID of the route server for which to get the routing database. * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of routing database entries to return in a single response. * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- Filters to apply to the routing database query. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'AreRoutesPersisted': True|False, 'Routes': [ { 'RouteServerEndpointId': 'string', 'RouteServerPeerId': 'string', 'RouteInstallationDetails': [ { 'RouteTableId': 'string', 'RouteInstallationStatus': 'installed'|'rejected', 'RouteInstallationStatusReason': 'string' }, ], 'RouteStatus': 'in-rib'|'in-fib', 'Prefix': 'string', 'AsPaths': [ 'string', ], 'Med': 123, 'NextHopIp': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AreRoutesPersisted** *(boolean) --* Indicates whether routes are being persisted in the routing database. * **Routes** *(list) --* The collection of routes in the route server's routing database. * *(dict) --* Describes a route in the route server's routing database. * **RouteServerEndpointId** *(string) --* The ID of the route server endpoint that received this route. * **RouteServerPeerId** *(string) --* The ID of the route server peer that advertised this route. * **RouteInstallationDetails** *(list) --* Details about the installation status of this route in route tables. * *(dict) --* Describes the installation status of a route in a route table. * **RouteTableId** *(string) --* The ID of the route table where the route is being installed. * **RouteInstallationStatus** *(string) --* The current installation status of the route in the route table. * **RouteInstallationStatusReason** *(string) --* The reason for the current installation status of the route. * **RouteStatus** *(string) --* The current status of the route in the routing database. Values are "in-rib" or "in-fib" depending on if the routes are in the RIB or the FIB database. The Routing Information Base (RIB) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions. The Forwarding Information Base (FIB) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB. * **Prefix** *(string) --* The destination CIDR block of the route. * **AsPaths** *(list) --* The AS path attributes of the BGP route. * *(string) --* * **Med** *(integer) --* The Multi-Exit Discriminator (MED) value of the BGP route. * **NextHopIp** *(string) --* The IP address for the next hop. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / create_customer_gateway create_customer_gateway *********************** EC2.Client.create_customer_gateway(**kwargs) Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the *Amazon Web Services Site-to-Site VPN User Guide*. To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway. See also: AWS API Documentation **Request Syntax** response = client.create_customer_gateway( BgpAsn=123, PublicIp='string', CertificateArn='string', Type='ipsec.1', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DeviceName='string', IpAddress='string', BgpAsnExtended=123, DryRun=True|False ) Parameters: * **BgpAsn** (*integer*) -- For customer gateway devices that support BGP, specify the device's ASN. You must specify either "BgpAsn" or "BgpAsnExtended" when creating the customer gateway. If the ASN is larger than "2,147,483,647", you must use "BgpAsnExtended". Default: 65000 Valid values: "1" to "2,147,483,647" * **PublicIp** (*string*) -- *This member has been deprecated.* The Internet-routable IP address for the customer gateway's outside interface. The address must be static. * **CertificateArn** (*string*) -- The Amazon Resource Name (ARN) for the customer gateway certificate. * **Type** (*string*) -- **[REQUIRED]** The type of VPN connection that this customer gateway supports ( "ipsec.1"). * **TagSpecifications** (*list*) -- The tags to apply to the customer gateway. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DeviceName** (*string*) -- A name for the customer gateway device. Length Constraints: Up to 255 characters. * **IpAddress** (*string*) -- The IP address for the customer gateway device's outside interface. The address must be static. If "OutsideIpAddressType" in your VPN connection options is set to "PrivateIpv4", you can use an RFC6598 or RFC1918 private IPv4 address. If "OutsideIpAddressType" is set to "Ipv6", you can use an IPv6 address. * **BgpAsnExtended** (*integer*) -- For customer gateway devices that support BGP, specify the device's ASN. You must specify either "BgpAsn" or "BgpAsnExtended" when creating the customer gateway. If the ASN is larger than "2,147,483,647", you must use "BgpAsnExtended". Valid values: "2,147,483,648" to "4,294,967,295" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CustomerGateway': { 'CertificateArn': 'string', 'DeviceName': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'BgpAsnExtended': 'string', 'CustomerGatewayId': 'string', 'State': 'string', 'Type': 'string', 'IpAddress': 'string', 'BgpAsn': 'string' } } **Response Structure** * *(dict) --* Contains the output of CreateCustomerGateway. * **CustomerGateway** *(dict) --* Information about the customer gateway. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) for the customer gateway certificate. * **DeviceName** *(string) --* The name of customer gateway device. * **Tags** *(list) --* Any tags assigned to the customer gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **BgpAsnExtended** *(string) --* The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values: "2,147,483,648" to "4,294,967,295" * **CustomerGatewayId** *(string) --* The ID of the customer gateway. * **State** *(string) --* The current state of the customer gateway ( "pending | available | deleting | deleted"). * **Type** *(string) --* The type of VPN connection the customer gateway supports ( "ipsec.1"). * **IpAddress** *(string) --* The IP address for the customer gateway device's outside interface. The address must be static. If "OutsideIpAddressType" in your VPN connection options is set to "PrivateIpv4", you can use an RFC6598 or RFC1918 private IPv4 address. If "OutsideIpAddressType" is set to "PublicIpv4", you can use a public IPv4 address. If "OutsideIpAddressType" is set to "Ipv6", you can use a public IPv6 address. * **BgpAsn** *(string) --* The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values: "1" to "2,147,483,647" **Examples** This example creates a customer gateway with the specified IP address for its outside interface. response = client.create_customer_gateway( BgpAsn=65534, PublicIp='12.1.2.3', Type='ipsec.1', ) print(response) Expected Output: { 'CustomerGateway': { 'BgpAsn': '65534', 'CustomerGatewayId': 'cgw-0e11f167', 'IpAddress': '12.1.2.3', 'State': 'available', 'Type': 'ipsec.1', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / attach_classic_link_vpc attach_classic_link_vpc *********************** EC2.Client.attach_classic_link_vpc(**kwargs) Note: This action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the "running" state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as *attaching* your instance. See also: AWS API Documentation **Request Syntax** response = client.attach_classic_link_vpc( DryRun=True|False, InstanceId='string', VpcId='string', Groups=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the EC2-Classic instance. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the ClassicLink-enabled VPC. * **Groups** (*list*) -- **[REQUIRED]** The IDs of the security groups. You cannot specify security groups from a different VPC. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / disassociate_instance_event_window disassociate_instance_event_window ********************************** EC2.Client.disassociate_instance_event_window(**kwargs) Disassociates one or more targets from an event window. For more information, see Define event windows for scheduled events in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.disassociate_instance_event_window( DryRun=True|False, InstanceEventWindowId='string', AssociationTarget={ 'InstanceIds': [ 'string', ], 'InstanceTags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceEventWindowId** (*string*) -- **[REQUIRED]** The ID of the event window. * **AssociationTarget** (*dict*) -- **[REQUIRED]** One or more targets to disassociate from the specified event window. * **InstanceIds** *(list) --* The IDs of the instances to disassociate from the event window. * *(string) --* * **InstanceTags** *(list) --* The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts to disassociate from the event window. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InstanceEventWindow': { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **InstanceEventWindow** *(dict) --* Information about the event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / modify_vpn_connection_options modify_vpn_connection_options ***************************** EC2.Client.modify_vpn_connection_options(**kwargs) Modifies the connection options for your Site-to-Site VPN connection. When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated. See also: AWS API Documentation **Request Syntax** response = client.modify_vpn_connection_options( VpnConnectionId='string', LocalIpv4NetworkCidr='string', RemoteIpv4NetworkCidr='string', LocalIpv6NetworkCidr='string', RemoteIpv6NetworkCidr='string', DryRun=True|False ) Parameters: * **VpnConnectionId** (*string*) -- **[REQUIRED]** The ID of the Site-to-Site VPN connection. * **LocalIpv4NetworkCidr** (*string*) -- The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: "0.0.0.0/0" * **RemoteIpv4NetworkCidr** (*string*) -- The IPv4 CIDR on the Amazon Web Services side of the VPN connection. Default: "0.0.0.0/0" * **LocalIpv6NetworkCidr** (*string*) -- The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: "::/0" * **RemoteIpv6NetworkCidr** (*string*) -- The IPv6 CIDR on the Amazon Web Services side of the VPN connection. Default: "::/0" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VpnConnection': { 'Category': 'string', 'TransitGatewayId': 'string', 'CoreNetworkArn': 'string', 'CoreNetworkAttachmentArn': 'string', 'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'OutsideIpAddressType': 'string', 'TransportTransitGatewayAttachmentId': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string', 'LogOptions': { 'CloudWatchLogOptions': { 'LogEnabled': True|False, 'LogGroupArn': 'string', 'LogOutputFormat': 'string' } }, 'EnableTunnelLifecycleControl': True|False }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ], 'PreSharedKeyArn': 'string', 'VpnConnectionId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CustomerGatewayConfiguration': 'string', 'Type': 'ipsec.1', 'CustomerGatewayId': 'string', 'VpnGatewayId': 'string' } } **Response Structure** * *(dict) --* * **VpnConnection** *(dict) --* Information about the VPN connection. * **Category** *(string) --* The category of the VPN connection. A value of "VPN" indicates an Amazon Web Services VPN connection. A value of "VPN-Classic" indicates an Amazon Web Services Classic VPN connection. * **TransitGatewayId** *(string) --* The ID of the transit gateway associated with the VPN connection. * **CoreNetworkArn** *(string) --* The ARN of the core network. * **CoreNetworkAttachmentArn** *(string) --* The ARN of the core network attachment. * **GatewayAssociationState** *(string) --* The current state of the gateway association. * **Options** *(dict) --* The VPN connection options. * **EnableAcceleration** *(boolean) --* Indicates whether acceleration is enabled for the VPN connection. * **StaticRoutesOnly** *(boolean) --* Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. * **LocalIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the Amazon Web Services side of the VPN connection. * **LocalIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the Amazon Web Services side of the VPN connection. * **OutsideIpAddressType** *(string) --* The type of IPv4 address assigned to the outside interface of the customer gateway. Valid values: "PrivateIpv4" | "PublicIpv4" | "Ipv6" Default: "PublicIpv4" * **TransportTransitGatewayAttachmentId** *(string) --* The transit gateway attachment ID in use for the VPN tunnel. * **TunnelInsideIpVersion** *(string) --* Indicates whether the VPN tunnels process IPv4 or IPv6 traffic. * **TunnelOptions** *(list) --* Indicates the VPN tunnel options. * *(dict) --* The VPN tunnel options. * **OutsideIpAddress** *(string) --* The external IP address of the VPN tunnel. * **TunnelInsideCidr** *(string) --* The range of inside IPv4 addresses for the tunnel. * **TunnelInsideIpv6Cidr** *(string) --* The range of inside IPv6 addresses for the tunnel. * **PreSharedKey** *(string) --* The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. * **Phase1LifetimeSeconds** *(integer) --* The lifetime for phase 1 of the IKE negotiation, in seconds. * **Phase2LifetimeSeconds** *(integer) --* The lifetime for phase 2 of the IKE negotiation, in seconds. * **RekeyMarginTimeSeconds** *(integer) --* The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. * **RekeyFuzzPercentage** *(integer) --* The percentage of the rekey window determined by "RekeyMarginTimeSeconds" during which the rekey time is randomly selected. * **ReplayWindowSize** *(integer) --* The number of packets in an IKE replay window. * **DpdTimeoutSeconds** *(integer) --* The number of seconds after which a DPD timeout occurs. * **DpdTimeoutAction** *(string) --* The action to take after a DPD timeout occurs. * **Phase1EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The encryption algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the encryption algorithm. * **Phase2EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The encryption algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The encryption algorithm. * **Phase1IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The integrity algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the integrity algorithm. * **Phase2IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The integrity algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The integrity algorithm. * **Phase1DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 1 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **Phase2DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 2 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **IkeVersions** *(list) --* The IKE versions that are permitted for the VPN tunnel. * *(dict) --* The internet key exchange (IKE) version permitted for the VPN tunnel. * **Value** *(string) --* The IKE version. * **StartupAction** *(string) --* The action to take when the establishing the VPN tunnels for a VPN connection. * **LogOptions** *(dict) --* Options for logging VPN tunnel activity. * **CloudWatchLogOptions** *(dict) --* Options for sending VPN tunnel logs to CloudWatch. * **LogEnabled** *(boolean) --* Status of VPN tunnel logging feature. Default value is "False". Valid values: "True" | "False" * **LogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. * **LogOutputFormat** *(string) --* Configured log format. Default format is "json". Valid values: "json" | "text" * **EnableTunnelLifecycleControl** *(boolean) --* Status of tunnel endpoint lifecycle control feature. * **Routes** *(list) --* The static routes associated with the VPN connection. * *(dict) --* Describes a static route for a VPN connection. * **DestinationCidrBlock** *(string) --* The CIDR block associated with the local subnet of the customer data center. * **Source** *(string) --* Indicates how the routes were provided. * **State** *(string) --* The current state of the static route. * **Tags** *(list) --* Any tags assigned to the VPN connection. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VgwTelemetry** *(list) --* Information about the VPN tunnel. * *(dict) --* Describes telemetry for a VPN tunnel. * **AcceptedRouteCount** *(integer) --* The number of accepted routes. * **LastStatusChange** *(datetime) --* The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected. * **OutsideIpAddress** *(string) --* The Internet-routable IP address of the virtual private gateway's outside interface. * **Status** *(string) --* The status of the VPN tunnel. * **StatusMessage** *(string) --* If an error occurs, a description of the error. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. * **PreSharedKeyArn** *(string) --* The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. * **VpnConnectionId** *(string) --* The ID of the VPN connection. * **State** *(string) --* The current state of the VPN connection. * **CustomerGatewayConfiguration** *(string) --* The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the "pending" or "available" state. * **Type** *(string) --* The type of VPN connection. * **CustomerGatewayId** *(string) --* The ID of the customer gateway at your end of the VPN connection. * **VpnGatewayId** *(string) --* The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. EC2 / Client / describe_bundle_tasks describe_bundle_tasks ********************* EC2.Client.describe_bundle_tasks(**kwargs) Describes the specified bundle tasks or all of your bundle tasks. Note: 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. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_bundle_tasks( BundleIds=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **BundleIds** (*list*) -- The bundle task IDs. Default: Describes all your bundle tasks. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'BundleTasks': [ { 'InstanceId': 'string', 'BundleId': 'string', 'State': 'pending'|'waiting-for-shutdown'|'bundling'|'storing'|'cancelling'|'complete'|'failed', 'StartTime': datetime(2015, 1, 1), 'UpdateTime': datetime(2015, 1, 1), 'Storage': { 'S3': { 'AWSAccessKeyId': 'string', 'Bucket': 'string', 'Prefix': 'string', 'UploadPolicy': b'bytes', 'UploadPolicySignature': 'string' } }, 'Progress': 'string', 'BundleTaskError': { 'Code': 'string', 'Message': 'string' } }, ] } **Response Structure** * *(dict) --* * **BundleTasks** *(list) --* Information about the bundle tasks. * *(dict) --* Describes a bundle task. * **InstanceId** *(string) --* The ID of the instance associated with this bundle task. * **BundleId** *(string) --* The ID of the bundle task. * **State** *(string) --* The state of the task. * **StartTime** *(datetime) --* The time this task started. * **UpdateTime** *(datetime) --* The time of the most recent update for the task. * **Storage** *(dict) --* The Amazon S3 storage locations. * **S3** *(dict) --* An Amazon S3 storage location. * **AWSAccessKeyId** *(string) --* The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the *Account ManagementReference Guide*. * **Bucket** *(string) --* 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. * **Prefix** *(string) --* The beginning of the file name of the AMI. * **UploadPolicy** *(bytes) --* An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. * **UploadPolicySignature** *(string) --* The signature of the JSON document. * **Progress** *(string) --* The level of task completion, as a percent (for example, 20%). * **BundleTaskError** *(dict) --* If the task fails, a description of the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message. EC2 / Client / get_default_credit_specification get_default_credit_specification ******************************** EC2.Client.get_default_credit_specification(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.get_default_credit_specification( DryRun=True|False, InstanceFamily='t2'|'t3'|'t3a'|'t4g' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceFamily** (*string*) -- **[REQUIRED]** The instance family. Return type: dict Returns: **Response Syntax** { 'InstanceFamilyCreditSpecification': { 'InstanceFamily': 't2'|'t3'|'t3a'|'t4g', 'CpuCredits': 'string' } } **Response Structure** * *(dict) --* * **InstanceFamilyCreditSpecification** *(dict) --* The default credit option for CPU usage of the instance family. * **InstanceFamily** *(string) --* The instance family. * **CpuCredits** *(string) --* The default credit option for CPU usage of the instance family. Valid values are "standard" and "unlimited". EC2 / Client / delete_launch_template delete_launch_template ********************** EC2.Client.delete_launch_template(**kwargs) Deletes a launch template. Deleting a launch template deletes all of its versions. See also: AWS API Documentation **Request Syntax** response = client.delete_launch_template( DryRun=True|False, LaunchTemplateId='string', LaunchTemplateName='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. * **LaunchTemplateName** (*string*) -- The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. Return type: dict Returns: **Response Syntax** { 'LaunchTemplate': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'CreateTime': datetime(2015, 1, 1), 'CreatedBy': 'string', 'DefaultVersionNumber': 123, 'LatestVersionNumber': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Operator': { 'Managed': True|False, 'Principal': 'string' } } } **Response Structure** * *(dict) --* * **LaunchTemplate** *(dict) --* Information about the launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. * **LaunchTemplateName** *(string) --* The name of the launch template. * **CreateTime** *(datetime) --* The time launch template was created. * **CreatedBy** *(string) --* The principal that created the launch template. * **DefaultVersionNumber** *(integer) --* The version number of the default version of the launch template. * **LatestVersionNumber** *(integer) --* The version number of the latest version of the launch template. * **Tags** *(list) --* The tags for the launch template. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Operator** *(dict) --* The entity that manages the launch template. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. **Examples** This example deletes the specified launch template. response = client.delete_launch_template( LaunchTemplateId='lt-0abcd290751193123', ) print(response) Expected Output: { 'LaunchTemplate': { 'CreateTime': datetime(2017, 11, 23, 16, 46, 25, 3, 327, 0), 'CreatedBy': 'arn:aws:iam::123456789012:root', 'DefaultVersionNumber': 2, 'LatestVersionNumber': 2, 'LaunchTemplateId': 'lt-0abcd290751193123', 'LaunchTemplateName': 'my-template', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_local_gateway_route modify_local_gateway_route ************************** EC2.Client.modify_local_gateway_route(**kwargs) Modifies the specified local gateway route. See also: AWS API Documentation **Request Syntax** response = client.modify_local_gateway_route( DestinationCidrBlock='string', LocalGatewayRouteTableId='string', LocalGatewayVirtualInterfaceGroupId='string', NetworkInterfaceId='string', DryRun=True|False, DestinationPrefixListId='string' ) Parameters: * **DestinationCidrBlock** (*string*) -- The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table. * **LocalGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the local gateway route table. * **LocalGatewayVirtualInterfaceGroupId** (*string*) -- The ID of the virtual interface group. * **NetworkInterfaceId** (*string*) -- The ID of the network interface. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **DestinationPrefixListId** (*string*) -- The ID of the prefix list. Use a prefix list in place of "DestinationCidrBlock". You cannot use "DestinationPrefixListId" and "DestinationCidrBlock" in the same request. Return type: dict Returns: **Response Syntax** { 'Route': { 'DestinationCidrBlock': 'string', 'LocalGatewayVirtualInterfaceGroupId': 'string', 'Type': 'static'|'propagated', 'State': 'pending'|'active'|'blackhole'|'deleting'|'deleted', 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'OwnerId': 'string', 'SubnetId': 'string', 'CoipPoolId': 'string', 'NetworkInterfaceId': 'string', 'DestinationPrefixListId': 'string' } } **Response Structure** * *(dict) --* * **Route** *(dict) --* Information about the local gateway route table. * **DestinationCidrBlock** *(string) --* The CIDR block used for destination matches. * **LocalGatewayVirtualInterfaceGroupId** *(string) --* The ID of the virtual interface group. * **Type** *(string) --* The route type. * **State** *(string) --* The state of the route. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route. * **SubnetId** *(string) --* The ID of the subnet. * **CoipPoolId** *(string) --* The ID of the customer-owned address pool. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **DestinationPrefixListId** *(string) --* The ID of the prefix list. EC2 / Client / get_subnet_cidr_reservations get_subnet_cidr_reservations **************************** EC2.Client.get_subnet_cidr_reservations(**kwargs) Gets information about the subnet CIDR reservations. See also: AWS API Documentation **Request Syntax** response = client.get_subnet_cidr_reservations( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SubnetId='string', DryRun=True|False, NextToken='string', MaxResults=123 ) Parameters: * **Filters** (*list*) -- One or more filters. * "reservationType" - The type of reservation ( "prefix" | "explicit"). * "subnet-id" - The ID of the subnet. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **SubnetId** (*string*) -- **[REQUIRED]** The ID of the subnet. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. Return type: dict Returns: **Response Syntax** { 'SubnetIpv4CidrReservations': [ { 'SubnetCidrReservationId': 'string', 'SubnetId': 'string', 'Cidr': 'string', 'ReservationType': 'prefix'|'explicit', 'OwnerId': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'SubnetIpv6CidrReservations': [ { 'SubnetCidrReservationId': 'string', 'SubnetId': 'string', 'Cidr': 'string', 'ReservationType': 'prefix'|'explicit', 'OwnerId': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **SubnetIpv4CidrReservations** *(list) --* Information about the IPv4 subnet CIDR reservations. * *(dict) --* Describes a subnet CIDR reservation. * **SubnetCidrReservationId** *(string) --* The ID of the subnet CIDR reservation. * **SubnetId** *(string) --* The ID of the subnet. * **Cidr** *(string) --* The CIDR that has been reserved. * **ReservationType** *(string) --* The type of reservation. * **OwnerId** *(string) --* The ID of the account that owns the subnet CIDR reservation. * **Description** *(string) --* The description assigned to the subnet CIDR reservation. * **Tags** *(list) --* The tags assigned to the subnet CIDR reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SubnetIpv6CidrReservations** *(list) --* Information about the IPv6 subnet CIDR reservations. * *(dict) --* Describes a subnet CIDR reservation. * **SubnetCidrReservationId** *(string) --* The ID of the subnet CIDR reservation. * **SubnetId** *(string) --* The ID of the subnet. * **Cidr** *(string) --* The CIDR that has been reserved. * **ReservationType** *(string) --* The type of reservation. * **OwnerId** *(string) --* The ID of the account that owns the subnet CIDR reservation. * **Description** *(string) --* The description assigned to the subnet CIDR reservation. * **Tags** *(list) --* The tags assigned to the subnet CIDR reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / disable_snapshot_block_public_access disable_snapshot_block_public_access ************************************ EC2.Client.disable_snapshot_block_public_access(**kwargs) Disables the *block public access for snapshots* setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region. Warning: Enabling block public access for snapshots in *block-all-sharing* mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.If you disable block public access , these snapshots will become publicly available again. For more information, see Block public access for snapshots in the *Amazon EBS User Guide* . See also: AWS API Documentation **Request Syntax** response = client.disable_snapshot_block_public_access( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'State': 'block-all-sharing'|'block-new-sharing'|'unblocked' } **Response Structure** * *(dict) --* * **State** *(string) --* Returns "unblocked" if the request succeeds. EC2 / Client / describe_fpga_image_attribute describe_fpga_image_attribute ***************************** EC2.Client.describe_fpga_image_attribute(**kwargs) Describes the specified attribute of the specified Amazon FPGA Image (AFI). See also: AWS API Documentation **Request Syntax** response = client.describe_fpga_image_attribute( DryRun=True|False, FpgaImageId='string', Attribute='description'|'name'|'loadPermission'|'productCodes' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FpgaImageId** (*string*) -- **[REQUIRED]** The ID of the AFI. * **Attribute** (*string*) -- **[REQUIRED]** The AFI attribute. Return type: dict Returns: **Response Syntax** { 'FpgaImageAttribute': { 'FpgaImageId': 'string', 'Name': 'string', 'Description': 'string', 'LoadPermissions': [ { 'UserId': 'string', 'Group': 'all' }, ], 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ] } } **Response Structure** * *(dict) --* * **FpgaImageAttribute** *(dict) --* Information about the attribute. * **FpgaImageId** *(string) --* The ID of the AFI. * **Name** *(string) --* The name of the AFI. * **Description** *(string) --* The description of the AFI. * **LoadPermissions** *(list) --* The load permissions. * *(dict) --* Describes a load permission. * **UserId** *(string) --* The Amazon Web Services account ID. * **Group** *(string) --* The name of the group. * **ProductCodes** *(list) --* The product codes. * *(dict) --* Describes a product code. * **ProductCodeId** *(string) --* The product code. * **ProductCodeType** *(string) --* The type of product code. EC2 / Client / modify_hosts modify_hosts ************ EC2.Client.modify_hosts(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_hosts( HostRecovery='on'|'off', InstanceType='string', InstanceFamily='string', HostMaintenance='on'|'off', HostIds=[ 'string', ], AutoPlacement='on'|'off' ) Parameters: * **HostRecovery** (*string*) -- Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the *Amazon EC2 User Guide*. * **InstanceType** (*string*) -- 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. * **InstanceFamily** (*string*) -- 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. * **HostMaintenance** (*string*) -- Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the *Amazon EC2 User Guide*. * **HostIds** (*list*) -- **[REQUIRED]** The IDs of the Dedicated Hosts to modify. * *(string) --* * **AutoPlacement** (*string*) -- Specify whether to enable or disable auto-placement. Return type: dict Returns: **Response Syntax** { 'Successful': [ 'string', ], 'Unsuccessful': [ { 'Error': { 'Code': 'string', 'Message': 'string' }, 'ResourceId': 'string' }, ] } **Response Structure** * *(dict) --* * **Successful** *(list) --* The IDs of the Dedicated Hosts that were successfully modified. * *(string) --* * **Unsuccessful** *(list) --* The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used. * *(dict) --* Information about items that were not successfully processed in a batch call. * **Error** *(dict) --* Information about the error. * **Code** *(string) --* The error code. * **Message** *(string) --* The error message accompanying the error code. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / cancel_capacity_reservation cancel_capacity_reservation *************************** EC2.Client.cancel_capacity_reservation(**kwargs) Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to "cancelled". You can cancel a Capacity Reservation that is in the following states: * "assessing" * "active" and there is no commitment duration or the commitment duration has elapsed. You can't cancel a future-dated Capacity Reservation during the commitment duration. Note: You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. If a future-dated Capacity Reservation enters the "delayed" state, the commitment duration is waived, and you can cancel it as soon as it enters the "active" state. 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. See also: AWS API Documentation **Request Syntax** response = client.cancel_capacity_reservation( CapacityReservationId='string', DryRun=True|False ) Parameters: * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation to be cancelled. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / disassociate_trunk_interface disassociate_trunk_interface **************************** EC2.Client.disassociate_trunk_interface(**kwargs) Removes an association between a branch network interface with a trunk network interface. See also: AWS API Documentation **Request Syntax** response = client.disassociate_trunk_interface( AssociationId='string', ClientToken='string', DryRun=True|False ) Parameters: * **AssociationId** (*string*) -- **[REQUIRED]** The ID of the association * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'ClientToken': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. EC2 / Client / restore_managed_prefix_list_version restore_managed_prefix_list_version *********************************** EC2.Client.restore_managed_prefix_list_version(**kwargs) Restores the entries from a previous version of a managed prefix list to a new version of the prefix list. See also: AWS API Documentation **Request Syntax** response = client.restore_managed_prefix_list_version( DryRun=True|False, PrefixListId='string', PreviousVersion=123, CurrentVersion=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list. * **PreviousVersion** (*integer*) -- **[REQUIRED]** The version to restore. * **CurrentVersion** (*integer*) -- **[REQUIRED]** The current version number for the prefix list. Return type: dict Returns: **Response Syntax** { 'PrefixList': { 'PrefixListId': 'string', 'AddressFamily': 'string', 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'restore-in-progress'|'restore-complete'|'restore-failed'|'delete-in-progress'|'delete-complete'|'delete-failed', 'StateMessage': 'string', 'PrefixListArn': 'string', 'PrefixListName': 'string', 'MaxEntries': 123, 'Version': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OwnerId': 'string' } } **Response Structure** * *(dict) --* * **PrefixList** *(dict) --* Information about the prefix list. * **PrefixListId** *(string) --* The ID of the prefix list. * **AddressFamily** *(string) --* The IP address version. * **State** *(string) --* The current state of the prefix list. * **StateMessage** *(string) --* The state message. * **PrefixListArn** *(string) --* The Amazon Resource Name (ARN) for the prefix list. * **PrefixListName** *(string) --* The name of the prefix list. * **MaxEntries** *(integer) --* The maximum number of entries for the prefix list. * **Version** *(integer) --* The version of the prefix list. * **Tags** *(list) --* The tags for the prefix list. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OwnerId** *(string) --* The ID of the owner of the prefix list. EC2 / Client / get_flow_logs_integration_template get_flow_logs_integration_template ********************************** EC2.Client.get_flow_logs_integration_template(**kwargs) 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 Note: "GetFlowLogsIntegrationTemplate" does not support integration between Amazon Web Services Transit Gateway Flow Logs and Amazon Athena. See also: AWS API Documentation **Request Syntax** response = client.get_flow_logs_integration_template( DryRun=True|False, FlowLogId='string', ConfigDeliveryS3DestinationArn='string', IntegrateServices={ 'AthenaIntegrations': [ { 'IntegrationResultS3DestinationArn': 'string', 'PartitionLoadFrequency': 'none'|'daily'|'weekly'|'monthly', 'PartitionStartDate': datetime(2015, 1, 1), 'PartitionEndDate': datetime(2015, 1, 1) }, ] } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FlowLogId** (*string*) -- **[REQUIRED]** The ID of the flow log. * **ConfigDeliveryS3DestinationArn** (*string*) -- **[REQUIRED]** To store the CloudFormation template in Amazon S3, specify the location in Amazon S3. * **IntegrateServices** (*dict*) -- **[REQUIRED]** Information about the service integration. * **AthenaIntegrations** *(list) --* Information about the integration with Amazon Athena. * *(dict) --* Describes integration options for Amazon Athena. * **IntegrationResultS3DestinationArn** *(string) --* **[REQUIRED]** The location in Amazon S3 to store the generated CloudFormation template. * **PartitionLoadFrequency** *(string) --* **[REQUIRED]** The schedule for adding new partitions to the table. * **PartitionStartDate** *(datetime) --* The start date for the partition. * **PartitionEndDate** *(datetime) --* The end date for the partition. Return type: dict Returns: **Response Syntax** { 'Result': 'string' } **Response Structure** * *(dict) --* * **Result** *(string) --* The generated CloudFormation template. EC2 / Client / get_allowed_images_settings get_allowed_images_settings *************************** EC2.Client.get_allowed_images_settings(**kwargs) Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region. Note: The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_allowed_images_settings( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'State': 'string', 'ImageCriteria': [ { 'ImageProviders': [ 'string', ] }, ], 'ManagedBy': 'account'|'declarative-policy' } **Response Structure** * *(dict) --* * **State** *(string) --* The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services Region. Possible values: * "disabled": All AMIs are allowed. * "audit-mode": All AMIs are allowed, but the "ImageAllowed" field is set to "true" if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled. * "enabled": Only AMIs matching the image criteria are discoverable and available for use. * **ImageCriteria** *(list) --* The list of criteria for images that are discoverable and usable in the account in the specified Amazon Web Services Region. * *(dict) --* The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers. Up to 10 "imageCriteria" objects can be specified, and up to a total of 200 values for all "imageProviders". For more information, see JSON configuration for the Allowed AMIs criteria in the *Amazon EC2 User Guide*. * **ImageProviders** *(list) --* A list of AMI providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified. Possible values: "amazon": Allow AMIs created by Amazon Web Services. "aws-marketplace": Allow AMIs created by verified providers in the Amazon Web Services Marketplace. "aws-backup-vault": Allow AMIs created by Amazon Web Services Backup. 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified. "none": Allow AMIs created by your own account only. * *(string) --* * **ManagedBy** *(string) --* The entity that manages the Allowed AMIs settings. Possible values include: * "account" - The Allowed AMIs settings is managed by the account. * "declarative-policy" - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account. EC2 / Client / move_address_to_vpc move_address_to_vpc ******************* EC2.Client.move_address_to_vpc(**kwargs) Note: This action is deprecated. Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. See also: AWS API Documentation **Request Syntax** response = client.move_address_to_vpc( DryRun=True|False, PublicIp='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PublicIp** (*string*) -- **[REQUIRED]** The Elastic IP address. Return type: dict Returns: **Response Syntax** { 'AllocationId': 'string', 'Status': 'MoveInProgress'|'InVpc'|'InClassic' } **Response Structure** * *(dict) --* * **AllocationId** *(string) --* The allocation ID for the Elastic IP address. * **Status** *(string) --* The status of the move of the IP address. **Examples** This example moves the specified Elastic IP address to the EC2-VPC platform. response = client.move_address_to_vpc( PublicIp='54.123.4.56', ) print(response) Expected Output: { 'Status': 'MoveInProgress', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_instance_network_performance_options modify_instance_network_performance_options ******************************************* EC2.Client.modify_instance_network_performance_options(**kwargs) Change the configuration of the network performance options for an existing instance. See also: AWS API Documentation **Request Syntax** response = client.modify_instance_network_performance_options( InstanceId='string', BandwidthWeighting='default'|'vpc-1'|'ebs-1', DryRun=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance to update. * **BandwidthWeighting** (*string*) -- **[REQUIRED]** Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows: default This option uses the standard bandwidth configuration for your instance type. vpc-1 This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth. ebs-1 This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'BandwidthWeighting': 'default'|'vpc-1'|'ebs-1' } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The instance ID that was updated. * **BandwidthWeighting** *(string) --* Contains the updated configuration for bandwidth weighting on the specified instance. EC2 / Client / get_reserved_instances_exchange_quote get_reserved_instances_exchange_quote ************************************* EC2.Client.get_reserved_instances_exchange_quote(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_reserved_instances_exchange_quote( DryRun=True|False, ReservedInstanceIds=[ 'string', ], TargetConfigurations=[ { 'InstanceCount': 123, 'OfferingId': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ReservedInstanceIds** (*list*) -- **[REQUIRED]** The IDs of the Convertible Reserved Instances to exchange. * *(string) --* * **TargetConfigurations** (*list*) -- The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. * *(dict) --* Details about the target configuration. * **InstanceCount** *(integer) --* The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request * **OfferingId** *(string) --* **[REQUIRED]** The Convertible Reserved Instance offering ID. Return type: dict Returns: **Response Syntax** { 'CurrencyCode': 'string', 'IsValidExchange': True|False, 'OutputReservedInstancesWillExpireAt': datetime(2015, 1, 1), 'PaymentDue': 'string', 'ReservedInstanceValueRollup': { 'HourlyPrice': 'string', 'RemainingTotalValue': 'string', 'RemainingUpfrontValue': 'string' }, 'ReservedInstanceValueSet': [ { 'ReservationValue': { 'HourlyPrice': 'string', 'RemainingTotalValue': 'string', 'RemainingUpfrontValue': 'string' }, 'ReservedInstanceId': 'string' }, ], 'TargetConfigurationValueRollup': { 'HourlyPrice': 'string', 'RemainingTotalValue': 'string', 'RemainingUpfrontValue': 'string' }, 'TargetConfigurationValueSet': [ { 'ReservationValue': { 'HourlyPrice': 'string', 'RemainingTotalValue': 'string', 'RemainingUpfrontValue': 'string' }, 'TargetConfiguration': { 'InstanceCount': 123, 'OfferingId': 'string' } }, ], 'ValidationFailureReason': 'string' } **Response Structure** * *(dict) --* Contains the output of GetReservedInstancesExchangeQuote. * **CurrencyCode** *(string) --* The currency of the transaction. * **IsValidExchange** *(boolean) --* If "true", the exchange is valid. If "false", the exchange cannot be completed. * **OutputReservedInstancesWillExpireAt** *(datetime) --* The new end date of the reservation term. * **PaymentDue** *(string) --* The total true upfront charge for the exchange. * **ReservedInstanceValueRollup** *(dict) --* The cost associated with the Reserved Instance. * **HourlyPrice** *(string) --* The hourly rate of the reservation. * **RemainingTotalValue** *(string) --* The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). * **RemainingUpfrontValue** *(string) --* The remaining upfront cost of the reservation. * **ReservedInstanceValueSet** *(list) --* The configuration of your Convertible Reserved Instances. * *(dict) --* The total value of the Convertible Reserved Instance. * **ReservationValue** *(dict) --* The total value of the Convertible Reserved Instance that you are exchanging. * **HourlyPrice** *(string) --* The hourly rate of the reservation. * **RemainingTotalValue** *(string) --* The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). * **RemainingUpfrontValue** *(string) --* The remaining upfront cost of the reservation. * **ReservedInstanceId** *(string) --* The ID of the Convertible Reserved Instance that you are exchanging. * **TargetConfigurationValueRollup** *(dict) --* The cost associated with the Reserved Instance. * **HourlyPrice** *(string) --* The hourly rate of the reservation. * **RemainingTotalValue** *(string) --* The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). * **RemainingUpfrontValue** *(string) --* The remaining upfront cost of the reservation. * **TargetConfigurationValueSet** *(list) --* The values of the target Convertible Reserved Instances. * *(dict) --* The total value of the new Convertible Reserved Instances. * **ReservationValue** *(dict) --* The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange. * **HourlyPrice** *(string) --* The hourly rate of the reservation. * **RemainingTotalValue** *(string) --* The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). * **RemainingUpfrontValue** *(string) --* The remaining upfront cost of the reservation. * **TargetConfiguration** *(dict) --* The configuration of the Convertible Reserved Instances that make up the exchange. * **InstanceCount** *(integer) --* The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request * **OfferingId** *(string) --* The ID of the Convertible Reserved Instance offering. * **ValidationFailureReason** *(string) --* Describes the reason why the exchange cannot be completed. EC2 / Client / delete_route_server_endpoint delete_route_server_endpoint **************************** EC2.Client.delete_route_server_endpoint(**kwargs) Deletes the specified route server endpoint. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. See also: AWS API Documentation **Request Syntax** response = client.delete_route_server_endpoint( RouteServerEndpointId='string', DryRun=True|False ) Parameters: * **RouteServerEndpointId** (*string*) -- **[REQUIRED]** The ID of the route server endpoint to delete. * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RouteServerEndpoint': { 'RouteServerId': 'string', 'RouteServerEndpointId': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'EniId': 'string', 'EniAddress': 'string', 'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed', 'FailureReason': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **RouteServerEndpoint** *(dict) --* Information about the deleted route server endpoint. * **RouteServerId** *(string) --* The ID of the route server associated with this endpoint. * **RouteServerEndpointId** *(string) --* The unique identifier of the route server endpoint. * **VpcId** *(string) --* The ID of the VPC containing the endpoint. * **SubnetId** *(string) --* The ID of the subnet to place the route server endpoint into. * **EniId** *(string) --* The ID of the Elastic network interface for the endpoint. * **EniAddress** *(string) --* The IP address of the Elastic network interface for the endpoint. * **State** *(string) --* The current state of the route server endpoint. * **FailureReason** *(string) --* The reason for any failure in endpoint creation or operation. * **Tags** *(list) --* Any tags assigned to the route server endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / create_route_server_peer create_route_server_peer ************************ EC2.Client.create_route_server_peer(**kwargs) Creates a new BGP peer for a specified route server endpoint. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: * Have an elastic network interface in the VPC * Support BGP (Border Gateway Protocol) * Can initiate BGP sessions For more information see Dynamic routing in your VPC with VPC Route Server in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_route_server_peer( RouteServerEndpointId='string', PeerAddress='string', BgpOptions={ 'PeerAsn': 123, 'PeerLivenessDetection': 'bfd'|'bgp-keepalive' }, DryRun=True|False, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **RouteServerEndpointId** (*string*) -- **[REQUIRED]** The ID of the route server endpoint for which to create a peer. * **PeerAddress** (*string*) -- **[REQUIRED]** The IPv4 address of the peer device. * **BgpOptions** (*dict*) -- **[REQUIRED]** The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. * **PeerAsn** *(integer) --* **[REQUIRED]** The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * **PeerLivenessDetection** *(string) --* The requested liveness detection protocol for the BGP peer. * "bgp-keepalive": The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail-over in cases of network impact or router failure. * "bfd": An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection. Defaults to "bgp-keepalive". * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without 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** (*list*) -- The tags to apply to the route server peer during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'RouteServerPeer': { 'RouteServerPeerId': 'string', 'RouteServerEndpointId': 'string', 'RouteServerId': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed', 'FailureReason': 'string', 'EndpointEniId': 'string', 'EndpointEniAddress': 'string', 'PeerAddress': 'string', 'BgpOptions': { 'PeerAsn': 123, 'PeerLivenessDetection': 'bfd'|'bgp-keepalive' }, 'BgpStatus': { 'Status': 'up'|'down' }, 'BfdStatus': { 'Status': 'up'|'down' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **RouteServerPeer** *(dict) --* Information about the created route server peer. * **RouteServerPeerId** *(string) --* The unique identifier of the route server peer. * **RouteServerEndpointId** *(string) --* The ID of the route server endpoint associated with this peer. * **RouteServerId** *(string) --* The ID of the route server associated with this peer. * **VpcId** *(string) --* The ID of the VPC containing the route server peer. * **SubnetId** *(string) --* The ID of the subnet containing the route server peer. * **State** *(string) --* The current state of the route server peer. * **FailureReason** *(string) --* The reason for any failure in peer creation or operation. * **EndpointEniId** *(string) --* The ID of the Elastic network interface for the route server endpoint. * **EndpointEniAddress** *(string) --* The IP address of the Elastic network interface for the route server endpoint. * **PeerAddress** *(string) --* The IPv4 address of the peer device. * **BgpOptions** *(dict) --* The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. * **PeerAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * **PeerLivenessDetection** *(string) --* The liveness detection protocol used for the BGP peer. The requested liveness detection protocol for the BGP peer. * "bgp-keepalive": The standard BGP keep alive mechanism ( RFC4271) that is stable but may take longer to fail- over in cases of network impact or router failure. * "bfd": An additional Bidirectional Forwarding Detection (BFD) protocol ( RFC5880) that enables fast failover by using more sensitive liveness detection. Defaults to "bgp-keepalive". * **BgpStatus** *(dict) --* The current status of the BGP session with this peer. * **Status** *(string) --* The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance. * **BfdStatus** *(dict) --* The current status of the BFD session with this peer. * **Status** *(string) --* The operational status of the BFD session. * **Tags** *(list) --* Any tags assigned to the route server peer. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_transit_gateway_route_table_announcements describe_transit_gateway_route_table_announcements ************************************************** EC2.Client.describe_transit_gateway_route_table_announcements(**kwargs) Describes one or more transit gateway route table advertisements. See also: AWS API Documentation **Request Syntax** response = client.describe_transit_gateway_route_table_announcements( TransitGatewayRouteTableAnnouncementIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableAnnouncementIds** (*list*) -- The IDs of the transit gateway route tables that are being advertised. * *(string) --* * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTableAnnouncements': [ { 'TransitGatewayRouteTableAnnouncementId': 'string', 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'PeerTransitGatewayId': 'string', 'PeerCoreNetworkId': 'string', 'PeeringAttachmentId': 'string', 'AnnouncementDirection': 'outgoing'|'incoming', 'TransitGatewayRouteTableId': 'string', 'State': 'available'|'pending'|'failing'|'failed'|'deleting'|'deleted', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TransitGatewayRouteTableAnnouncements** *(list) --* Describes the transit gateway route table announcement. * *(dict) --* Describes a transit gateway route table announcement. * **TransitGatewayRouteTableAnnouncementId** *(string) --* The ID of the transit gateway route table announcement. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network for the transit gateway route table announcement. * **PeerTransitGatewayId** *(string) --* The ID of the peer transit gateway. * **PeerCoreNetworkId** *(string) --* The ID of the core network ID for the peer. * **PeeringAttachmentId** *(string) --* The ID of the peering attachment. * **AnnouncementDirection** *(string) --* The direction for the route table announcement. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **State** *(string) --* The state of the transit gateway announcement. * **CreationTime** *(datetime) --* The timestamp when the transit gateway route table announcement was created. * **Tags** *(list) --* The key-value pairs associated with the route table announcement. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token for the next page of results. EC2 / Client / create_local_gateway_route_table create_local_gateway_route_table ******************************** EC2.Client.create_local_gateway_route_table(**kwargs) Creates a local gateway route table. See also: AWS API Documentation **Request Syntax** response = client.create_local_gateway_route_table( LocalGatewayId='string', Mode='direct-vpc-routing'|'coip', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **LocalGatewayId** (*string*) -- **[REQUIRED]** The ID of the local gateway. * **Mode** (*string*) -- The mode of the local gateway route table. * **TagSpecifications** (*list*) -- The tags assigned to the local gateway route table. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LocalGatewayRouteTable': { 'LocalGatewayRouteTableId': 'string', 'LocalGatewayRouteTableArn': 'string', 'LocalGatewayId': 'string', 'OutpostArn': 'string', 'OwnerId': 'string', 'State': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Mode': 'direct-vpc-routing'|'coip', 'StateReason': { 'Code': 'string', 'Message': 'string' } } } **Response Structure** * *(dict) --* * **LocalGatewayRouteTable** *(dict) --* Information about the local gateway route table. * **LocalGatewayRouteTableId** *(string) --* The ID of the local gateway route table. * **LocalGatewayRouteTableArn** *(string) --* The Amazon Resource Name (ARN) of the local gateway route table. * **LocalGatewayId** *(string) --* The ID of the local gateway. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the local gateway route table. * **State** *(string) --* The state of the local gateway route table. * **Tags** *(list) --* The tags assigned to the local gateway route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Mode** *(string) --* The mode of the local gateway route table. * **StateReason** *(dict) --* Information about the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. EC2 / Client / describe_spot_datafeed_subscription describe_spot_datafeed_subscription *********************************** EC2.Client.describe_spot_datafeed_subscription(**kwargs) Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_spot_datafeed_subscription( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SpotDatafeedSubscription': { 'Bucket': 'string', 'Fault': { 'Code': 'string', 'Message': 'string' }, 'OwnerId': 'string', 'Prefix': 'string', 'State': 'Active'|'Inactive' } } **Response Structure** * *(dict) --* Contains the output of DescribeSpotDatafeedSubscription. * **SpotDatafeedSubscription** *(dict) --* The Spot Instance data feed subscription. * **Bucket** *(string) --* The name of the Amazon S3 bucket where the Spot Instance data feed is located. * **Fault** *(dict) --* The fault codes for the Spot Instance request, if any. * **Code** *(string) --* The reason code for the Spot Instance state change. * **Message** *(string) --* The message for the Spot Instance state change. * **OwnerId** *(string) --* The Amazon Web Services account ID of the account. * **Prefix** *(string) --* The prefix for the data feed files. * **State** *(string) --* The state of the Spot Instance data feed subscription. **Examples** This example describes the Spot Instance datafeed subscription for your AWS account. response = client.describe_spot_datafeed_subscription( ) print(response) Expected Output: { 'SpotDatafeedSubscription': { 'Bucket': 'my-s3-bucket', 'OwnerId': '123456789012', 'Prefix': 'spotdata', 'State': 'Active', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / create_client_vpn_route create_client_vpn_route *********************** EC2.Client.create_client_vpn_route(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_client_vpn_route( ClientVpnEndpointId='string', DestinationCidrBlock='string', TargetVpcSubnetId='string', Description='string', ClientToken='string', DryRun=True|False ) Parameters: * **ClientVpnEndpointId** (*string*) -- **[REQUIRED]** The ID of the Client VPN endpoint to which to add the route. * **DestinationCidrBlock** (*string*) -- **[REQUIRED]** 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 Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range * To add a route for the local network, enter the client CIDR range * **TargetVpcSubnetId** (*string*) -- **[REQUIRED]** 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". * **Description** (*string*) -- A brief description of the route. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Status': { 'Code': 'creating'|'active'|'failed'|'deleting', 'Message': 'string' } } **Response Structure** * *(dict) --* * **Status** *(dict) --* The current state of the route. * **Code** *(string) --* The state of the Client VPN endpoint route. * **Message** *(string) --* A message about the status of the Client VPN endpoint route, if applicable. EC2 / Client / modify_capacity_reservation_fleet modify_capacity_reservation_fleet ********************************* EC2.Client.modify_capacity_reservation_fleet(**kwargs) Modifies a Capacity Reservation Fleet. When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly. See also: AWS API Documentation **Request Syntax** response = client.modify_capacity_reservation_fleet( CapacityReservationFleetId='string', TotalTargetCapacity=123, EndDate=datetime(2015, 1, 1), DryRun=True|False, RemoveEndDate=True|False ) Parameters: * **CapacityReservationFleetId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation Fleet to modify. * **TotalTargetCapacity** (*integer*) -- The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **EndDate** (*datetime*) -- The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to "expired" and all of the Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify "5/31/2019", "13:30:55", the Capacity Reservation Fleet is guaranteed to expire between "13:30:55" and "14:30:55" on "5/31/2019". You can't specify **EndDate** and **RemoveEndDate** in the same request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RemoveEndDate** (*boolean*) -- Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the **CancelCapacityReservationFleet** action. You can't specify **RemoveEndDate** and **EndDate** in the same request. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / describe_vpn_connections describe_vpn_connections ************************ EC2.Client.describe_vpn_connections(**kwargs) Describes one or more of your VPN connections. For more information, see Amazon Web Services Site-to-Site VPN in the *Amazon Web Services Site-to-Site VPN User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_vpn_connections( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], VpnConnectionIds=[ 'string', ], DryRun=True|False ) Parameters: * **Filters** (*list*) -- 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": - 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". * "vpn-connection-id" - The ID of the VPN connection. * "vpn-gateway-id" - The ID of a virtual private gateway associated with the VPN connection. * "transit-gateway-id" - The ID of a transit gateway associated with the VPN connection. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **VpnConnectionIds** (*list*) -- One or more VPN connection IDs. Default: Describes your VPN connections. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VpnConnections': [ { 'Category': 'string', 'TransitGatewayId': 'string', 'CoreNetworkArn': 'string', 'CoreNetworkAttachmentArn': 'string', 'GatewayAssociationState': 'associated'|'not-associated'|'associating'|'disassociating', 'Options': { 'EnableAcceleration': True|False, 'StaticRoutesOnly': True|False, 'LocalIpv4NetworkCidr': 'string', 'RemoteIpv4NetworkCidr': 'string', 'LocalIpv6NetworkCidr': 'string', 'RemoteIpv6NetworkCidr': 'string', 'OutsideIpAddressType': 'string', 'TransportTransitGatewayAttachmentId': 'string', 'TunnelInsideIpVersion': 'ipv4'|'ipv6', 'TunnelOptions': [ { 'OutsideIpAddress': 'string', 'TunnelInsideCidr': 'string', 'TunnelInsideIpv6Cidr': 'string', 'PreSharedKey': 'string', 'Phase1LifetimeSeconds': 123, 'Phase2LifetimeSeconds': 123, 'RekeyMarginTimeSeconds': 123, 'RekeyFuzzPercentage': 123, 'ReplayWindowSize': 123, 'DpdTimeoutSeconds': 123, 'DpdTimeoutAction': 'string', 'Phase1EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase2EncryptionAlgorithms': [ { 'Value': 'string' }, ], 'Phase1IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase2IntegrityAlgorithms': [ { 'Value': 'string' }, ], 'Phase1DHGroupNumbers': [ { 'Value': 123 }, ], 'Phase2DHGroupNumbers': [ { 'Value': 123 }, ], 'IkeVersions': [ { 'Value': 'string' }, ], 'StartupAction': 'string', 'LogOptions': { 'CloudWatchLogOptions': { 'LogEnabled': True|False, 'LogGroupArn': 'string', 'LogOutputFormat': 'string' } }, 'EnableTunnelLifecycleControl': True|False }, ] }, 'Routes': [ { 'DestinationCidrBlock': 'string', 'Source': 'Static', 'State': 'pending'|'available'|'deleting'|'deleted' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VgwTelemetry': [ { 'AcceptedRouteCount': 123, 'LastStatusChange': datetime(2015, 1, 1), 'OutsideIpAddress': 'string', 'Status': 'UP'|'DOWN', 'StatusMessage': 'string', 'CertificateArn': 'string' }, ], 'PreSharedKeyArn': 'string', 'VpnConnectionId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'CustomerGatewayConfiguration': 'string', 'Type': 'ipsec.1', 'CustomerGatewayId': 'string', 'VpnGatewayId': 'string' }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeVpnConnections. * **VpnConnections** *(list) --* Information about one or more VPN connections. * *(dict) --* Describes a VPN connection. * **Category** *(string) --* The category of the VPN connection. A value of "VPN" indicates an Amazon Web Services VPN connection. A value of "VPN-Classic" indicates an Amazon Web Services Classic VPN connection. * **TransitGatewayId** *(string) --* The ID of the transit gateway associated with the VPN connection. * **CoreNetworkArn** *(string) --* The ARN of the core network. * **CoreNetworkAttachmentArn** *(string) --* The ARN of the core network attachment. * **GatewayAssociationState** *(string) --* The current state of the gateway association. * **Options** *(dict) --* The VPN connection options. * **EnableAcceleration** *(boolean) --* Indicates whether acceleration is enabled for the VPN connection. * **StaticRoutesOnly** *(boolean) --* Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. * **LocalIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv4NetworkCidr** *(string) --* The IPv4 CIDR on the Amazon Web Services side of the VPN connection. * **LocalIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. * **RemoteIpv6NetworkCidr** *(string) --* The IPv6 CIDR on the Amazon Web Services side of the VPN connection. * **OutsideIpAddressType** *(string) --* The type of IPv4 address assigned to the outside interface of the customer gateway. Valid values: "PrivateIpv4" | "PublicIpv4" | "Ipv6" Default: "PublicIpv4" * **TransportTransitGatewayAttachmentId** *(string) --* The transit gateway attachment ID in use for the VPN tunnel. * **TunnelInsideIpVersion** *(string) --* Indicates whether the VPN tunnels process IPv4 or IPv6 traffic. * **TunnelOptions** *(list) --* Indicates the VPN tunnel options. * *(dict) --* The VPN tunnel options. * **OutsideIpAddress** *(string) --* The external IP address of the VPN tunnel. * **TunnelInsideCidr** *(string) --* The range of inside IPv4 addresses for the tunnel. * **TunnelInsideIpv6Cidr** *(string) --* The range of inside IPv6 addresses for the tunnel. * **PreSharedKey** *(string) --* The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. * **Phase1LifetimeSeconds** *(integer) --* The lifetime for phase 1 of the IKE negotiation, in seconds. * **Phase2LifetimeSeconds** *(integer) --* The lifetime for phase 2 of the IKE negotiation, in seconds. * **RekeyMarginTimeSeconds** *(integer) --* The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. * **RekeyFuzzPercentage** *(integer) --* The percentage of the rekey window determined by "RekeyMarginTimeSeconds" during which the rekey time is randomly selected. * **ReplayWindowSize** *(integer) --* The number of packets in an IKE replay window. * **DpdTimeoutSeconds** *(integer) --* The number of seconds after which a DPD timeout occurs. * **DpdTimeoutAction** *(string) --* The action to take after a DPD timeout occurs. * **Phase1EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The encryption algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the encryption algorithm. * **Phase2EncryptionAlgorithms** *(list) --* The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The encryption algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The encryption algorithm. * **Phase1IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The integrity algorithm for phase 1 IKE negotiations. * **Value** *(string) --* The value for the integrity algorithm. * **Phase2IntegrityAlgorithms** *(list) --* The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The integrity algorithm for phase 2 IKE negotiations. * **Value** *(string) --* The integrity algorithm. * **Phase1DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 1 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **Phase2DHGroupNumbers** *(list) --* The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations. * *(dict) --* The Diffie-Hellmann group number for phase 2 IKE negotiations. * **Value** *(integer) --* The Diffie-Hellmann group number. * **IkeVersions** *(list) --* The IKE versions that are permitted for the VPN tunnel. * *(dict) --* The internet key exchange (IKE) version permitted for the VPN tunnel. * **Value** *(string) --* The IKE version. * **StartupAction** *(string) --* The action to take when the establishing the VPN tunnels for a VPN connection. * **LogOptions** *(dict) --* Options for logging VPN tunnel activity. * **CloudWatchLogOptions** *(dict) --* Options for sending VPN tunnel logs to CloudWatch. * **LogEnabled** *(boolean) --* Status of VPN tunnel logging feature. Default value is "False". Valid values: "True" | "False" * **LogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to. * **LogOutputFormat** *(string) --* Configured log format. Default format is "json". Valid values: "json" | "text" * **EnableTunnelLifecycleControl** *(boolean) --* Status of tunnel endpoint lifecycle control feature. * **Routes** *(list) --* The static routes associated with the VPN connection. * *(dict) --* Describes a static route for a VPN connection. * **DestinationCidrBlock** *(string) --* The CIDR block associated with the local subnet of the customer data center. * **Source** *(string) --* Indicates how the routes were provided. * **State** *(string) --* The current state of the static route. * **Tags** *(list) --* Any tags assigned to the VPN connection. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VgwTelemetry** *(list) --* Information about the VPN tunnel. * *(dict) --* Describes telemetry for a VPN tunnel. * **AcceptedRouteCount** *(integer) --* The number of accepted routes. * **LastStatusChange** *(datetime) --* The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected. * **OutsideIpAddress** *(string) --* The Internet-routable IP address of the virtual private gateway's outside interface. * **Status** *(string) --* The status of the VPN tunnel. * **StatusMessage** *(string) --* If an error occurs, a description of the error. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. * **PreSharedKeyArn** *(string) --* The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. * **VpnConnectionId** *(string) --* The ID of the VPN connection. * **State** *(string) --* The current state of the VPN connection. * **CustomerGatewayConfiguration** *(string) --* The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the "pending" or "available" state. * **Type** *(string) --* The type of VPN connection. * **CustomerGatewayId** *(string) --* The ID of the customer gateway at your end of the VPN connection. * **VpnGatewayId** *(string) --* The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. EC2 / Client / associate_transit_gateway_route_table associate_transit_gateway_route_table ************************************* EC2.Client.associate_transit_gateway_route_table(**kwargs) Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. See also: AWS API Documentation **Request Syntax** response = client.associate_transit_gateway_route_table( TransitGatewayRouteTableId='string', TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Association': { 'TransitGatewayRouteTableId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' } } **Response Structure** * *(dict) --* * **Association** *(dict) --* The ID of the association. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the association. EC2 / Client / describe_network_insights_access_scope_analyses describe_network_insights_access_scope_analyses *********************************************** EC2.Client.describe_network_insights_access_scope_analyses(**kwargs) Describes the specified Network Access Scope analyses. See also: AWS API Documentation **Request Syntax** response = client.describe_network_insights_access_scope_analyses( NetworkInsightsAccessScopeAnalysisIds=[ 'string', ], NetworkInsightsAccessScopeId='string', AnalysisStartTimeBegin=datetime(2015, 1, 1), AnalysisStartTimeEnd=datetime(2015, 1, 1), Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, DryRun=True|False, NextToken='string' ) Parameters: * **NetworkInsightsAccessScopeAnalysisIds** (*list*) -- The IDs of the Network Access Scope analyses. * *(string) --* * **NetworkInsightsAccessScopeId** (*string*) -- The ID of the Network Access Scope. * **AnalysisStartTimeBegin** (*datetime*) -- Filters the results based on the start time. The analysis must have started on or after this time. * **AnalysisStartTimeEnd** (*datetime*) -- Filters the results based on the start time. The analysis must have started on or before this time. * **Filters** (*list*) -- There are no supported filters. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned "nextToken" value. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'NetworkInsightsAccessScopeAnalyses': [ { 'NetworkInsightsAccessScopeAnalysisId': 'string', 'NetworkInsightsAccessScopeAnalysisArn': 'string', 'NetworkInsightsAccessScopeId': 'string', 'Status': 'running'|'succeeded'|'failed', 'StatusMessage': 'string', 'WarningMessage': 'string', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'FindingsFound': 'true'|'false'|'unknown', 'AnalyzedEniCount': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NetworkInsightsAccessScopeAnalyses** *(list) --* The Network Access Scope analyses. * *(dict) --* Describes a Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisId** *(string) --* The ID of the Network Access Scope analysis. * **NetworkInsightsAccessScopeAnalysisArn** *(string) --* The Amazon Resource Name (ARN) of the Network Access Scope analysis. * **NetworkInsightsAccessScopeId** *(string) --* The ID of the Network Access Scope. * **Status** *(string) --* The status. * **StatusMessage** *(string) --* The status message. * **WarningMessage** *(string) --* The warning message. * **StartDate** *(datetime) --* The analysis start date. * **EndDate** *(datetime) --* The analysis end date. * **FindingsFound** *(string) --* Indicates whether there are findings. * **AnalyzedEniCount** *(integer) --* The number of network interfaces analyzed. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / modify_snapshot_tier modify_snapshot_tier ******************** EC2.Client.modify_snapshot_tier(**kwargs) Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_snapshot_tier( SnapshotId='string', StorageTier='archive', DryRun=True|False ) Parameters: * **SnapshotId** (*string*) -- **[REQUIRED]** The ID of the snapshot. * **StorageTier** (*string*) -- The name of the storage tier. You must specify "archive". * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SnapshotId': 'string', 'TieringStartTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **SnapshotId** *(string) --* The ID of the snapshot. * **TieringStartTime** *(datetime) --* The date and time when the archive process was started. EC2 / Client / accept_transit_gateway_peering_attachment accept_transit_gateway_peering_attachment ***************************************** EC2.Client.accept_transit_gateway_peering_attachment(**kwargs) Accepts a transit gateway peering attachment request. The peering attachment must be in the "pendingAcceptance" state. See also: AWS API Documentation **Request Syntax** response = client.accept_transit_gateway_peering_attachment( TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the transit gateway attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPeeringAttachment': { 'TransitGatewayAttachmentId': 'string', 'AccepterTransitGatewayAttachmentId': 'string', 'RequesterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'AccepterTgwInfo': { 'TransitGatewayId': 'string', 'CoreNetworkId': 'string', 'OwnerId': 'string', 'Region': 'string' }, 'Options': { 'DynamicRouting': 'enable'|'disable' }, 'Status': { 'Code': 'string', 'Message': 'string' }, 'State': 'initiating'|'initiatingRequest'|'pendingAcceptance'|'rollingBack'|'pending'|'available'|'modifying'|'deleting'|'deleted'|'failed'|'rejected'|'rejecting'|'failing', 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayPeeringAttachment** *(dict) --* The transit gateway peering attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the transit gateway peering attachment. * **AccepterTransitGatewayAttachmentId** *(string) --* The ID of the accepter transit gateway attachment. * **RequesterTgwInfo** *(dict) --* Information about the requester transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **AccepterTgwInfo** *(dict) --* Information about the accepter transit gateway. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **CoreNetworkId** *(string) --* The ID of the core network where the transit gateway peer is located. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the transit gateway. * **Region** *(string) --* The Region of the transit gateway. * **Options** *(dict) --* Details about the transit gateway peering attachment. * **DynamicRouting** *(string) --* Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment. * **Status** *(dict) --* The status of the transit gateway peering attachment. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message, if applicable. * **State** *(string) --* The state of the transit gateway peering attachment. Note that the "initiating" state has been deprecated. * **CreationTime** *(datetime) --* The time the transit gateway peering attachment was created. * **Tags** *(list) --* The tags for the transit gateway peering attachment. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / confirm_product_instance confirm_product_instance ************************ EC2.Client.confirm_product_instance(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.confirm_product_instance( InstanceId='string', ProductCode='string', DryRun=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **ProductCode** (*string*) -- **[REQUIRED]** The product code. This must be a product code that you own. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'OwnerId': 'string' } **Response Structure** * *(dict) --* * **Return** *(boolean) --* The return value of the request. Returns "true" if the specified product code is owned by the requester and associated with the specified instance. * **OwnerId** *(string) --* The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance. **Examples** This example determines whether the specified product code is associated with the specified instance. response = client.confirm_product_instance( InstanceId='i-1234567890abcdef0', ProductCode='774F4FF8', ) print(response) Expected Output: { 'OwnerId': '123456789012', 'ResponseMetadata': { '...': '...', }, } EC2 / Client / revoke_security_group_ingress revoke_security_group_ingress ***************************** EC2.Client.revoke_security_group_ingress(**kwargs) Removes the specified inbound (ingress) rules from a security group. You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule. For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked. For a non-default VPC, if the values you specify do not match the existing rule's values, an "InvalidPermission.NotFound" client error is returned, and no rules are revoked. Amazon Web Services recommends that you describe the security group to verify that the rules were removed. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. See also: AWS API Documentation **Request Syntax** response = client.revoke_security_group_ingress( CidrIp='string', FromPort=123, GroupId='string', GroupName='string', IpPermissions=[ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], IpProtocol='string', SourceSecurityGroupName='string', SourceSecurityGroupOwnerId='string', ToPort=123, SecurityGroupRuleIds=[ 'string', ], DryRun=True|False ) Parameters: * **CidrIp** (*string*) -- The CIDR IP address range. You can't specify this parameter when specifying a source security group. * **FromPort** (*integer*) -- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types). * **GroupId** (*string*) -- The ID of the security group. * **GroupName** (*string*) -- [Default VPC] The name 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. * **IpPermissions** (*list*) -- 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. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non- canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **IpProtocol** (*string*) -- The IP protocol name ( "tcp", "udp", "icmp") or number (see Protocol Numbers). Use "-1" to specify all. * **SourceSecurityGroupName** (*string*) -- [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. 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** (*string*) -- Not supported. * **ToPort** (*integer*) -- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). * **SecurityGroupRuleIds** (*list*) -- The IDs of the security group rules. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Return': True|False, 'UnknownIpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'RevokedSecurityGroupRules': [ { 'SecurityGroupRuleId': 'string', 'GroupId': 'string', 'IsEgress': True|False, 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'CidrIpv4': 'string', 'CidrIpv6': 'string', 'PrefixListId': 'string', 'ReferencedGroupId': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, returns an error. * **UnknownIpPermissions** *(list) --* The inbound rules that were unknown to the service. In some cases, "unknownIpPermissionSet" might be in a different format from the request parameter. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **RevokedSecurityGroupRules** *(list) --* Details about the revoked security group rules. * *(dict) --* A security group rule removed with RevokeSecurityGroupEgress or RevokeSecurityGroupIngress. * **SecurityGroupRuleId** *(string) --* A security group rule ID. * **GroupId** *(string) --* A security group ID. * **IsEgress** *(boolean) --* Defines if a security group rule is an outbound rule. * **IpProtocol** *(string) --* The security group rule's protocol. * **FromPort** *(integer) --* The 'from' port number of the security group rule. * **ToPort** *(integer) --* The 'to' port number of the security group rule. * **CidrIpv4** *(string) --* The IPv4 CIDR of the traffic source. * **CidrIpv6** *(string) --* The IPv6 CIDR of the traffic source. * **PrefixListId** *(string) --* The ID of a prefix list that's the traffic source. * **ReferencedGroupId** *(string) --* The ID of a referenced security group. * **Description** *(string) --* A description of the revoked security group rule. EC2 / Client / delete_transit_gateway_prefix_list_reference delete_transit_gateway_prefix_list_reference ******************************************** EC2.Client.delete_transit_gateway_prefix_list_reference(**kwargs) Deletes a reference (route) to a prefix list in a specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.delete_transit_gateway_prefix_list_reference( TransitGatewayRouteTableId='string', PrefixListId='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPrefixListReference': { 'TransitGatewayRouteTableId': 'string', 'PrefixListId': 'string', 'PrefixListOwnerId': 'string', 'State': 'pending'|'available'|'modifying'|'deleting', 'Blackhole': True|False, 'TransitGatewayAttachment': { 'TransitGatewayAttachmentId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceId': 'string' } } } **Response Structure** * *(dict) --* * **TransitGatewayPrefixListReference** *(dict) --* Information about the deleted prefix list reference. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **PrefixListId** *(string) --* The ID of the prefix list. * **PrefixListOwnerId** *(string) --* The ID of the prefix list owner. * **State** *(string) --* The state of the prefix list reference. * **Blackhole** *(boolean) --* Indicates whether traffic that matches this route is dropped. * **TransitGatewayAttachment** *(dict) --* Information about the transit gateway attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / delete_vpc_peering_connection delete_vpc_peering_connection ***************************** EC2.Client.delete_vpc_peering_connection(**kwargs) Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the "active" state. The owner of the requester VPC can delete a VPC peering connection in the "pending- acceptance" state. You cannot delete a VPC peering connection that's in the "failed" or "rejected" state. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_peering_connection( DryRun=True|False, VpcPeeringConnectionId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the VPC peering connection. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / describe_network_interfaces describe_network_interfaces *************************** EC2.Client.describe_network_interfaces(**kwargs) Describes the specified network interfaces or all your network interfaces. If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: "group-id", "mac-address", "private-dns-name", "private-ip- address", "subnet-id", or "vpc-id". Warning: We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. See also: AWS API Documentation **Request Syntax** response = client.describe_network_interfaces( NextToken='string', MaxResults=123, DryRun=True|False, NetworkInterfaceIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkInterfaceIds** (*list*) -- The network interface IDs. Default: Describes all your network interfaces. * *(string) --* * **Filters** (*list*) -- One or more filters. * "association.allocation-id" - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. * "association.association-id" - The association ID returned when the network interface was associated with an IPv4 address. * "addresses.association.owner-id" - The owner ID of the addresses 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.primary" - Whether the private IPv4 address is the primary IP address associated with the network interface. * "addresses.private-ip-address" - The private IPv4 addresses associated with the 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.attach-time" - The time that the network interface was attached to an instance. * "attachment.attachment-id" - The ID of the interface attachment. * "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. * "ipv6-addresses.ipv6-address" - An IPv6 address associated with the network interface. * "interface-type" - The type of network interface ( "api_gateway_managed" | "aws_codestar_connections_managed" | "branch" | "ec2_instance_connect_endpoint" | "efa" | "efa- only" | "efs" | "evs" | "gateway_load_balancer" | "gateway_load_balancer_endpoint" | "global_accelerator_managed" | "interface" | "iot_rules_managed" | "lambda" | "load_balancer" | "nat_gateway" | "network_load_balancer" | "quicksight" | "transit_gateway" | "trunk" | "vpc_endpoint"). * "mac-address" - The MAC address of the network interface. * "network-interface-id" - The ID of the network interface. * "operator.managed" - A Boolean that indicates whether this is a managed network interface. * "operator.principal" - The principal that manages the network interface. Only valid for managed network interfaces, where "managed" is "true". * "owner-id" - The Amazon Web Services account ID of the network interface owner. * "private-dns-name" - The private DNS name of the network interface (IPv4). * "private-ip-address" - The private IPv4 address or addresses of the network interface. * "requester-id" - The alias or Amazon Web Services account ID of the principal or service that created the network interface. * "requester-managed" - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services 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": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NetworkInterfaces': [ { 'Association': { 'AllocationId': 'string', 'AssociationId': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string', 'CustomerOwnedIp': 'string', 'CarrierIp': 'string' }, 'Attachment': { 'AttachTime': datetime(2015, 1, 1), 'AttachmentId': 'string', 'DeleteOnTermination': True|False, 'DeviceIndex': 123, 'NetworkCardIndex': 123, 'InstanceId': 'string', 'InstanceOwnerId': 'string', 'Status': 'attaching'|'attached'|'detaching'|'detached', 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'EnaQueueCount': 123 }, 'AvailabilityZone': 'string', 'ConnectionTrackingConfiguration': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'Description': 'string', 'Groups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'InterfaceType': 'interface'|'natGateway'|'efa'|'efa-only'|'trunk'|'load_balancer'|'network_load_balancer'|'vpc_endpoint'|'branch'|'transit_gateway'|'lambda'|'quicksight'|'global_accelerator_managed'|'api_gateway_managed'|'gateway_load_balancer'|'gateway_load_balancer_endpoint'|'iot_rules_managed'|'aws_codestar_connections_managed', 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'PublicIpv6DnsName': 'string', 'IsPrimaryIpv6': True|False }, ], 'MacAddress': 'string', 'NetworkInterfaceId': 'string', 'OutpostArn': 'string', 'OwnerId': 'string', 'PrivateDnsName': 'string', 'PublicDnsName': 'string', 'PublicIpDnsNameOptions': { 'DnsHostnameType': 'string', 'PublicIpv4DnsName': 'string', 'PublicIpv6DnsName': 'string', 'PublicDualStackDnsName': 'string' }, 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Association': { 'AllocationId': 'string', 'AssociationId': 'string', 'IpOwnerId': 'string', 'PublicDnsName': 'string', 'PublicIp': 'string', 'CustomerOwnedIp': 'string', 'CarrierIp': 'string' }, 'Primary': True|False, 'PrivateDnsName': 'string', 'PrivateIpAddress': 'string' }, ], 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'RequesterId': 'string', 'RequesterManaged': True|False, 'SourceDestCheck': True|False, 'Status': 'available'|'associated'|'attaching'|'in-use'|'detaching', 'SubnetId': 'string', 'TagSet': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'DenyAllIgwTraffic': True|False, 'Ipv6Native': True|False, 'Ipv6Address': 'string', 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'AssociatedSubnets': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NetworkInterfaces** *(list) --* Information about the network interfaces. * *(dict) --* Describes a network interface. * **Association** *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. * **Attachment** *(dict) --* The network interface attachment. * **AttachTime** *(datetime) --* The timestamp indicating when the attachment initiated. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. * **DeviceIndex** *(integer) --* The device index of the network interface attachment on the instance. * **NetworkCardIndex** *(integer) --* The index of the network card. * **InstanceId** *(string) --* The ID of the instance. * **InstanceOwnerId** *(string) --* The Amazon Web Services account ID of the owner of the instance. * **Status** *(string) --* The attachment state. * **EnaSrdSpecification** *(dict) --* Configures ENA Express for the network interface that this action attaches to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnaQueueCount** *(integer) --* The number of ENA queues created with the instance. * **AvailabilityZone** *(string) --* The Availability Zone. * **ConnectionTrackingConfiguration** *(dict) --* A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **Description** *(string) --* A description. * **Groups** *(list) --* Any security groups for the network interface. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **GroupName** *(string) --* The name of the security group. * **InterfaceType** *(string) --* The type of network interface. * **Ipv6Addresses** *(list) --* The IPv6 addresses associated with the network interface. * *(dict) --* Describes an IPv6 address associated with a network interface. * **Ipv6Address** *(string) --* The IPv6 address. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute. * **MacAddress** *(string) --* The MAC address. * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the network interface. * **PrivateDnsName** *(string) --* The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicDnsName** *(string) --* A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicIpDnsNameOptions** *(dict) --* Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **DnsHostnameType** *(string) --* The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the *Amazon EC2 User Guide*. * **PublicIpv4DnsName** *(string) --* An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface. * **PublicIpv6DnsName** *(string) --* An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. * **PublicDualStackDnsName** *(string) --* A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface. * **PrivateIpAddress** *(string) --* The IPv4 address of the network interface within the subnet. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses associated with the network interface. * *(dict) --* Describes the private IPv4 address of a network interface. * **Association** *(dict) --* The association information for an Elastic IP address (IPv4) associated with the network interface. * **AllocationId** *(string) --* The allocation ID. * **AssociationId** *(string) --* The association ID. * **IpOwnerId** *(string) --* The ID of the Elastic IP address owner. * **PublicDnsName** *(string) --* The public DNS name. * **PublicIp** *(string) --* The address of the Elastic IP address bound to the network interface. * **CustomerOwnedIp** *(string) --* The customer-owned IP address associated with the network interface. * **CarrierIp** *(string) --* The carrier IP address associated with the network interface. This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone. * **Primary** *(boolean) --* Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. * **PrivateDnsName** *(string) --* The private DNS name. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **Ipv4Prefixes** *(list) --* The IPv4 prefixes that are assigned to the network interface. * *(dict) --* Describes an IPv4 prefix. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv6Prefixes** *(list) --* The IPv6 prefixes that are assigned to the network interface. * *(dict) --* Describes the IPv6 prefix. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **RequesterId** *(string) --* The alias or Amazon Web Services account ID of the principal or service that created the network interface. * **RequesterManaged** *(boolean) --* Indicates whether the network interface is being managed by Amazon Web Services. * **SourceDestCheck** *(boolean) --* Indicates whether source/destination checking is enabled. * **Status** *(string) --* The status of the network interface. * **SubnetId** *(string) --* The ID of the subnet. * **TagSet** *(list) --* Any tags assigned to the network interface. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC. * **DenyAllIgwTraffic** *(boolean) --* Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is "true", inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks. * **Ipv6Native** *(boolean) --* Indicates whether this is an IPv6 only network interface. * **Ipv6Address** *(string) --* The IPv6 globally unique address associated with the network interface. * **Operator** *(dict) --* The service provider that manages the network interface. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **AssociatedSubnets** *(list) --* The subnets associated with this network interface. * *(string) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. **Examples** response = client.describe_network_interfaces( NetworkInterfaceIds=[ 'eni-e5aa89a3', ], ) print(response) Expected Output: { 'NetworkInterfaces': [ { 'Association': { 'AssociationId': 'eipassoc-0fbb766a', 'IpOwnerId': '123456789012', 'PublicDnsName': 'ec2-203-0-113-12.compute-1.amazonaws.com', 'PublicIp': '203.0.113.12', }, 'Attachment': { 'AttachTime': datetime(2013, 11, 30, 23, 36, 42, 5, 334, 0), 'AttachmentId': 'eni-attach-66c4350a', 'DeleteOnTermination': False, 'DeviceIndex': 1, 'InstanceId': 'i-1234567890abcdef0', 'InstanceOwnerId': '123456789012', 'Status': 'attached', }, 'AvailabilityZone': 'us-east-1d', 'Description': 'my network interface', 'Groups': [ { 'GroupId': 'sg-8637d3e3', 'GroupName': 'default', }, ], 'MacAddress': '02:2f:8f:b0:cf:75', 'NetworkInterfaceId': 'eni-e5aa89a3', 'OwnerId': '123456789012', 'PrivateDnsName': 'ip-10-0-1-17.ec2.internal', 'PrivateIpAddress': '10.0.1.17', 'PrivateIpAddresses': [ { 'Association': { 'AssociationId': 'eipassoc-0fbb766a', 'IpOwnerId': '123456789012', 'PublicDnsName': 'ec2-203-0-113-12.compute-1.amazonaws.com', 'PublicIp': '203.0.113.12', }, 'Primary': True, 'PrivateDnsName': 'ip-10-0-1-17.ec2.internal', 'PrivateIpAddress': '10.0.1.17', }, ], 'RequesterManaged': False, 'SourceDestCheck': True, 'Status': 'in-use', 'SubnetId': 'subnet-b61f49f0', 'TagSet': [ ], 'VpcId': 'vpc-a01106c2', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_reserved_instances_listings describe_reserved_instances_listings ************************************ EC2.Client.describe_reserved_instances_listings(**kwargs) Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see Sell in the Reserved Instance Marketplace in the *Amazon EC2 User Guide*. Note: The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_instances_listings( ReservedInstancesId='string', ReservedInstancesListingId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **ReservedInstancesId** (*string*) -- One or more Reserved Instance IDs. * **ReservedInstancesListingId** (*string*) -- One or more Reserved Instance listing IDs. * **Filters** (*list*) -- 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ReservedInstancesListings': [ { 'ClientToken': 'string', 'CreateDate': datetime(2015, 1, 1), 'InstanceCounts': [ { 'InstanceCount': 123, 'State': 'available'|'sold'|'cancelled'|'pending' }, ], 'PriceSchedules': [ { 'Active': True|False, 'CurrencyCode': 'USD', 'Price': 123.0, 'Term': 123 }, ], 'ReservedInstancesId': 'string', 'ReservedInstancesListingId': 'string', 'Status': 'active'|'pending'|'cancelled'|'closed', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'UpdateDate': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeReservedInstancesListings. * **ReservedInstancesListings** *(list) --* Information about the Reserved Instance listing. * *(dict) --* Describes a Reserved Instance listing. * **ClientToken** *(string) --* A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency. * **CreateDate** *(datetime) --* The time the listing was created. * **InstanceCounts** *(list) --* The number of instances in this state. * *(dict) --* Describes a Reserved Instance listing state. * **InstanceCount** *(integer) --* The number of listed Reserved Instances in the state specified by the "state". * **State** *(string) --* The states of the listed Reserved Instances. * **PriceSchedules** *(list) --* The price of the Reserved Instance listing. * *(dict) --* Describes the price for a Reserved Instance. * **Active** *(boolean) --* The current price schedule, as determined by the term remaining for the Reserved Instance in the listing. A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1. * **CurrencyCode** *(string) --* The currency for transacting the Reserved Instance resale. At this time, the only supported currency is "USD". * **Price** *(float) --* The fixed price for the term. * **Term** *(integer) --* The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires. * **ReservedInstancesId** *(string) --* The ID of the Reserved Instance. * **ReservedInstancesListingId** *(string) --* The ID of the Reserved Instance listing. * **Status** *(string) --* The status of the Reserved Instance listing. * **StatusMessage** *(string) --* The reason for the current status of the Reserved Instance listing. The response can be blank. * **Tags** *(list) --* Any tags assigned to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **UpdateDate** *(datetime) --* The last modified timestamp of the listing. EC2 / Client / modify_route_server modify_route_server ******************* EC2.Client.modify_route_server(**kwargs) Modifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: * VPC route tables not associated with subnets * Subnet route tables * Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.modify_route_server( RouteServerId='string', PersistRoutes='enable'|'disable'|'reset', PersistRoutesDuration=123, SnsNotificationsEnabled=True|False, DryRun=True|False ) Parameters: * **RouteServerId** (*string*) -- **[REQUIRED]** The ID of the route server to modify. * **PersistRoutes** (*string*) -- Specifies whether to persist routes after all BGP sessions are terminated. * enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated. * disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated. * reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB. * **PersistRoutesDuration** (*integer*) -- The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is "enabled". If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes. * **SnsNotificationsEnabled** (*boolean*) -- Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services. * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RouteServer': { 'RouteServerId': 'string', 'AmazonSideAsn': 123, 'State': 'pending'|'available'|'modifying'|'deleting'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PersistRoutesState': 'enabling'|'enabled'|'resetting'|'disabling'|'disabled'|'modifying', 'PersistRoutesDuration': 123, 'SnsNotificationsEnabled': True|False, 'SnsTopicArn': 'string' } } **Response Structure** * *(dict) --* * **RouteServer** *(dict) --* Information about the modified route server. * **RouteServerId** *(string) --* The unique identifier of the route server. * **AmazonSideAsn** *(integer) --* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * **State** *(string) --* The current state of the route server. * **Tags** *(list) --* Any tags assigned to the route server. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PersistRoutesState** *(string) --* The current state of route persistence for the route server. * **PersistRoutesDuration** *(integer) --* The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. The default value is 1. Only valid if "persistRoutesState" is 'enabled'. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re- establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes. * **SnsNotificationsEnabled** *(boolean) --* Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services. * **SnsTopicArn** *(string) --* The ARN of the SNS topic where notifications are published. EC2 / Client / attach_internet_gateway attach_internet_gateway *********************** EC2.Client.attach_internet_gateway(**kwargs) Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.attach_internet_gateway( DryRun=True|False, InternetGatewayId='string', VpcId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the internet gateway. * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC. Returns: None **Examples** This example attaches the specified Internet gateway to the specified VPC. response = client.attach_internet_gateway( InternetGatewayId='igw-c0a643a9', VpcId='vpc-a01106c2', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_network_interface_attribute modify_network_interface_attribute ********************************** EC2.Client.modify_network_interface_attribute(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_network_interface_attribute( EnaSrdSpecification={ 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, EnablePrimaryIpv6=True|False, ConnectionTrackingSpecification={ 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, AssociatePublicIpAddress=True|False, AssociatedSubnetIds=[ 'string', ], DryRun=True|False, NetworkInterfaceId='string', Description={ 'Value': 'string' }, SourceDestCheck={ 'Value': True|False }, Groups=[ 'string', ], Attachment={ 'DefaultEnaQueueCount': True|False, 'EnaQueueCount': 123, 'AttachmentId': 'string', 'DeleteOnTermination': True|False } ) Parameters: * **EnaSrdSpecification** (*dict*) -- Updates the ENA Express configuration for the network interface that’s attached to the instance. * **EnaSrdEnabled** *(boolean) --* Indicates whether ENA Express is enabled for the network interface. * **EnaSrdUdpSpecification** *(dict) --* Configures ENA Express for UDP network traffic. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express. * **EnablePrimaryIpv6** (*boolean*) -- If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address. * **ConnectionTrackingSpecification** (*dict*) -- A connection tracking specification. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request- response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **AssociatePublicIpAddress** (*boolean*) -- Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0). * **AssociatedSubnetIds** (*list*) -- A list of subnet IDs to associate with the network interface. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the network interface. * **Description** (*dict*) -- A description for the network interface. * **Value** *(string) --* The attribute value. The value is case-sensitive. * **SourceDestCheck** (*dict*) -- 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. * **Value** *(boolean) --* The attribute value. The valid values are "true" or "false". * **Groups** (*list*) -- 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. * *(string) --* * **Attachment** (*dict*) -- Information about the interface attachment. If modifying the "delete on termination" attribute, you must specify the ID of the interface attachment. * **DefaultEnaQueueCount** *(boolean) --* The default number of the ENA queues. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **AttachmentId** *(string) --* The ID of the network interface attachment. * **DeleteOnTermination** *(boolean) --* Indicates whether the network interface is deleted when the instance is terminated. Returns: None **Examples** This example modifies the attachment attribute of the specified network interface. response = client.modify_network_interface_attribute( Attachment={ 'AttachmentId': 'eni-attach-43348162', 'DeleteOnTermination': False, }, NetworkInterfaceId='eni-686ea200', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example modifies the description attribute of the specified network interface. response = client.modify_network_interface_attribute( Description={ 'Value': 'My description', }, NetworkInterfaceId='eni-686ea200', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example command modifies the groupSet attribute of the specified network interface. response = client.modify_network_interface_attribute( Groups=[ 'sg-903004f8', 'sg-1a2b3c4d', ], NetworkInterfaceId='eni-686ea200', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example command modifies the sourceDestCheck attribute of the specified network interface. response = client.modify_network_interface_attribute( NetworkInterfaceId='eni-686ea200', SourceDestCheck={ 'Value': False, }, ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_capacity_reservations describe_capacity_reservations ****************************** EC2.Client.describe_capacity_reservations(**kwargs) Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. See also: AWS API Documentation **Request Syntax** response = client.describe_capacity_reservations( CapacityReservationIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **CapacityReservationIds** (*list*) -- The ID of the Capacity Reservation. * *(string) --* * **NextToken** (*string*) -- The token to use to retrieve the next page of results. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **Filters** (*list*) -- One or more filters. * "instance-type" - The type of instance for which the Capacity Reservation reserves capacity. * "owner-id" - The ID of the Amazon Web Services account that owns the Capacity Reservation. * "instance-platform" - The type of operating system for which the Capacity Reservation reserves capacity. * "availability-zone" - The Availability Zone 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services 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. * "placement-group-arn" - The ARN of the cluster placement group in which the Capacity Reservation was created. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'CapacityReservations': [ { 'CapacityReservationId': 'string', 'OwnerId': 'string', 'CapacityReservationArn': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'string', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'TotalInstanceCount': 123, 'AvailableInstanceCount': 123, 'EbsOptimized': True|False, 'EphemeralStorage': True|False, 'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'unavailable', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'EndDateType': 'unlimited'|'limited', 'InstanceMatchCriteria': 'open'|'targeted', 'CreateDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OutpostArn': 'string', 'CapacityReservationFleetId': 'string', 'PlacementGroupArn': 'string', 'CapacityAllocations': [ { 'AllocationType': 'used'|'future', 'Count': 123 }, ], 'ReservationType': 'default'|'capacity-block', 'UnusedReservationBillingOwnerId': 'string', 'CommitmentInfo': { 'CommittedInstanceCount': 123, 'CommitmentEndDate': datetime(2015, 1, 1) }, 'DeliveryPreference': 'fixed'|'incremental', 'CapacityBlockId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. * **CapacityReservations** *(list) --* Information about the Capacity Reservations. * *(dict) --* Describes a Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the Capacity Reservation. * **CapacityReservationArn** *(string) --* The Amazon Resource Name (ARN) of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Reservation. * **InstanceType** *(string) --* The type of instance for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the capacity is reserved. * **Tenancy** *(string) --* 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **AvailableInstanceCount** *(integer) --* The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. * **EbsOptimized** *(boolean) --* 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. * **EphemeralStorage** *(boolean) --* *Deprecated.* * **State** *(string) --* The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: * "active" - The capacity is available for use. * "expired" - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. * "cancelled" - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. * "scheduled" - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. * "payment-pending" - (*Capacity Blocks*) The upfront payment has not been processed yet. * "payment-failed" - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. * "assessing" - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future- dated Capacity Reservation. * "delayed" - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. * "unsupported" - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. * **StartDate** *(datetime) --* The date and time at which the Capacity Reservation was started. * **EndDate** *(datetime) --* 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. * **EndDateType** *(string) --* 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. * **InstanceMatchCriteria** *(string) --* 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. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Tags** *(list) --* Any tags assigned to the Capacity Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. * **PlacementGroupArn** *(string) --* The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the *Amazon EC2 User Guide*. * **CapacityAllocations** *(list) --* Information about instance capacity usage. * *(dict) --* Information about instance capacity usage for a Capacity Reservation. * **AllocationType** *(string) --* The usage type. "used" indicates that the instance capacity is in use by instances that are running in the Capacity Reservation. * **Count** *(integer) --* The amount of instance capacity associated with the usage. For example a value of "4" indicates that instance capacity for 4 instances is currently in use. * **ReservationType** *(string) --* The type of Capacity Reservation. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned. * **CommitmentInfo** *(dict) --* Information about your commitment for a future-dated Capacity Reservation. * **CommittedInstanceCount** *(integer) --* The instance capacity that you committed to when you requested the future-dated Capacity Reservation. * **CommitmentEndDate** *(datetime) --* The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). You can't decrease the instance count or cancel the Capacity Reservation before this date and time. * **DeliveryPreference** *(string) --* The delivery method for a future-dated Capacity Reservation. "incremental" indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. EC2 / Client / associate_capacity_reservation_billing_owner associate_capacity_reservation_billing_owner ******************************************** EC2.Client.associate_capacity_reservation_billing_owner(**kwargs) Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations. See also: AWS API Documentation **Request Syntax** response = client.associate_capacity_reservation_billing_owner( DryRun=True|False, CapacityReservationId='string', UnusedReservationBillingOwnerId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity Reservation. * **UnusedReservationBillingOwnerId** (*string*) -- **[REQUIRED]** The ID of the consumer account to which to assign billing. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / delete_verified_access_group delete_verified_access_group **************************** EC2.Client.delete_verified_access_group(**kwargs) Delete an Amazon Web Services Verified Access group. See also: AWS API Documentation **Request Syntax** response = client.delete_verified_access_group( VerifiedAccessGroupId='string', ClientToken='string', DryRun=True|False ) Parameters: * **VerifiedAccessGroupId** (*string*) -- **[REQUIRED]** The ID of the Verified Access group. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VerifiedAccessGroup': { 'VerifiedAccessGroupId': 'string', 'VerifiedAccessInstanceId': 'string', 'Description': 'string', 'Owner': 'string', 'VerifiedAccessGroupArn': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'DeletionTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' } } } **Response Structure** * *(dict) --* * **VerifiedAccessGroup** *(dict) --* Details about the Verified Access group. * **VerifiedAccessGroupId** *(string) --* The ID of the Verified Access group. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **Description** *(string) --* A description for the Amazon Web Services Verified Access group. * **Owner** *(string) --* The Amazon Web Services account number that owns the group. * **VerifiedAccessGroupArn** *(string) --* The ARN of the Verified Access group. * **CreationTime** *(string) --* The creation time. * **LastUpdatedTime** *(string) --* The last updated time. * **DeletionTime** *(string) --* The deletion time. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SseSpecification** *(dict) --* The options in use for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. EC2 / Client / replace_route replace_route ************* EC2.Client.replace_route(**kwargs) Replaces an existing route within a route table in a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target. For more information, see Route tables in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.replace_route( DestinationPrefixListId='string', VpcEndpointId='string', LocalTarget=True|False, TransitGatewayId='string', LocalGatewayId='string', CarrierGatewayId='string', CoreNetworkArn='string', OdbNetworkArn='string', DryRun=True|False, RouteTableId='string', DestinationCidrBlock='string', GatewayId='string', DestinationIpv6CidrBlock='string', EgressOnlyInternetGatewayId='string', InstanceId='string', NetworkInterfaceId='string', VpcPeeringConnectionId='string', NatGatewayId='string' ) Parameters: * **DestinationPrefixListId** (*string*) -- The ID of the prefix list for the route. * **VpcEndpointId** (*string*) -- The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. * **LocalTarget** (*boolean*) -- Specifies whether to reset the local route to its default target ( "local"). * **TransitGatewayId** (*string*) -- The ID of a transit gateway. * **LocalGatewayId** (*string*) -- The ID of the local gateway. * **CarrierGatewayId** (*string*) -- [IPv4 traffic only] The ID of a carrier gateway. * **CoreNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the core network. * **OdbNetworkArn** (*string*) -- The Amazon Resource Name (ARN) of the ODB network. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table. * **DestinationCidrBlock** (*string*) -- 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. * **GatewayId** (*string*) -- The ID of an internet gateway or virtual private gateway. * **DestinationIpv6CidrBlock** (*string*) -- 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. * **EgressOnlyInternetGatewayId** (*string*) -- [IPv6 traffic only] The ID of an egress-only internet gateway. * **InstanceId** (*string*) -- The ID of a NAT instance in your VPC. * **NetworkInterfaceId** (*string*) -- The ID of a network interface. * **VpcPeeringConnectionId** (*string*) -- The ID of a VPC peering connection. * **NatGatewayId** (*string*) -- [IPv4 traffic only] The ID of a NAT gateway. Returns: None **Examples** This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway. response = client.replace_route( DestinationCidrBlock='10.0.0.0/16', GatewayId='vgw-9a4cacf3', RouteTableId='rtb-22574640', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / create_key_pair create_key_pair *************** EC2.Client.create_key_pair(**kwargs) Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error. The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair. You can have up to 5,000 key pairs per Amazon Web Services Region. For more information, see Amazon EC2 key pairs in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_key_pair( KeyName='string', KeyType='rsa'|'ed25519', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], KeyFormat='pem'|'ppk', DryRun=True|False ) Parameters: * **KeyName** (*string*) -- **[REQUIRED]** A unique name for the key pair. Constraints: Up to 255 ASCII characters * **KeyType** (*string*) -- The type of key pair. Note that ED25519 keys are not supported for Windows instances. Default: "rsa" * **TagSpecifications** (*list*) -- The tags to apply to the new key pair. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **KeyFormat** (*string*) -- The format of the key pair. Default: "pem" * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'KeyPairId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'KeyName': 'string', 'KeyFingerprint': 'string', 'KeyMaterial': 'string' } **Response Structure** * *(dict) --* Describes a key pair. * **KeyPairId** *(string) --* The ID of the key pair. * **Tags** *(list) --* Any tags applied to the key pair. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **KeyName** *(string) --* The name of the key pair. * **KeyFingerprint** *(string) --* * For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. * For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. * **KeyMaterial** *(string) --* An unencrypted PEM encoded RSA or ED25519 private key. **Examples** This example creates a key pair named my-key-pair. response = client.create_key_pair( KeyName='my-key-pair', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / get_transit_gateway_policy_table_entries get_transit_gateway_policy_table_entries **************************************** EC2.Client.get_transit_gateway_policy_table_entries(**kwargs) Returns a list of transit gateway policy table entries. See also: AWS API Documentation **Request Syntax** response = client.get_transit_gateway_policy_table_entries( TransitGatewayPolicyTableId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **TransitGatewayPolicyTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway policy table. * **Filters** (*list*) -- The filters associated with the transit gateway policy table. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPolicyTableEntries': [ { 'PolicyRuleNumber': 'string', 'PolicyRule': { 'SourceCidrBlock': 'string', 'SourcePortRange': 'string', 'DestinationCidrBlock': 'string', 'DestinationPortRange': 'string', 'Protocol': 'string', 'MetaData': { 'MetaDataKey': 'string', 'MetaDataValue': 'string' } }, 'TargetRouteTableId': 'string' }, ] } **Response Structure** * *(dict) --* * **TransitGatewayPolicyTableEntries** *(list) --* The entries for the transit gateway policy table. * *(dict) --* Describes a transit gateway policy table entry * **PolicyRuleNumber** *(string) --* The rule number for the transit gateway policy table entry. * **PolicyRule** *(dict) --* The policy rule associated with the transit gateway policy table. * **SourceCidrBlock** *(string) --* The source CIDR block for the transit gateway policy rule. * **SourcePortRange** *(string) --* The port range for the transit gateway policy rule. Currently this is set to * (all). * **DestinationCidrBlock** *(string) --* The destination CIDR block for the transit gateway policy rule. * **DestinationPortRange** *(string) --* The port range for the transit gateway policy rule. Currently this is set to * (all). * **Protocol** *(string) --* The protocol used by the transit gateway policy rule. * **MetaData** *(dict) --* The meta data tags used for the transit gateway policy rule. * **MetaDataKey** *(string) --* The key name for the transit gateway policy rule meta data tag. * **MetaDataValue** *(string) --* The value of the key for the transit gateway policy rule meta data tag. * **TargetRouteTableId** *(string) --* The ID of the target route table. EC2 / Client / get_instance_tpm_ek_pub get_instance_tpm_ek_pub *********************** EC2.Client.get_instance_tpm_ek_pub(**kwargs) Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance. See also: AWS API Documentation **Request Syntax** response = client.get_instance_tpm_ek_pub( InstanceId='string', KeyType='rsa-2048'|'ecc-sec-p384', KeyFormat='der'|'tpmt', DryRun=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance for which to get the public endorsement key. * **KeyType** (*string*) -- **[REQUIRED]** The required public endorsement key type. * **KeyFormat** (*string*) -- **[REQUIRED]** The required public endorsement key format. Specify "der" for a DER-encoded public key that is compatible with OpenSSL. Specify "tpmt" for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded. * **DryRun** (*boolean*) -- Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is "DryRunOperation". Otherwise, the response is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'KeyType': 'rsa-2048'|'ecc-sec-p384', 'KeyFormat': 'der'|'tpmt', 'KeyValue': 'string' } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The ID of the instance. * **KeyType** *(string) --* The public endorsement key type. * **KeyFormat** *(string) --* The public endorsement key format. * **KeyValue** *(string) --* The public endorsement key material. EC2 / Client / create_mac_system_integrity_protection_modification_task create_mac_system_integrity_protection_modification_task ******************************************************** EC2.Client.create_mac_system_integrity_protection_modification_task(**kwargs) Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the *Amazon EC2 User Guide*. When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings. Note: If you implement a custom configuration, connect to the instance and verify the settings to ensure that your requirements are properly implemented and functioning as intended.SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations. To enable or disable all SIP settings, use the **MacSystemIntegrityProtectionStatus** parameter only. For example, to enable all SIP settings, specify the following: * "MacSystemIntegrityProtectionStatus=enabled" To specify a custom configuration that selectively enables or disables specific SIP settings, use the **MacSystemIntegrityProtectionStatus** parameter to enable or disable all SIP settings, and then use the **MacSystemIntegrityProtectionConfiguration** parameter to specify exceptions. In this case, the exceptions you specify for **MacSystemIntegrityProtectionConfiguration** override the value you specify for **MacSystemIntegrityProtectionStatus**. For example, to enable all SIP settings, except "NvramProtections", specify the following: * "MacSystemIntegrityProtectionStatus=enabled" * "MacSystemIntegrityProtectionConfigurationRequest "NvramProtections=disabled"" See also: AWS API Documentation **Request Syntax** response = client.create_mac_system_integrity_protection_modification_task( ClientToken='string', DryRun=True|False, InstanceId='string', MacCredentials='string', MacSystemIntegrityProtectionConfiguration={ 'AppleInternal': 'enabled'|'disabled', 'BaseSystem': 'enabled'|'disabled', 'DebuggingRestrictions': 'enabled'|'disabled', 'DTraceRestrictions': 'enabled'|'disabled', 'FilesystemProtections': 'enabled'|'disabled', 'KextSigning': 'enabled'|'disabled', 'NvramProtections': 'enabled'|'disabled' }, MacSystemIntegrityProtectionStatus='enabled'|'disabled', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the Amazon EC2 Mac instance. * **MacCredentials** (*string*) -- **[Apple silicon Mac instances only]** Specifies the following credentials: * **Internal disk administrative user** * **Username** - Only the default administrative user ( "aws-managed-user") is supported and it is used by default. You can't specify a different administrative user. * **Password** - If you did not change the default password for "aws-managed-user", specify the default password, which is *blank*. Otherwise, specify your password. * **Amazon EBS root volume administrative user** * **Username** - If you did not change the default administrative user, specify "ec2-user". Otherwise, specify the username for your administrative user. * **Password** - Specify the password for the administrative user. The credentials must be specified in the following JSON format: "{ "internalDiskPassword":"internal-disk-admin_password", "rootVolumeUsername":"root-volume-admin_username", "rootVolumepassword":"root-volume-admin_password" }" * **MacSystemIntegrityProtectionConfiguration** (*dict*) -- Specifies the overrides to selectively enable or disable individual SIP settings. The individual settings you specify here override the overall SIP status you specify for **MacSystemIntegrityProtectionStatus**. * **AppleInternal** *(string) --* Enables or disables Apple Internal. * **BaseSystem** *(string) --* Enables or disables Base System. * **DebuggingRestrictions** *(string) --* Enables or disables Debugging Restrictions. * **DTraceRestrictions** *(string) --* Enables or disables Dtrace Restrictions. * **FilesystemProtections** *(string) --* Enables or disables Filesystem Protections. * **KextSigning** *(string) --* Enables or disables Kext Signing. * **NvramProtections** *(string) --* Enables or disables Nvram Protections. * **MacSystemIntegrityProtectionStatus** (*string*) -- **[REQUIRED]** Specifies the overall SIP status for the instance. To enable all SIP settings, specify "enabled". To disable all SIP settings, specify "disabled". * **TagSpecifications** (*list*) -- Specifies tags to apply to the SIP modification task. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'MacModificationTask': { 'InstanceId': 'string', 'MacModificationTaskId': 'string', 'MacSystemIntegrityProtectionConfig': { 'AppleInternal': 'enabled'|'disabled', 'BaseSystem': 'enabled'|'disabled', 'DebuggingRestrictions': 'enabled'|'disabled', 'DTraceRestrictions': 'enabled'|'disabled', 'FilesystemProtections': 'enabled'|'disabled', 'KextSigning': 'enabled'|'disabled', 'NvramProtections': 'enabled'|'disabled', 'Status': 'enabled'|'disabled' }, 'StartTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'TaskState': 'successful'|'failed'|'in-progress'|'pending', 'TaskType': 'sip-modification'|'volume-ownership-delegation' } } **Response Structure** * *(dict) --* * **MacModificationTask** *(dict) --* Information about the SIP modification task. * **InstanceId** *(string) --* The ID of the Amazon EC2 Mac instance. * **MacModificationTaskId** *(string) --* The ID of task. * **MacSystemIntegrityProtectionConfig** *(dict) --* [SIP modification tasks only] Information about the SIP configuration. * **AppleInternal** *(string) --* Indicates whether Apple Internal was enabled or disabled by the task. * **BaseSystem** *(string) --* Indicates whether Base System was enabled or disabled by the task. * **DebuggingRestrictions** *(string) --* Indicates whether Debugging Restrictions was enabled or disabled by the task. * **DTraceRestrictions** *(string) --* Indicates whether Dtrace Restrictions was enabled or disabled by the task. * **FilesystemProtections** *(string) --* Indicates whether Filesystem Protections was enabled or disabled by the task. * **KextSigning** *(string) --* Indicates whether Kext Signing was enabled or disabled by the task. * **NvramProtections** *(string) --* Indicates whether NVRAM Protections was enabled or disabled by the task. * **Status** *(string) --* Indicates SIP was enabled or disabled by the task. * **StartTime** *(datetime) --* The date and time the task was created, in the UTC timezone ( "YYYY-MM-DDThh:mm:ss.sssZ"). * **Tags** *(list) --* The tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **TaskState** *(string) --* The state of the task. * **TaskType** *(string) --* The type of task. EC2 / Client / create_ipam_external_resource_verification_token create_ipam_external_resource_verification_token ************************************************ EC2.Client.create_ipam_external_resource_verification_token(**kwargs) Create a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). See also: AWS API Documentation **Request Syntax** response = client.create_ipam_external_resource_verification_token( DryRun=True|False, IpamId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], ClientToken='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamId** (*string*) -- **[REQUIRED]** The ID of the IPAM that will create the token. * **TagSpecifications** (*list*) -- Token tags. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'IpamExternalResourceVerificationToken': { 'IpamExternalResourceVerificationTokenId': 'string', 'IpamExternalResourceVerificationTokenArn': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'TokenValue': 'string', 'TokenName': 'string', 'NotAfter': datetime(2015, 1, 1), 'Status': 'valid'|'expired', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed' } } **Response Structure** * *(dict) --* * **IpamExternalResourceVerificationToken** *(dict) --* The verification token. * **IpamExternalResourceVerificationTokenId** *(string) --* The ID of the token. * **IpamExternalResourceVerificationTokenArn** *(string) --* Token ARN. * **IpamId** *(string) --* The ID of the IPAM that created the token. * **IpamArn** *(string) --* ARN of the IPAM that created the token. * **IpamRegion** *(string) --* Region of the IPAM that created the token. * **TokenValue** *(string) --* Token value. * **TokenName** *(string) --* Token name. * **NotAfter** *(datetime) --* Token expiration. * **Status** *(string) --* Token status. * **Tags** *(list) --* Token tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **State** *(string) --* Token state. EC2 / Client / delete_instance_event_window delete_instance_event_window **************************** EC2.Client.delete_instance_event_window(**kwargs) Deletes the specified event window. For more information, see Define event windows for scheduled events in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_instance_event_window( DryRun=True|False, ForceDelete=True|False, InstanceEventWindowId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ForceDelete** (*boolean*) -- Specify "true" to force delete the event window. Use the force delete parameter if the event window is currently associated with targets. * **InstanceEventWindowId** (*string*) -- **[REQUIRED]** The ID of the event window. Return type: dict Returns: **Response Syntax** { 'InstanceEventWindowState': { 'InstanceEventWindowId': 'string', 'State': 'creating'|'deleting'|'active'|'deleted' } } **Response Structure** * *(dict) --* * **InstanceEventWindowState** *(dict) --* The state of the event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **State** *(string) --* The current state of the event window. EC2 / Client / restore_snapshot_tier restore_snapshot_tier ********************* EC2.Client.restore_snapshot_tier(**kwargs) Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored. For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.restore_snapshot_tier( SnapshotId='string', TemporaryRestoreDays=123, PermanentRestore=True|False, DryRun=True|False ) Parameters: * **SnapshotId** (*string*) -- **[REQUIRED]** The ID of the snapshot to restore. * **TemporaryRestoreDays** (*integer*) -- Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period. To temporarily restore an archived snapshot, specify the number of days and omit the **PermanentRestore** parameter or set it to "false". * **PermanentRestore** (*boolean*) -- Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify "true" and omit the **RestoreSnapshotTierRequest$TemporaryRestoreDays** parameter. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SnapshotId': 'string', 'RestoreStartTime': datetime(2015, 1, 1), 'RestoreDuration': 123, 'IsPermanentRestore': True|False } **Response Structure** * *(dict) --* * **SnapshotId** *(string) --* The ID of the snapshot. * **RestoreStartTime** *(datetime) --* The date and time when the snapshot restore process started. * **RestoreDuration** *(integer) --* For temporary restores only. The number of days for which the archived snapshot is temporarily restored. * **IsPermanentRestore** *(boolean) --* Indicates whether the snapshot is permanently restored. "true" indicates a permanent restore. "false" indicates a temporary restore. EC2 / Client / reject_vpc_peering_connection reject_vpc_peering_connection ***************************** EC2.Client.reject_vpc_peering_connection(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.reject_vpc_peering_connection( DryRun=True|False, VpcPeeringConnectionId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the VPC peering connection. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / describe_network_acls describe_network_acls ********************* EC2.Client.describe_network_acls(**kwargs) Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria. For more information, see Network ACLs in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_network_acls( NextToken='string', MaxResults=123, DryRun=True|False, NetworkAclIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **NetworkAclIds** (*list*) -- The IDs of the network ACLs. * *(string) --* * **Filters** (*list*) -- The 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 in the entry, if any. * "entry.icmp.type" - The ICMP type specified in the entry, if any. * "entry.ipv6-cidr" - The IPv6 CIDR range specified in the entry. * "entry.port-range.from" - The start of the port range specified in the entry. * "entry.port-range.to" - The end of the port range specified in the entry. * "entry.protocol" - The protocol specified in the entry ( "tcp" | "udp" | "icmp" or a protocol number). * "entry.rule-action" - Allows or denies the matching traffic ( "allow" | "deny"). * "entry.egress" - A Boolean that indicates the type of rule. Specify "true" for egress rules, or "false" for ingress rules. * "entry.rule-number" - The number of an entry (in other words, rule) in the set of ACL entries. * "network-acl-id" - The ID of the network ACL. * "owner-id" - The ID of the Amazon Web Services account that owns the network ACL. * "tag" - 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 ACL. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NetworkAcls': [ { 'Associations': [ { 'NetworkAclAssociationId': 'string', 'NetworkAclId': 'string', 'SubnetId': 'string' }, ], 'Entries': [ { 'CidrBlock': 'string', 'Egress': True|False, 'IcmpTypeCode': { 'Code': 123, 'Type': 123 }, 'Ipv6CidrBlock': 'string', 'PortRange': { 'From': 123, 'To': 123 }, 'Protocol': 'string', 'RuleAction': 'allow'|'deny', 'RuleNumber': 123 }, ], 'IsDefault': True|False, 'NetworkAclId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'OwnerId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NetworkAcls** *(list) --* Information about the network ACLs. * *(dict) --* Describes a network ACL. * **Associations** *(list) --* Any associations between the network ACL and your subnets * *(dict) --* Describes an association between a network ACL and a subnet. * **NetworkAclAssociationId** *(string) --* The ID of the association between a network ACL and a subnet. * **NetworkAclId** *(string) --* The ID of the network ACL. * **SubnetId** *(string) --* The ID of the subnet. * **Entries** *(list) --* The entries (rules) in the network ACL. * *(dict) --* Describes an entry in a network ACL. * **CidrBlock** *(string) --* The IPv4 network range to allow or deny, in CIDR notation. * **Egress** *(boolean) --* Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). * **IcmpTypeCode** *(dict) --* ICMP protocol: The ICMP type and code. * **Code** *(integer) --* The ICMP code. A value of -1 means all codes for the specified ICMP type. * **Type** *(integer) --* The ICMP type. A value of -1 means all types. * **Ipv6CidrBlock** *(string) --* The IPv6 network range to allow or deny, in CIDR notation. * **PortRange** *(dict) --* TCP or UDP protocols: The range of ports the rule applies to. * **From** *(integer) --* The first port in the range. * **To** *(integer) --* The last port in the range. * **Protocol** *(string) --* The protocol number. A value of "-1" means all protocols. * **RuleAction** *(string) --* Indicates whether to allow or deny the traffic that matches the rule. * **RuleNumber** *(integer) --* The rule number for the entry. ACL entries are processed in ascending order by rule number. * **IsDefault** *(boolean) --* Indicates whether this is the default network ACL for the VPC. * **NetworkAclId** *(string) --* The ID of the network ACL. * **Tags** *(list) --* Any tags assigned to the network ACL. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC for the network ACL. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the network ACL. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. **Examples** This example describes the specified network ACL. response = client.describe_network_acls( NetworkAclIds=[ 'acl-5fb85d36', ], ) print(response) Expected Output: { 'NetworkAcls': [ { 'Associations': [ { 'NetworkAclAssociationId': 'aclassoc-66ea5f0b', 'NetworkAclId': 'acl-9aeb5ef7', 'SubnetId': 'subnet-65ea5f08', }, ], 'Entries': [ { 'CidrBlock': '0.0.0.0/0', 'Egress': True, 'Protocol': '-1', 'RuleAction': 'deny', 'RuleNumber': 32767, }, { 'CidrBlock': '0.0.0.0/0', 'Egress': False, 'Protocol': '-1', 'RuleAction': 'deny', 'RuleNumber': 32767, }, ], 'IsDefault': False, 'NetworkAclId': 'acl-5fb85d36', 'Tags': [ ], 'VpcId': 'vpc-a01106c2', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / enable_snapshot_block_public_access enable_snapshot_block_public_access *********************************** EC2.Client.enable_snapshot_block_public_access(**kwargs) Enables or modifies the *block public access for snapshots* setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the **State** that you specify. Warning: Enabling block public access for snapshots in *block all sharing* mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available.If you later disable block public access or change the mode to *block new sharing*, these snapshots will become publicly available again. For more information, see Block public access for snapshots in the *Amazon EBS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.enable_snapshot_block_public_access( State='block-all-sharing'|'block-new-sharing'|'unblocked', DryRun=True|False ) Parameters: * **State** (*string*) -- **[REQUIRED]** The mode in which to enable block public access for snapshots for the Region. Specify one of the following values: * "block-all-sharing" - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available. * "block-new-sharing" - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available. "unblocked" is not a valid value for **EnableSnapshotBlockPublicAccess**. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'State': 'block-all-sharing'|'block-new-sharing'|'unblocked' } **Response Structure** * *(dict) --* * **State** *(string) --* The state of block public access for snapshots for the account and Region. Returns either "block-all-sharing" or "block-new-sharing" if the request succeeds. EC2 / Client / create_transit_gateway_route_table create_transit_gateway_route_table ********************************** EC2.Client.create_transit_gateway_route_table(**kwargs) Creates a route table for the specified transit gateway. See also: AWS API Documentation **Request Syntax** response = client.create_transit_gateway_route_table( TransitGatewayId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **TransitGatewayId** (*string*) -- **[REQUIRED]** The ID of the transit gateway. * **TagSpecifications** (*list*) -- The tags to apply to the transit gateway route table. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayRouteTable': { 'TransitGatewayRouteTableId': 'string', 'TransitGatewayId': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'DefaultAssociationRouteTable': True|False, 'DefaultPropagationRouteTable': True|False, 'CreationTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TransitGatewayRouteTable** *(dict) --* Information about the transit gateway route table. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **TransitGatewayId** *(string) --* The ID of the transit gateway. * **State** *(string) --* The state of the transit gateway route table. * **DefaultAssociationRouteTable** *(boolean) --* Indicates whether this is the default association route table for the transit gateway. * **DefaultPropagationRouteTable** *(boolean) --* Indicates whether this is the default propagation route table for the transit gateway. * **CreationTime** *(datetime) --* The creation time. * **Tags** *(list) --* Any tags assigned to the route table. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_addresses describe_addresses ****************** EC2.Client.describe_addresses(**kwargs) Describes the specified Elastic IP addresses or all of your Elastic IP addresses. See also: AWS API Documentation **Request Syntax** response = client.describe_addresses( PublicIps=[ 'string', ], DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], AllocationIds=[ 'string', ] ) Parameters: * **PublicIps** (*list*) -- One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. Filter names and values are case- sensitive. * "allocation-id" - The allocation ID for the address. * "association-id" - The association ID for the address. * "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 Amazon Web Services advertises IP addresses. * "network-interface-id" - The ID of the network interface that the address is associated with, if any. * "network-interface-owner-id" - The Amazon Web Services account ID of the owner. * "private-ip-address" - The private IP address associated with the Elastic IP address. * "public-ip" - The Elastic IP address, or the carrier IP address. * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **AllocationIds** (*list*) -- Information about the allocation IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'Addresses': [ { 'AllocationId': 'string', 'AssociationId': 'string', 'Domain': 'vpc'|'standard', 'NetworkInterfaceId': 'string', 'NetworkInterfaceOwnerId': 'string', 'PrivateIpAddress': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PublicIpv4Pool': 'string', 'NetworkBorderGroup': 'string', 'CustomerOwnedIp': 'string', 'CustomerOwnedIpv4Pool': 'string', 'CarrierIp': 'string', 'SubnetId': 'string', 'ServiceManaged': 'alb'|'nlb'|'rnat', 'InstanceId': 'string', 'PublicIp': 'string' }, ] } **Response Structure** * *(dict) --* * **Addresses** *(list) --* Information about the Elastic IP addresses. * *(dict) --* Describes an Elastic IP address, or a carrier IP address. * **AllocationId** *(string) --* The ID representing the allocation of the address. * **AssociationId** *(string) --* The ID representing the association of the address with an instance. * **Domain** *(string) --* The network ( "vpc"). * **NetworkInterfaceId** *(string) --* The ID of the network interface. * **NetworkInterfaceOwnerId** *(string) --* The ID of the Amazon Web Services account that owns the network interface. * **PrivateIpAddress** *(string) --* The private IP address associated with the Elastic IP address. * **Tags** *(list) --* Any tags assigned to the Elastic IP address. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **PublicIpv4Pool** *(string) --* The ID of an address pool. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. * **CustomerOwnedIp** *(string) --* The customer-owned IP address. * **CustomerOwnedIpv4Pool** *(string) --* The ID of the customer-owned address pool. * **CarrierIp** *(string) --* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). * **SubnetId** *(string) --* The ID of the subnet where the IP address is allocated. * **ServiceManaged** *(string) --* The service that manages the elastic IP address. Note: The only option supported today is "alb". * **InstanceId** *(string) --* The ID of the instance that the address is associated with (if any). * **PublicIp** *(string) --* The Elastic IP address. **Examples** This example describes your Elastic IP addresses. response = client.describe_addresses( ) print(response) Expected Output: { 'Addresses': [ { 'Domain': 'standard', 'InstanceId': 'i-1234567890abcdef0', 'PublicIp': '198.51.100.0', }, { 'AllocationId': 'eipalloc-12345678', 'AssociationId': 'eipassoc-12345678', 'Domain': 'vpc', 'InstanceId': 'i-1234567890abcdef0', 'NetworkInterfaceId': 'eni-12345678', 'NetworkInterfaceOwnerId': '123456789012', 'PrivateIpAddress': '10.0.1.241', 'PublicIp': '203.0.113.0', }, ], 'ResponseMetadata': { '...': '...', }, } This example describes your Elastic IP addresses for use with instances in a VPC. response = client.describe_addresses( Filters=[ { 'Name': 'domain', 'Values': [ 'vpc', ], }, ], ) print(response) Expected Output: { 'Addresses': [ { 'AllocationId': 'eipalloc-12345678', 'AssociationId': 'eipassoc-12345678', 'Domain': 'vpc', 'InstanceId': 'i-1234567890abcdef0', 'NetworkInterfaceId': 'eni-12345678', 'NetworkInterfaceOwnerId': '123456789012', 'PrivateIpAddress': '10.0.1.241', 'PublicIp': '203.0.113.0', }, ], 'ResponseMetadata': { '...': '...', }, } This example describes your Elastic IP addresses for use with instances in EC2-Classic. response = client.describe_addresses( Filters=[ { 'Name': 'domain', 'Values': [ 'standard', ], }, ], ) print(response) Expected Output: { 'Addresses': [ { 'Domain': 'standard', 'InstanceId': 'i-1234567890abcdef0', 'PublicIp': '198.51.100.0', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / modify_address_attribute modify_address_attribute ************************ EC2.Client.modify_address_attribute(**kwargs) Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications. See also: AWS API Documentation **Request Syntax** response = client.modify_address_attribute( AllocationId='string', DomainName='string', DryRun=True|False ) Parameters: * **AllocationId** (*string*) -- **[REQUIRED]** [EC2-VPC] The allocation ID. * **DomainName** (*string*) -- The domain name to modify for the IP address. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Address': { 'PublicIp': 'string', 'AllocationId': 'string', 'PtrRecord': 'string', 'PtrRecordUpdate': { 'Value': 'string', 'Status': 'string', 'Reason': 'string' } } } **Response Structure** * *(dict) --* * **Address** *(dict) --* Information about the Elastic IP address. * **PublicIp** *(string) --* The public IP address. * **AllocationId** *(string) --* [EC2-VPC] The allocation ID. * **PtrRecord** *(string) --* The pointer (PTR) record for the IP address. * **PtrRecordUpdate** *(dict) --* The updated PTR record for the IP address. * **Value** *(string) --* The value for the PTR record update. * **Status** *(string) --* The status of the PTR record update. * **Reason** *(string) --* The reason for the PTR record update. EC2 / Client / allocate_ipam_pool_cidr allocate_ipam_pool_cidr *********************** EC2.Client.allocate_ipam_pool_cidr(**kwargs) Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the *Amazon VPC IPAM User Guide*. Note: This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool. See also: AWS API Documentation **Request Syntax** response = client.allocate_ipam_pool_cidr( DryRun=True|False, IpamPoolId='string', Cidr='string', NetmaskLength=123, ClientToken='string', Description='string', PreviewNextCidr=True|False, AllowedCidrs=[ 'string', ], DisallowedCidrs=[ 'string', ] ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamPoolId** (*string*) -- **[REQUIRED]** The ID of the IPAM pool from which you would like to allocate a CIDR. * **Cidr** (*string*) -- The CIDR you would like to allocate from the IPAM pool. Note the following: * If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. * If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. Possible values: Any available IPv4 or IPv6 CIDR. * **NetmaskLength** (*integer*) -- The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following: * If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. * If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **Description** (*string*) -- A description for the allocation. * **PreviewNextCidr** (*boolean*) -- A preview of the next available CIDR in a pool. * **AllowedCidrs** (*list*) -- Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation. * *(string) --* * **DisallowedCidrs** (*list*) -- Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. * *(string) --* Return type: dict Returns: **Response Syntax** { 'IpamPoolAllocation': { 'Cidr': 'string', 'IpamPoolAllocationId': 'string', 'Description': 'string', 'ResourceId': 'string', 'ResourceType': 'ipam-pool'|'vpc'|'ec2-public-ipv4-pool'|'custom'|'subnet'|'eip', 'ResourceRegion': 'string', 'ResourceOwner': 'string' } } **Response Structure** * *(dict) --* * **IpamPoolAllocation** *(dict) --* Information about the allocation created. * **Cidr** *(string) --* The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is "10.24.34.0/23". An IPv6 CIDR example is "2001:DB8::/32". * **IpamPoolAllocationId** *(string) --* The ID of an allocation. * **Description** *(string) --* A description of the pool allocation. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The type of the resource. * **ResourceRegion** *(string) --* The Amazon Web Services Region of the resource. * **ResourceOwner** *(string) --* The owner of the resource. EC2 / Client / delete_tags delete_tags *********** EC2.Client.delete_tags(**kwargs) Deletes the specified set of tags from the specified set of resources. To list the current tags, use DescribeTags. For more information about tags, see Tag your Amazon EC2 resources in the *Amazon Elastic Compute Cloud User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_tags( DryRun=True|False, Resources=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Resources** (*list*) -- **[REQUIRED]** The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. * *(string) --* * **Tags** (*list*) -- 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 Amazon Web Services-generated tags (tags that have the "aws:" prefix). Constraints: Up to 1000 tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Returns: None **Examples** This example deletes the tag Stack=test from the specified image. response = client.delete_tags( Resources=[ 'ami-78a54011', ], Tags=[ { 'Key': 'Stack', 'Value': 'test', }, ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / move_byoip_cidr_to_ipam move_byoip_cidr_to_ipam *********************** EC2.Client.move_byoip_cidr_to_ipam(**kwargs) Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM. See also: AWS API Documentation **Request Syntax** response = client.move_byoip_cidr_to_ipam( DryRun=True|False, Cidr='string', IpamPoolId='string', IpamPoolOwner='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **Cidr** (*string*) -- **[REQUIRED]** The BYOIP CIDR. * **IpamPoolId** (*string*) -- **[REQUIRED]** The IPAM pool ID. * **IpamPoolOwner** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID of the owner of the IPAM pool. Return type: dict Returns: **Response Syntax** { 'ByoipCidr': { 'Cidr': 'string', 'Description': 'string', 'AsnAssociations': [ { 'Asn': 'string', 'Cidr': 'string', 'StatusMessage': 'string', 'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated' }, ], 'StatusMessage': 'string', 'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable', 'NetworkBorderGroup': 'string' } } **Response Structure** * *(dict) --* * **ByoipCidr** *(dict) --* The BYOIP CIDR. * **Cidr** *(string) --* The address range, in CIDR notation. * **Description** *(string) --* The description of the address range. * **AsnAssociations** *(list) --* The BYOIP CIDR associations with ASNs. * *(dict) --* An Autonomous System Number (ASN) and BYOIP CIDR association. * **Asn** *(string) --* The association's ASN. * **Cidr** *(string) --* The association's CIDR. * **StatusMessage** *(string) --* The association's status message. * **State** *(string) --* The association's state. * **StatusMessage** *(string) --* Upon success, contains the ID of the address pool. Otherwise, contains an error message. * **State** *(string) --* The state of the address range. * "advertised": The address range is being advertised to the internet by Amazon Web Services. * "deprovisioned": The address range is deprovisioned. * "failed-deprovision": The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again. * "failed-provision": The request to provision the address range was unsuccessful. * "pending-deprovision": You’ve submitted a request to deprovision an address range and it's pending. * "pending-provision": You’ve submitted a request to provision an address range and it's pending. * "provisioned": The address range is provisioned and can be advertised. The range is not currently advertised. * "provisioned-not-publicly-advertisable": The address range is provisioned and cannot be advertised. * **NetworkBorderGroup** *(string) --* If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group. You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups: * us-east-1-dfw-2 * us-west-2-lax-1 * us-west-2-phx-2 Note: You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time. EC2 / Client / close close ***** EC2.Client.close() Closes underlying endpoint connections. EC2 / Client / delete_ipam_external_resource_verification_token delete_ipam_external_resource_verification_token ************************************************ EC2.Client.delete_ipam_external_resource_verification_token(**kwargs) Delete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP). See also: AWS API Documentation **Request Syntax** response = client.delete_ipam_external_resource_verification_token( DryRun=True|False, IpamExternalResourceVerificationTokenId='string' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamExternalResourceVerificationTokenId** (*string*) -- **[REQUIRED]** The token ID. Return type: dict Returns: **Response Syntax** { 'IpamExternalResourceVerificationToken': { 'IpamExternalResourceVerificationTokenId': 'string', 'IpamExternalResourceVerificationTokenArn': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'TokenValue': 'string', 'TokenName': 'string', 'NotAfter': datetime(2015, 1, 1), 'Status': 'valid'|'expired', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed' } } **Response Structure** * *(dict) --* * **IpamExternalResourceVerificationToken** *(dict) --* The verification token. * **IpamExternalResourceVerificationTokenId** *(string) --* The ID of the token. * **IpamExternalResourceVerificationTokenArn** *(string) --* Token ARN. * **IpamId** *(string) --* The ID of the IPAM that created the token. * **IpamArn** *(string) --* ARN of the IPAM that created the token. * **IpamRegion** *(string) --* Region of the IPAM that created the token. * **TokenValue** *(string) --* Token value. * **TokenName** *(string) --* Token name. * **NotAfter** *(datetime) --* Token expiration. * **Status** *(string) --* Token status. * **Tags** *(list) --* Token tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **State** *(string) --* Token state. EC2 / Client / create_instance_export_task create_instance_export_task *************************** EC2.Client.create_instance_export_task(**kwargs) Exports a running or stopped instance to an Amazon S3 bucket. For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the *VM Import/Export User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_instance_export_task( TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], Description='string', InstanceId='string', TargetEnvironment='citrix'|'vmware'|'microsoft', ExportToS3Task={ 'DiskImageFormat': 'VMDK'|'RAW'|'VHD', 'ContainerFormat': 'ova', 'S3Bucket': 'string', 'S3Prefix': 'string' } ) Parameters: * **TagSpecifications** (*list*) -- The tags to apply to the export instance task during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Description** (*string*) -- A description for the conversion task or the resource being exported. The maximum length is 255 characters. * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance. * **TargetEnvironment** (*string*) -- **[REQUIRED]** The target virtualization environment. * **ExportToS3Task** (*dict*) -- **[REQUIRED]** The format and location for an export instance task. * **DiskImageFormat** *(string) --* The format for the exported image. * **ContainerFormat** *(string) --* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. * **S3Bucket** *(string) --* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the "Grantee". For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide. * **S3Prefix** *(string) --* The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat. Return type: dict Returns: **Response Syntax** { 'ExportTask': { 'Description': 'string', 'ExportTaskId': 'string', 'ExportToS3Task': { 'ContainerFormat': 'ova', 'DiskImageFormat': 'VMDK'|'RAW'|'VHD', 'S3Bucket': 'string', 'S3Key': 'string' }, 'InstanceExportDetails': { 'InstanceId': 'string', 'TargetEnvironment': 'citrix'|'vmware'|'microsoft' }, 'State': 'active'|'cancelling'|'cancelled'|'completed', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **ExportTask** *(dict) --* Information about the export instance task. * **Description** *(string) --* A description of the resource being exported. * **ExportTaskId** *(string) --* The ID of the export task. * **ExportToS3Task** *(dict) --* Information about the export task. * **ContainerFormat** *(string) --* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. * **DiskImageFormat** *(string) --* The format for the exported image. * **S3Bucket** *(string) --* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the "Grantee". For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide. * **S3Key** *(string) --* The encryption key for your S3 bucket. * **InstanceExportDetails** *(dict) --* Information about the instance to export. * **InstanceId** *(string) --* The ID of the resource being exported. * **TargetEnvironment** *(string) --* The target virtualization environment. * **State** *(string) --* The state of the export task. * **StatusMessage** *(string) --* The status message related to the export task. * **Tags** *(list) --* The tags for the export task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / create_vpc create_vpc ********** EC2.Client.create_vpc(**kwargs) Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the *Amazon VPC User Guide*. You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses ( BYOIP). By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP option sets in the *Amazon VPC User Guide*. You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_vpc( CidrBlock='string', Ipv6Pool='string', Ipv6CidrBlock='string', Ipv4IpamPoolId='string', Ipv4NetmaskLength=123, Ipv6IpamPoolId='string', Ipv6NetmaskLength=123, Ipv6CidrBlockNetworkBorderGroup='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False, InstanceTenancy='default'|'dedicated'|'host', AmazonProvidedIpv6CidrBlock=True|False ) Parameters: * **CidrBlock** (*string*) -- 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". * **Ipv6Pool** (*string*) -- The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. * **Ipv6CidrBlock** (*string*) -- 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. * **Ipv4IpamPoolId** (*string*) -- The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv4NetmaskLength** (*integer*) -- The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv6IpamPoolId** (*string*) -- The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv6NetmaskLength** (*integer*) -- The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the *Amazon VPC IPAM User Guide*. * **Ipv6CidrBlockNetworkBorderGroup** (*string*) -- 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. * **TagSpecifications** (*list*) -- The tags to assign to the VPC. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- 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" * **AmazonProvidedIpv6CidrBlock** (*boolean*) -- 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. Return type: dict Returns: **Response Syntax** { 'Vpc': { 'OwnerId': 'string', 'InstanceTenancy': 'default'|'dedicated'|'host', 'Ipv6CidrBlockAssociationSet': [ { 'AssociationId': 'string', 'Ipv6CidrBlock': 'string', 'Ipv6CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' }, 'NetworkBorderGroup': 'string', 'Ipv6Pool': 'string', 'Ipv6AddressAttribute': 'public'|'private', 'IpSource': 'amazon'|'byoip'|'none' }, ], 'CidrBlockAssociationSet': [ { 'AssociationId': 'string', 'CidrBlock': 'string', 'CidrBlockState': { 'State': 'associating'|'associated'|'disassociating'|'disassociated'|'failing'|'failed', 'StatusMessage': 'string' } }, ], 'IsDefault': True|False, 'EncryptionControl': { 'VpcId': 'string', 'VpcEncryptionControlId': 'string', 'Mode': 'monitor'|'enforce', 'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed', 'StateMessage': 'string', 'ResourceExclusions': { 'InternetGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'EgressOnlyInternetGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'NatGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'VirtualPrivateGateway': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' }, 'VpcPeering': { 'State': 'enabling'|'enabled'|'disabling'|'disabled', 'StateMessage': 'string' } }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'BlockPublicAccessStates': { 'InternetGatewayBlockMode': 'off'|'block-bidirectional'|'block-ingress' }, 'VpcId': 'string', 'State': 'pending'|'available', 'CidrBlock': 'string', 'DhcpOptionsId': 'string' } } **Response Structure** * *(dict) --* * **Vpc** *(dict) --* Information about the VPC. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the VPC. * **InstanceTenancy** *(string) --* The allowed tenancy of instances launched into the VPC. * **Ipv6CidrBlockAssociationSet** *(list) --* Information about the IPv6 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv6 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv6 CIDR block. * **Ipv6CidrBlock** *(string) --* The IPv6 CIDR block. * **Ipv6CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **NetworkBorderGroup** *(string) --* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, "us- east-1-wl1-bos-wlz-1". * **Ipv6Pool** *(string) --* The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. * **Ipv6AddressAttribute** *(string) --* Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services. * **IpSource** *(string) --* The source that allocated the IP address space. "byoip" or "amazon" indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). "none" indicates private space. * **CidrBlockAssociationSet** *(list) --* Information about the IPv4 CIDR blocks associated with the VPC. * *(dict) --* Describes an IPv4 CIDR block associated with a VPC. * **AssociationId** *(string) --* The association ID for the IPv4 CIDR block. * **CidrBlock** *(string) --* The IPv4 CIDR block. * **CidrBlockState** *(dict) --* Information about the state of the CIDR block. * **State** *(string) --* The state of the CIDR block. * **StatusMessage** *(string) --* A message about the status of the CIDR block, if applicable. * **IsDefault** *(boolean) --* Indicates whether the VPC is the default VPC. * **EncryptionControl** *(dict) --* * **VpcId** *(string) --* * **VpcEncryptionControlId** *(string) --* * **Mode** *(string) --* * **State** *(string) --* * **StateMessage** *(string) --* * **ResourceExclusions** *(dict) --* * **InternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **EgressOnlyInternetGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **NatGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VirtualPrivateGateway** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **VpcPeering** *(dict) --* * **State** *(string) --* * **StateMessage** *(string) --* * **Tags** *(list) --* * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **Tags** *(list) --* Any tags assigned to the VPC. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **BlockPublicAccessStates** *(dict) --* The state of VPC Block Public Access (BPA). * **InternetGatewayBlockMode** *(string) --* The mode of VPC BPA. * "off": VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. * "block-bidirectional": Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets). * "block-ingress": Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established. * **VpcId** *(string) --* The ID of the VPC. * **State** *(string) --* The current state of the VPC. * **CidrBlock** *(string) --* The primary IPv4 CIDR block for the VPC. * **DhcpOptionsId** *(string) --* The ID of the set of DHCP options you've associated with the VPC. **Examples** This example creates a VPC with the specified CIDR block. response = client.create_vpc( CidrBlock='10.0.0.0/16', ) print(response) Expected Output: { 'Vpc': { 'CidrBlock': '10.0.0.0/16', 'DhcpOptionsId': 'dopt-7a8b9c2d', 'InstanceTenancy': 'default', 'State': 'pending', 'VpcId': 'vpc-a01106c2', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / disassociate_transit_gateway_route_table disassociate_transit_gateway_route_table **************************************** EC2.Client.disassociate_transit_gateway_route_table(**kwargs) Disassociates a resource attachment from a transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.disassociate_transit_gateway_route_table( TransitGatewayRouteTableId='string', TransitGatewayAttachmentId='string', DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **TransitGatewayAttachmentId** (*string*) -- **[REQUIRED]** The ID of the attachment. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'Association': { 'TransitGatewayRouteTableId': 'string', 'TransitGatewayAttachmentId': 'string', 'ResourceId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'State': 'associating'|'associated'|'disassociating'|'disassociated' } } **Response Structure** * *(dict) --* * **Association** *(dict) --* Information about the association. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceId** *(string) --* The ID of the resource. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **State** *(string) --* The state of the association. EC2 / Client / delete_traffic_mirror_filter delete_traffic_mirror_filter **************************** EC2.Client.delete_traffic_mirror_filter(**kwargs) Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session. See also: AWS API Documentation **Request Syntax** response = client.delete_traffic_mirror_filter( TrafficMirrorFilterId='string', DryRun=True|False ) Parameters: * **TrafficMirrorFilterId** (*string*) -- **[REQUIRED]** The ID of the Traffic Mirror filter. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TrafficMirrorFilterId': 'string' } **Response Structure** * *(dict) --* * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter. EC2 / Client / modify_vpc_endpoint_service_payer_responsibility modify_vpc_endpoint_service_payer_responsibility ************************************************ EC2.Client.modify_vpc_endpoint_service_payer_responsibility(**kwargs) Modifies the payer responsibility for your VPC endpoint service. See also: AWS API Documentation **Request Syntax** response = client.modify_vpc_endpoint_service_payer_responsibility( DryRun=True|False, ServiceId='string', PayerResponsibility='ServiceOwner' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- **[REQUIRED]** The ID of the service. * **PayerResponsibility** (*string*) -- **[REQUIRED]** The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner. Return type: dict Returns: **Response Syntax** { 'ReturnValue': True|False } **Response Structure** * *(dict) --* * **ReturnValue** *(boolean) --* Returns "true" if the request succeeds; otherwise, it returns an error. EC2 / Client / purchase_capacity_block purchase_capacity_block *********************** EC2.Client.purchase_capacity_block(**kwargs) Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing. See also: AWS API Documentation **Request Syntax** response = client.purchase_capacity_block( DryRun=True|False, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], CapacityBlockOfferingId='string', InstancePlatform='Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The tags to apply to the Capacity Block during launch. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **CapacityBlockOfferingId** (*string*) -- **[REQUIRED]** The ID of the Capacity Block offering. * **InstancePlatform** (*string*) -- **[REQUIRED]** The type of operating system for which to reserve capacity. Return type: dict Returns: **Response Syntax** { 'CapacityReservation': { 'CapacityReservationId': 'string', 'OwnerId': 'string', 'CapacityReservationArn': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'string', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'Tenancy': 'default'|'dedicated', 'TotalInstanceCount': 123, 'AvailableInstanceCount': 123, 'EbsOptimized': True|False, 'EphemeralStorage': True|False, 'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported'|'unavailable', 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'EndDateType': 'unlimited'|'limited', 'InstanceMatchCriteria': 'open'|'targeted', 'CreateDate': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'OutpostArn': 'string', 'CapacityReservationFleetId': 'string', 'PlacementGroupArn': 'string', 'CapacityAllocations': [ { 'AllocationType': 'used'|'future', 'Count': 123 }, ], 'ReservationType': 'default'|'capacity-block', 'UnusedReservationBillingOwnerId': 'string', 'CommitmentInfo': { 'CommittedInstanceCount': 123, 'CommitmentEndDate': datetime(2015, 1, 1) }, 'DeliveryPreference': 'fixed'|'incremental', 'CapacityBlockId': 'string' }, 'CapacityBlocks': [ { 'CapacityBlockId': 'string', 'UltraserverType': 'string', 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'CapacityReservationIds': [ 'string', ], 'StartDate': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'CreateDate': datetime(2015, 1, 1), 'State': 'active'|'expired'|'unavailable'|'cancelled'|'failed'|'scheduled'|'payment-pending'|'payment-failed', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **CapacityReservation** *(dict) --* The Capacity Reservation. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the Capacity Reservation. * **CapacityReservationArn** *(string) --* The Amazon Resource Name (ARN) of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Reservation. * **InstanceType** *(string) --* The type of instance for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the capacity is reserved. * **Tenancy** *(string) --* 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 Amazon Web Services accounts. * "dedicated" - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **AvailableInstanceCount** *(integer) --* The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. * **EbsOptimized** *(boolean) --* 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. * **EphemeralStorage** *(boolean) --* *Deprecated.* * **State** *(string) --* The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: * "active" - The capacity is available for use. * "expired" - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. * "cancelled" - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. * "scheduled" - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. * "payment-pending" - (*Capacity Blocks*) The upfront payment has not been processed yet. * "payment-failed" - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. * "assessing" - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. * "delayed" - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. * "unsupported" - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. * **StartDate** *(datetime) --* The date and time at which the Capacity Reservation was started. * **EndDate** *(datetime) --* 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. * **EndDateType** *(string) --* 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. * **InstanceMatchCriteria** *(string) --* 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. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Tags** *(list) --* Any tags assigned to the Capacity Reservation. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. * **PlacementGroupArn** *(string) --* The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the *Amazon EC2 User Guide*. * **CapacityAllocations** *(list) --* Information about instance capacity usage. * *(dict) --* Information about instance capacity usage for a Capacity Reservation. * **AllocationType** *(string) --* The usage type. "used" indicates that the instance capacity is in use by instances that are running in the Capacity Reservation. * **Count** *(integer) --* The amount of instance capacity associated with the usage. For example a value of "4" indicates that instance capacity for 4 instances is currently in use. * **ReservationType** *(string) --* The type of Capacity Reservation. * **UnusedReservationBillingOwnerId** *(string) --* The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned. * **CommitmentInfo** *(dict) --* Information about your commitment for a future-dated Capacity Reservation. * **CommittedInstanceCount** *(integer) --* The instance capacity that you committed to when you requested the future-dated Capacity Reservation. * **CommitmentEndDate** *(datetime) --* The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( "YYYY-MM-DDThh:mm:ss.sssZ"). You can't decrease the instance count or cancel the Capacity Reservation before this date and time. * **DeliveryPreference** *(string) --* The delivery method for a future-dated Capacity Reservation. "incremental" indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **CapacityBlocks** *(list) --* The Capacity Block. * *(dict) --* Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside Amazon EC2 UltraClusters, for low-latency, petabit-scale, non- blocking networking. You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high- bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers. * **CapacityBlockId** *(string) --* The ID of the Capacity Block. * **UltraserverType** *(string) --* The EC2 UltraServer type of the Capacity Block. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Block. * **CapacityReservationIds** *(list) --* The ID of the Capacity Reservation. * *(string) --* * **StartDate** *(datetime) --* The date and time at which the Capacity Block was started. * **EndDate** *(datetime) --* The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated. * **CreateDate** *(datetime) --* The date and time at which the Capacity Block was created. * **State** *(string) --* The state of the Capacity Block. * **Tags** *(list) --* The tags assigned to the Capacity Block. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / get_instance_uefi_data get_instance_uefi_data ********************** EC2.Client.get_instance_uefi_data(**kwargs) A binary representation of the UEFI variable store. Only non- volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded. When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the "UefiData" parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image. For more information, see UEFI Secure Boot in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.get_instance_uefi_data( InstanceId='string', DryRun=True|False ) Parameters: * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the instance from which to retrieve the UEFI data. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceId': 'string', 'UefiData': 'string' } **Response Structure** * *(dict) --* * **InstanceId** *(string) --* The ID of the instance from which to retrieve the UEFI data. * **UefiData** *(string) --* Base64 representation of the non-volatile UEFI variable store. EC2 / Client / create_dhcp_options create_dhcp_options ******************* EC2.Client.create_dhcp_options(**kwargs) Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options. The following are the individual DHCP options you can specify. For more information, see DHCP option sets in the *Amazon VPC User Guide*. * "domain-name" - If you're using AmazonProvidedDNS in "us-east-1", specify "ec2.internal". If you're using AmazonProvidedDNS in any other Region, specify "region.compute.internal". Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames. Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name. * "domain-name-servers" - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in "domain-name", you must specify a custom DNS server. * "ntp-servers" - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses). * "netbios-name-servers" - The IP addresses of up to four NetBIOS name servers. * "netbios-node-type" - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132. * "ipv6-address-preferred-lease-time" - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed. See also: AWS API Documentation **Request Syntax** response = client.create_dhcp_options( DhcpConfigurations=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **DhcpConfigurations** (*list*) -- **[REQUIRED]** A DHCP configuration option. * *(dict) --* Describes a DHCP configuration option. * **Key** *(string) --* The name of a DHCP option. * **Values** *(list) --* The values for the DHCP option. * *(string) --* * **TagSpecifications** (*list*) -- The tags to assign to the DHCP option. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'DhcpOptions': { 'OwnerId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DhcpOptionsId': 'string', 'DhcpConfigurations': [ { 'Key': 'string', 'Values': [ { 'Value': 'string' }, ] }, ] } } **Response Structure** * *(dict) --* * **DhcpOptions** *(dict) --* A set of DHCP options. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that owns the DHCP options set. * **Tags** *(list) --* Any tags assigned to the DHCP options set. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DhcpOptionsId** *(string) --* The ID of the set of DHCP options. * **DhcpConfigurations** *(list) --* The DHCP options in the set. * *(dict) --* Describes a DHCP configuration option. * **Key** *(string) --* The name of a DHCP option. * **Values** *(list) --* The values for the DHCP option. * *(dict) --* Describes a value for a resource attribute that is a String. * **Value** *(string) --* The attribute value. The value is case-sensitive. **Examples** This example creates a DHCP options set. response = client.create_dhcp_options( DhcpConfigurations=[ { 'Key': 'domain-name-servers', 'Values': [ '10.2.5.1', '10.2.5.2', ], }, ], ) print(response) Expected Output: { 'DhcpOptions': { 'DhcpConfigurations': [ { 'Key': 'domain-name-servers', 'Values': [ { 'Value': '10.2.5.2', }, { 'Value': '10.2.5.1', }, ], }, ], 'DhcpOptionsId': 'dopt-d9070ebb', }, 'ResponseMetadata': { '...': '...', }, } EC2 / Client / enable_serial_console_access enable_serial_console_access **************************** EC2.Client.enable_serial_console_access(**kwargs) 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*. See also: AWS API Documentation **Request Syntax** response = client.enable_serial_console_access( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'SerialConsoleAccessEnabled': True|False } **Response Structure** * *(dict) --* * **SerialConsoleAccessEnabled** *(boolean) --* If "true", access to the EC2 serial console of all instances is enabled for your account. If "false", access to the EC2 serial console of all instances is disabled for your account. EC2 / Client / associate_address associate_address ***************** EC2.Client.associate_address(**kwargs) Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. You cannot associate an Elastic IP address with an interface in a different network border group. Warning: 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. See also: AWS API Documentation **Request Syntax** response = client.associate_address( AllocationId='string', InstanceId='string', PublicIp='string', DryRun=True|False, NetworkInterfaceId='string', PrivateIpAddress='string', AllowReassociation=True|False ) Parameters: * **AllocationId** (*string*) -- The allocation ID. This is required. * **InstanceId** (*string*) -- The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. * **PublicIp** (*string*) -- Deprecated. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. You can specify either the instance ID or the network interface ID, but not both. * **PrivateIpAddress** (*string*) -- 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. * **AllowReassociation** (*boolean*) -- Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. Return type: dict Returns: **Response Syntax** { 'AssociationId': 'string' } **Response Structure** * *(dict) --* * **AssociationId** *(string) --* The ID that represents the association of the Elastic IP address with an instance. **Examples** This example associates the specified Elastic IP address with the specified instance in a VPC. response = client.associate_address( AllocationId='eipalloc-64d5890a', InstanceId='i-0b263919b6498b123', ) print(response) Expected Output: { 'AssociationId': 'eipassoc-2bebb745', 'ResponseMetadata': { '...': '...', }, } This example associates the specified Elastic IP address with the specified network interface. response = client.associate_address( AllocationId='eipalloc-64d5890a', NetworkInterfaceId='eni-1a2b3c4d', ) print(response) Expected Output: { 'AssociationId': 'eipassoc-2bebb745', 'ResponseMetadata': { '...': '...', }, } This example associates an Elastic IP address with an instance in EC2-Classic. response = client.associate_address( InstanceId='i-07ffe74c7330ebf53', PublicIp='198.51.100.0', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_flow_logs describe_flow_logs ****************** EC2.Client.describe_flow_logs(**kwargs) Describes one or more flow logs. To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream. See also: AWS API Documentation **Request Syntax** response = client.describe_flow_logs( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], FlowLogIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- One or more filters. * "deliver-log-status" - The status of the logs delivery ( "SUCCESS" | "FAILED"). * "log-destination-type" - The type of destination for the flow log data ( "cloud-watch-logs" | "s3" | "kinesis-data- firehose"). * "flow-log-id" - The ID of the flow log. * "log-group-name" - The name of the log group. * "resource-id" - The ID of the VPC, subnet, or network interface. * "traffic-type" - The type of traffic ( "ACCEPT" | "REJECT" | "ALL"). * "tag": - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **FlowLogIds** (*list*) -- One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token to request the next page of items. Pagination continues from the end of the items returned by the previous request. Return type: dict Returns: **Response Syntax** { 'FlowLogs': [ { 'CreationTime': datetime(2015, 1, 1), 'DeliverLogsErrorMessage': 'string', 'DeliverLogsPermissionArn': 'string', 'DeliverCrossAccountRole': 'string', 'DeliverLogsStatus': 'string', 'FlowLogId': 'string', 'FlowLogStatus': 'string', 'LogGroupName': 'string', 'ResourceId': 'string', 'TrafficType': 'ACCEPT'|'REJECT'|'ALL', 'LogDestinationType': 'cloud-watch-logs'|'s3'|'kinesis-data-firehose', 'LogDestination': 'string', 'LogFormat': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'MaxAggregationInterval': 123, 'DestinationOptions': { 'FileFormat': 'plain-text'|'parquet', 'HiveCompatiblePartitions': True|False, 'PerHourPartition': True|False } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FlowLogs** *(list) --* Information about the flow logs. * *(dict) --* Describes a flow log. * **CreationTime** *(datetime) --* The date and time the flow log was created. * **DeliverLogsErrorMessage** *(string) --* Information about the error that occurred. "Rate limited" indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. "Access error" indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. "Unknown error" indicates an internal error. * **DeliverLogsPermissionArn** *(string) --* The ARN of the IAM role allows the service to publish logs to CloudWatch Logs. * **DeliverCrossAccountRole** *(string) --* The ARN of the IAM role that allows the service to publish flow logs across accounts. * **DeliverLogsStatus** *(string) --* The status of the logs delivery ( "SUCCESS" | "FAILED"). * **FlowLogId** *(string) --* The ID of the flow log. * **FlowLogStatus** *(string) --* The status of the flow log ( "ACTIVE"). * **LogGroupName** *(string) --* The name of the flow log group. * **ResourceId** *(string) --* The ID of the resource being monitored. * **TrafficType** *(string) --* The type of traffic captured for the flow log. * **LogDestinationType** *(string) --* The type of destination for the flow log data. * **LogDestination** *(string) --* The Amazon Resource Name (ARN) of the destination for the flow log data. * **LogFormat** *(string) --* The format of the flow log record. * **Tags** *(list) --* The tags for the flow log. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **MaxAggregationInterval** *(integer) --* The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value. Valid Values: "60" | "600" * **DestinationOptions** *(dict) --* The destination options. * **FileFormat** *(string) --* The format for the flow log. * **HiveCompatiblePartitions** *(boolean) --* Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. * **PerHourPartition** *(boolean) --* Indicates whether to partition the flow log per hour. * **NextToken** *(string) --* The token to request the next page of items. This value is "null" when there are no more items to return. EC2 / Client / create_capacity_reservation_fleet create_capacity_reservation_fleet ********************************* EC2.Client.create_capacity_reservation_fleet(**kwargs) Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_capacity_reservation_fleet( AllocationStrategy='string', ClientToken='string', InstanceTypeSpecifications=[ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'Weight': 123.0, 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'EbsOptimized': True|False, 'Priority': 123 }, ], Tenancy='default', TotalTargetCapacity=123, EndDate=datetime(2015, 1, 1), InstanceMatchCriteria='open', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], DryRun=True|False ) Parameters: * **AllocationStrategy** (*string*) -- The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the "prioritized" allocation strategy is supported. For more information, see Allocation strategy in the *Amazon EC2 User Guide*. Valid values: "prioritized" * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. This field is autopopulated if not provided. * **InstanceTypeSpecifications** (*list*) -- **[REQUIRED]** Information about the instance types for which to reserve the capacity. * *(dict) --* Information about an instance type to use in a Capacity Reservation Fleet. * **InstanceType** *(string) --* The instance type for which the Capacity Reservation Fleet reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation Fleet reserves capacity. * **Weight** *(float) --* The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **AvailabilityZone** *(string) --* The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone. * **EbsOptimized** *(boolean) --* Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. 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 EBS-optimized instance types. * **Priority** *(integer) --* The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the *Amazon EC2 User Guide*. * **Tenancy** (*string*) -- Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings: * "default" - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. * "dedicated" - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account. * **TotalTargetCapacity** (*integer*) -- **[REQUIRED]** The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **EndDate** (*datetime*) -- The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to "expired" and all of the Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify "5/31/2019", "13:30:55", the Capacity Reservation Fleet is guaranteed to expire between "13:30:55" and "14:30:55" on "5/31/2019". * **InstanceMatchCriteria** (*string*) -- Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria. Currently, Capacity Reservation Fleets support "open" instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity. * **TagSpecifications** (*list*) -- The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CapacityReservationFleetId': 'string', 'State': 'submitted'|'modifying'|'active'|'partially_fulfilled'|'expiring'|'expired'|'cancelling'|'cancelled'|'failed', 'TotalTargetCapacity': 123, 'TotalFulfilledCapacity': 123.0, 'InstanceMatchCriteria': 'open', 'AllocationStrategy': 'string', 'CreateTime': datetime(2015, 1, 1), 'EndDate': datetime(2015, 1, 1), 'Tenancy': 'default', 'FleetCapacityReservations': [ { 'CapacityReservationId': 'string', 'AvailabilityZoneId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro', 'AvailabilityZone': 'string', 'TotalInstanceCount': 123, 'FulfilledCapacity': 123.0, 'EbsOptimized': True|False, 'CreateDate': datetime(2015, 1, 1), 'Weight': 123.0, 'Priority': 123 }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **CapacityReservationFleetId** *(string) --* The ID of the Capacity Reservation Fleet. * **State** *(string) --* The status of the Capacity Reservation Fleet. * **TotalTargetCapacity** *(integer) --* The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. * **TotalFulfilledCapacity** *(float) --* The requested capacity units that have been successfully reserved. * **InstanceMatchCriteria** *(string) --* The instance matching criteria for the Capacity Reservation Fleet. * **AllocationStrategy** *(string) --* The allocation strategy used by the Capacity Reservation Fleet. * **CreateTime** *(datetime) --* The date and time at which the Capacity Reservation Fleet was created. * **EndDate** *(datetime) --* The date and time at which the Capacity Reservation Fleet expires. * **Tenancy** *(string) --* Indicates the tenancy of Capacity Reservation Fleet. * **FleetCapacityReservations** *(list) --* Information about the individual Capacity Reservations in the Capacity Reservation Fleet. * *(dict) --* Information about a Capacity Reservation in a Capacity Reservation Fleet. * **CapacityReservationId** *(string) --* The ID of the Capacity Reservation. * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone in which the Capacity Reservation reserves capacity. * **InstanceType** *(string) --* The instance type for which the Capacity Reservation reserves capacity. * **InstancePlatform** *(string) --* The type of operating system for which the Capacity Reservation reserves capacity. * **AvailabilityZone** *(string) --* The Availability Zone in which the Capacity Reservation reserves capacity. * **TotalInstanceCount** *(integer) --* The total number of instances for which the Capacity Reservation reserves capacity. * **FulfilledCapacity** *(float) --* The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the *Amazon EC2 User Guide*. * **EbsOptimized** *(boolean) --* Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types. * **CreateDate** *(datetime) --* The date and time at which the Capacity Reservation was created. * **Weight** *(float) --* The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the *Amazon EC2 User Guide*. * **Priority** *(integer) --* The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the *Amazon EC2 User Guide*. * **Tags** *(list) --* The tags assigned to the Capacity Reservation Fleet. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / delete_fleets delete_fleets ************* EC2.Client.delete_fleets(**kwargs) Deletes the specified EC2 Fleet request. After you delete an EC2 Fleet request, it launches no new instances. You must also specify whether a deleted EC2 Fleet request should terminate its instances. If you choose to terminate the instances, the EC2 Fleet request enters the "deleted_terminating" state. Otherwise, it enters the "deleted_running" state, and the instances continue to run until they are interrupted or you terminate them manually. A deleted "instant" fleet with running instances is not supported. When you delete an "instant" fleet, Amazon EC2 automatically terminates all its instances. For fleets with more than 1000 instances, the deletion request might fail. If your fleet has more than 1000 instances, first terminate most of the instances manually, leaving 1000 or fewer. Then delete the fleet, and the remaining instances will be terminated automatically. **Restrictions** * You can delete up to 25 fleets of type "instant" in a single request. * You can delete up to 100 fleets of type "maintain" or "request" in a single request. * You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above. * If you exceed the specified number of fleets to delete, no fleets are deleted. For more information, see Delete an EC2 Fleet request and the instances in the fleet in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_fleets( DryRun=True|False, FleetIds=[ 'string', ], TerminateInstances=True|False ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FleetIds** (*list*) -- **[REQUIRED]** The IDs of the EC2 Fleets. Constraints: In a single request, you can specify up to 25 "instant" fleet IDs and up to 100 "maintain" or "request" fleet IDs. * *(string) --* * **TerminateInstances** (*boolean*) -- **[REQUIRED]** Indicates whether to terminate the associated 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 "no-terminate-instances". 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. Return type: dict Returns: **Response Syntax** { 'SuccessfulFleetDeletions': [ { 'CurrentFleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying', 'PreviousFleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying', 'FleetId': 'string' }, ], 'UnsuccessfulFleetDeletions': [ { 'Error': { 'Code': 'fleetIdDoesNotExist'|'fleetIdMalformed'|'fleetNotInDeletableState'|'unexpectedError', 'Message': 'string' }, 'FleetId': 'string' }, ] } **Response Structure** * *(dict) --* * **SuccessfulFleetDeletions** *(list) --* Information about the EC2 Fleets that are successfully deleted. * *(dict) --* Describes an EC2 Fleet that was successfully deleted. * **CurrentFleetState** *(string) --* The current state of the EC2 Fleet. * **PreviousFleetState** *(string) --* The previous state of the EC2 Fleet. * **FleetId** *(string) --* The ID of the EC2 Fleet. * **UnsuccessfulFleetDeletions** *(list) --* Information about the EC2 Fleets that are not successfully deleted. * *(dict) --* Describes an EC2 Fleet that was not successfully deleted. * **Error** *(dict) --* The error. * **Code** *(string) --* The error code. * **Message** *(string) --* The description for the error code. * **FleetId** *(string) --* The ID of the EC2 Fleet. EC2 / Client / describe_verified_access_instance_logging_configurations describe_verified_access_instance_logging_configurations ******************************************************** EC2.Client.describe_verified_access_instance_logging_configurations(**kwargs) Describes the specified Amazon Web Services Verified Access instances. See also: AWS API Documentation **Request Syntax** response = client.describe_verified_access_instance_logging_configurations( VerifiedAccessInstanceIds=[ 'string', ], MaxResults=123, NextToken='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **VerifiedAccessInstanceIds** (*list*) -- The IDs of the Verified Access instances. * *(string) --* * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **Filters** (*list*) -- One or more filters. Filter names and values are case- sensitive. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'LoggingConfigurations': [ { 'VerifiedAccessInstanceId': 'string', 'AccessLogs': { 'S3': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'BucketName': 'string', 'Prefix': 'string', 'BucketOwner': 'string' }, 'CloudWatchLogs': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'LogGroup': 'string' }, 'KinesisDataFirehose': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'DeliveryStream': 'string' }, 'LogVersion': 'string', 'IncludeTrustContext': True|False } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LoggingConfigurations** *(list) --* The logging configuration for the Verified Access instances. * *(dict) --* Describes logging options for an Amazon Web Services Verified Access instance. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **AccessLogs** *(dict) --* Details about the logging options. * **S3** *(dict) --* Amazon S3 logging options. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **BucketName** *(string) --* The bucket name. * **Prefix** *(string) --* The bucket prefix. * **BucketOwner** *(string) --* The Amazon Web Services account number that owns the bucket. * **CloudWatchLogs** *(dict) --* CloudWatch Logs logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status for access logs. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **LogGroup** *(string) --* The ID of the CloudWatch Logs log group. * **KinesisDataFirehose** *(dict) --* Kinesis logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **DeliveryStream** *(string) --* The ID of the delivery stream. * **LogVersion** *(string) --* The log version. * **IncludeTrustContext** *(boolean) --* Indicates whether trust data is included in the logs. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / reset_fpga_image_attribute reset_fpga_image_attribute ************************** EC2.Client.reset_fpga_image_attribute(**kwargs) Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. See also: AWS API Documentation **Request Syntax** response = client.reset_fpga_image_attribute( DryRun=True|False, FpgaImageId='string', Attribute='loadPermission' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **FpgaImageId** (*string*) -- **[REQUIRED]** The ID of the AFI. * **Attribute** (*string*) -- The attribute. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Is "true" if the request succeeds, and an error otherwise. EC2 / Client / create_egress_only_internet_gateway create_egress_only_internet_gateway *********************************** EC2.Client.create_egress_only_internet_gateway(**kwargs) [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. See also: AWS API Documentation **Request Syntax** response = client.create_egress_only_internet_gateway( ClientToken='string', DryRun=True|False, VpcId='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **VpcId** (*string*) -- **[REQUIRED]** The ID of the VPC for which to create the egress-only internet gateway. * **TagSpecifications** (*list*) -- The tags to assign to the egress-only internet gateway. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'ClientToken': 'string', 'EgressOnlyInternetGateway': { 'Attachments': [ { 'State': 'attaching'|'attached'|'detaching'|'detached', 'VpcId': 'string' }, ], 'EgressOnlyInternetGatewayId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. * **EgressOnlyInternetGateway** *(dict) --* Information about the egress-only internet gateway. * **Attachments** *(list) --* Information about the attachment of the egress-only internet gateway. * *(dict) --* Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway. * **State** *(string) --* The current state of the attachment. For an internet gateway, the state is "available" when attached to a VPC; otherwise, this value is not returned. * **VpcId** *(string) --* The ID of the VPC. * **EgressOnlyInternetGatewayId** *(string) --* The ID of the egress-only internet gateway. * **Tags** *(list) --* The tags assigned to the egress-only internet gateway. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_export_tasks describe_export_tasks ********************* EC2.Client.describe_export_tasks(**kwargs) Describes the specified export instance tasks or all of your export instance tasks. See also: AWS API Documentation **Request Syntax** response = client.describe_export_tasks( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], ExportTaskIds=[ 'string', ] ) Parameters: * **Filters** (*list*) -- the filters for the export tasks. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **ExportTaskIds** (*list*) -- The export task IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ExportTasks': [ { 'Description': 'string', 'ExportTaskId': 'string', 'ExportToS3Task': { 'ContainerFormat': 'ova', 'DiskImageFormat': 'VMDK'|'RAW'|'VHD', 'S3Bucket': 'string', 'S3Key': 'string' }, 'InstanceExportDetails': { 'InstanceId': 'string', 'TargetEnvironment': 'citrix'|'vmware'|'microsoft' }, 'State': 'active'|'cancelling'|'cancelled'|'completed', 'StatusMessage': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **ExportTasks** *(list) --* Information about the export tasks. * *(dict) --* Describes an export instance task. * **Description** *(string) --* A description of the resource being exported. * **ExportTaskId** *(string) --* The ID of the export task. * **ExportToS3Task** *(dict) --* Information about the export task. * **ContainerFormat** *(string) --* The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. * **DiskImageFormat** *(string) --* The format for the exported image. * **S3Bucket** *(string) --* The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region- specific canonical account ID for the "Grantee". For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide. * **S3Key** *(string) --* The encryption key for your S3 bucket. * **InstanceExportDetails** *(dict) --* Information about the instance to export. * **InstanceId** *(string) --* The ID of the resource being exported. * **TargetEnvironment** *(string) --* The target virtualization environment. * **State** *(string) --* The state of the export task. * **StatusMessage** *(string) --* The status message related to the export task. * **Tags** *(list) --* The tags for the export task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_scheduled_instance_availability describe_scheduled_instance_availability **************************************** EC2.Client.describe_scheduled_instance_availability(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.describe_scheduled_instance_availability( DryRun=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], FirstSlotStartTimeRange={ 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, MaxResults=123, MaxSlotDurationInHours=123, MinSlotDurationInHours=123, NextToken='string', Recurrence={ 'Frequency': 'string', 'Interval': 123, 'OccurrenceDays': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' } ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*list*) -- The filters. * "availability-zone" - The Availability Zone (for example, "us-west-2a"). * "instance-type" - The instance type (for example, "c4.large"). * "platform" - The platform ( "Linux/UNIX" or "Windows"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **FirstSlotStartTimeRange** (*dict*) -- **[REQUIRED]** The time period for the first schedule to start. * **EarliestTime** *(datetime) --* **[REQUIRED]** The earliest date and time, in UTC, for the Scheduled Instance to start. * **LatestTime** *(datetime) --* **[REQUIRED]** The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future. * **MaxResults** (*integer*) -- 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** (*integer*) -- The maximum available duration, in hours. This value must be greater than "MinSlotDurationInHours" and less than 1,720. * **MinSlotDurationInHours** (*integer*) -- 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** (*string*) -- The token for the next set of results. * **Recurrence** (*dict*) -- **[REQUIRED]** The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "Frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDays** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day. * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule. * **OccurrenceUnit** *(string) --* The unit for "OccurrenceDays" ( "DayOfWeek" or "DayOfMonth"). This value is required for a monthly schedule. You can't specify "DayOfWeek" with a weekly schedule. You can't specify this value with a daily schedule. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ScheduledInstanceAvailabilitySet': [ { 'AvailabilityZone': 'string', 'AvailableInstanceCount': 123, 'FirstSlotStartTime': datetime(2015, 1, 1), 'HourlyPrice': 'string', 'InstanceType': 'string', 'MaxTermDurationInDays': 123, 'MinTermDurationInDays': 123, 'NetworkPlatform': 'string', 'Platform': 'string', 'PurchaseToken': 'string', 'Recurrence': { 'Frequency': 'string', 'Interval': 123, 'OccurrenceDaySet': [ 123, ], 'OccurrenceRelativeToEnd': True|False, 'OccurrenceUnit': 'string' }, 'SlotDurationInHours': 123, 'TotalScheduledInstanceHours': 123 }, ] } **Response Structure** * *(dict) --* Contains the output of DescribeScheduledInstanceAvailability. * **NextToken** *(string) --* The token required to retrieve the next set of results. This value is "null" when there are no more results to return. * **ScheduledInstanceAvailabilitySet** *(list) --* Information about the available Scheduled Instances. * *(dict) --* Describes a schedule that is available for your Scheduled Instances. * **AvailabilityZone** *(string) --* The Availability Zone. * **AvailableInstanceCount** *(integer) --* The number of available instances. * **FirstSlotStartTime** *(datetime) --* The time period for the first schedule to start. * **HourlyPrice** *(string) --* The hourly price for a single instance. * **InstanceType** *(string) --* The instance type. You can specify one of the C3, C4, M4, or R3 instance types. * **MaxTermDurationInDays** *(integer) --* The maximum term. The only possible value is 365 days. * **MinTermDurationInDays** *(integer) --* The minimum term. The only possible value is 365 days. * **NetworkPlatform** *(string) --* The network platform. * **Platform** *(string) --* The platform ( "Linux/UNIX" or "Windows"). * **PurchaseToken** *(string) --* The purchase token. This token expires in two hours. * **Recurrence** *(dict) --* The schedule recurrence. * **Frequency** *(string) --* The frequency ( "Daily", "Weekly", or "Monthly"). * **Interval** *(integer) --* The interval quantity. The interval unit depends on the value of "frequency". For example, every 2 weeks or every 2 months. * **OccurrenceDaySet** *(list) --* The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). * *(integer) --* * **OccurrenceRelativeToEnd** *(boolean) --* Indicates whether the occurrence is relative to the end of the specified week or month. * **OccurrenceUnit** *(string) --* The unit for "occurrenceDaySet" ( "DayOfWeek" or "DayOfMonth"). * **SlotDurationInHours** *(integer) --* The number of hours in the schedule. * **TotalScheduledInstanceHours** *(integer) --* The total number of hours for a single instance for the entire term. **Examples** This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example. response = client.describe_scheduled_instance_availability( FirstSlotStartTimeRange={ 'EarliestTime': datetime(2016, 1, 31, 0, 0, 0, 6, 31, 0), 'LatestTime': datetime(2016, 1, 31, 4, 0, 0, 6, 31, 0), }, Recurrence={ 'Frequency': 'Weekly', 'Interval': 1, 'OccurrenceDays': [ 1, ], }, ) print(response) Expected Output: { 'ScheduledInstanceAvailabilitySet': [ { 'AvailabilityZone': 'us-west-2b', 'AvailableInstanceCount': 20, 'FirstSlotStartTime': datetime(2016, 1, 31, 0, 0, 0, 6, 31, 0), 'HourlyPrice': '0.095', 'InstanceType': 'c4.large', 'MaxTermDurationInDays': 366, 'MinTermDurationInDays': 366, 'NetworkPlatform': 'EC2-VPC', 'Platform': 'Linux/UNIX', 'PurchaseToken': 'eyJ2IjoiMSIsInMiOjEsImMiOi...', 'Recurrence': { 'Frequency': 'Weekly', 'Interval': 1, 'OccurrenceDaySet': [ 1, ], 'OccurrenceRelativeToEnd': False, }, 'SlotDurationInHours': 23, 'TotalScheduledInstanceHours': 1219, }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / create_client_vpn_endpoint create_client_vpn_endpoint ************************** EC2.Client.create_client_vpn_endpoint(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_client_vpn_endpoint( ClientCidrBlock='string', ServerCertificateArn='string', AuthenticationOptions=[ { 'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication', 'ActiveDirectory': { 'DirectoryId': 'string' }, 'MutualAuthentication': { 'ClientRootCertificateChainArn': 'string' }, 'FederatedAuthentication': { 'SAMLProviderArn': 'string', 'SelfServiceSAMLProviderArn': 'string' } }, ], ConnectionLogOptions={ 'Enabled': True|False, 'CloudwatchLogGroup': 'string', 'CloudwatchLogStream': 'string' }, DnsServers=[ 'string', ], TransportProtocol='tcp'|'udp', VpnPort=123, Description='string', SplitTunnel=True|False, DryRun=True|False, ClientToken='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], SecurityGroupIds=[ 'string', ], VpcId='string', SelfServicePortal='enabled'|'disabled', ClientConnectOptions={ 'Enabled': True|False, 'LambdaFunctionArn': 'string' }, SessionTimeoutHours=123, ClientLoginBannerOptions={ 'Enabled': True|False, 'BannerText': 'string' }, ClientRouteEnforcementOptions={ 'Enforced': True|False }, DisconnectOnSessionTimeout=True|False ) Parameters: * **ClientCidrBlock** (*string*) -- **[REQUIRED]** 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. Client CIDR range must have a size of at least /22 and must not be greater than /12. * **ServerCertificateArn** (*string*) -- **[REQUIRED]** The ARN of the server certificate. For more information, see the Certificate Manager User Guide. * **AuthenticationOptions** (*list*) -- **[REQUIRED]** Information about the authentication method to be used to authenticate clients. * *(dict) --* Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the *Client VPN Administrator Guide*. * **Type** *(string) --* The type of client authentication to be used. * **ActiveDirectory** *(dict) --* Information about the Active Directory to be used, if applicable. You must provide this information if **Type** is "directory-service-authentication". * **DirectoryId** *(string) --* The ID of the Active Directory to be used for authentication. * **MutualAuthentication** *(dict) --* Information about the authentication certificates to be used, if applicable. You must provide this information if **Type** is "certificate-authentication". * **ClientRootCertificateChainArn** *(string) --* The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM). * **FederatedAuthentication** *(dict) --* Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if **Type** is "federated-authentication". * **SAMLProviderArn** *(string) --* The Amazon Resource Name (ARN) of the IAM SAML identity provider. * **SelfServiceSAMLProviderArn** *(string) --* The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal. * **ConnectionLogOptions** (*dict*) -- **[REQUIRED]** 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 * **Enabled** *(boolean) --* Indicates whether connection logging is enabled. * **CloudwatchLogGroup** *(string) --* The name of the CloudWatch Logs log group. Required if connection logging is enabled. * **CloudwatchLogStream** *(string) --* The name of the CloudWatch Logs log stream to which the connection data is published. * **DnsServers** (*list*) -- 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. * *(string) --* * **TransportProtocol** (*string*) -- The transport protocol to be used by the VPN session. Default value: "udp" * **VpnPort** (*integer*) -- The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: "443" | "1194" Default Value: "443" * **Description** (*string*) -- A brief description of the Client VPN endpoint. * **SplitTunnel** (*boolean*) -- Indicates whether split-tunnel is enabled on the Client VPN endpoint. By default, split-tunnel on a VPN endpoint is disabled. For information about split-tunnel VPN endpoints, see Split- tunnel Client VPN endpoint in the *Client VPN Administrator Guide*. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **TagSpecifications** (*list*) -- The tags to apply to the Client VPN endpoint during creation. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SecurityGroupIds** (*list*) -- 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. * *(string) --* * **VpcId** (*string*) -- 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. * **SelfServicePortal** (*string*) -- Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: "enabled" * **ClientConnectOptions** (*dict*) -- The options for managing connection authorization for new client connections. * **Enabled** *(boolean) --* Indicates whether client connect options are enabled. The default is "false" (not enabled). * **LambdaFunctionArn** *(string) --* The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. * **SessionTimeoutHours** (*integer*) -- The maximum VPN session duration time in hours. Valid values: "8 | 10 | 12 | 24" Default value: "24" * **ClientLoginBannerOptions** (*dict*) -- Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. * **Enabled** *(boolean) --* Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. Valid values: "true | false" Default value: "false" * **BannerText** *(string) --* Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. * **ClientRouteEnforcementOptions** (*dict*) -- Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel. Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations. * **Enforced** *(boolean) --* Enable or disable Client Route Enforcement. The state can either be "true" (enabled) or "false" (disabled). The default is "false". Valid values: "true | false" Default value: "false" * **DisconnectOnSessionTimeout** (*boolean*) -- Indicates whether the client VPN session is disconnected after the maximum timeout specified in "SessionTimeoutHours" is reached. If "true", users are prompted to reconnect client VPN. If "false", client VPN attempts to reconnect automatically. The default value is "true". Return type: dict Returns: **Response Syntax** { 'ClientVpnEndpointId': 'string', 'Status': { 'Code': 'pending-associate'|'available'|'deleting'|'deleted', 'Message': 'string' }, 'DnsName': 'string' } **Response Structure** * *(dict) --* * **ClientVpnEndpointId** *(string) --* The ID of the Client VPN endpoint. * **Status** *(dict) --* The current state of the Client VPN endpoint. * **Code** *(string) --* The state of the Client VPN endpoint. Possible states include: * "pending-associate" - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections. * "available" - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections. * "deleting" - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections. * "deleted" - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections. * **Message** *(string) --* A message about the status of the Client VPN endpoint. * **DnsName** *(string) --* The DNS name to be used by clients when establishing their VPN session. EC2 / Client / cancel_declarative_policies_report cancel_declarative_policies_report ********************************** EC2.Client.cancel_declarative_policies_report(**kwargs) Cancels the generation of an account status report. You can only cancel a report while it has the "running" status. Reports with other statuses ( "complete", "cancelled", or "error") can't be canceled. For more information, see Generating the account status report for declarative policies in the *Amazon Web Services Organizations User Guide*. See also: AWS API Documentation **Request Syntax** response = client.cancel_declarative_policies_report( DryRun=True|False, ReportId='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ReportId** (*string*) -- **[REQUIRED]** The ID of the report. Return type: dict Returns: **Response Syntax** { 'Return': True|False } **Response Structure** * *(dict) --* * **Return** *(boolean) --* Is "true" if the request succeeds, and an error otherwise. EC2 / Client / modify_verified_access_instance_logging_configuration modify_verified_access_instance_logging_configuration ***************************************************** EC2.Client.modify_verified_access_instance_logging_configuration(**kwargs) Modifies the logging configuration for the specified Amazon Web Services Verified Access instance. See also: AWS API Documentation **Request Syntax** response = client.modify_verified_access_instance_logging_configuration( VerifiedAccessInstanceId='string', AccessLogs={ 'S3': { 'Enabled': True|False, 'BucketName': 'string', 'Prefix': 'string', 'BucketOwner': 'string' }, 'CloudWatchLogs': { 'Enabled': True|False, 'LogGroup': 'string' }, 'KinesisDataFirehose': { 'Enabled': True|False, 'DeliveryStream': 'string' }, 'LogVersion': 'string', 'IncludeTrustContext': True|False }, DryRun=True|False, ClientToken='string' ) Parameters: * **VerifiedAccessInstanceId** (*string*) -- **[REQUIRED]** The ID of the Verified Access instance. * **AccessLogs** (*dict*) -- **[REQUIRED]** The configuration options for Verified Access instances. * **S3** *(dict) --* Sends Verified Access logs to Amazon S3. * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether logging is enabled. * **BucketName** *(string) --* The bucket name. * **Prefix** *(string) --* The bucket prefix. * **BucketOwner** *(string) --* The ID of the Amazon Web Services account that owns the Amazon S3 bucket. * **CloudWatchLogs** *(dict) --* Sends Verified Access logs to CloudWatch Logs. * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether logging is enabled. * **LogGroup** *(string) --* The ID of the CloudWatch Logs log group. * **KinesisDataFirehose** *(dict) --* Sends Verified Access logs to Kinesis. * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether logging is enabled. * **DeliveryStream** *(string) --* The ID of the delivery stream. * **LogVersion** *(string) --* The logging version. Valid values: "ocsf-0.1" | "ocsf-1.0.0-rc.2" * **IncludeTrustContext** *(boolean) --* Indicates whether to include trust data sent by trust providers in the logs. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'LoggingConfiguration': { 'VerifiedAccessInstanceId': 'string', 'AccessLogs': { 'S3': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'BucketName': 'string', 'Prefix': 'string', 'BucketOwner': 'string' }, 'CloudWatchLogs': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'LogGroup': 'string' }, 'KinesisDataFirehose': { 'Enabled': True|False, 'DeliveryStatus': { 'Code': 'success'|'failed', 'Message': 'string' }, 'DeliveryStream': 'string' }, 'LogVersion': 'string', 'IncludeTrustContext': True|False } } } **Response Structure** * *(dict) --* * **LoggingConfiguration** *(dict) --* The logging configuration for the Verified Access instance. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **AccessLogs** *(dict) --* Details about the logging options. * **S3** *(dict) --* Amazon S3 logging options. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **BucketName** *(string) --* The bucket name. * **Prefix** *(string) --* The bucket prefix. * **BucketOwner** *(string) --* The Amazon Web Services account number that owns the bucket. * **CloudWatchLogs** *(dict) --* CloudWatch Logs logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status for access logs. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **LogGroup** *(string) --* The ID of the CloudWatch Logs log group. * **KinesisDataFirehose** *(dict) --* Kinesis logging destination. * **Enabled** *(boolean) --* Indicates whether logging is enabled. * **DeliveryStatus** *(dict) --* The delivery status. * **Code** *(string) --* The status code. * **Message** *(string) --* The status message. * **DeliveryStream** *(string) --* The ID of the delivery stream. * **LogVersion** *(string) --* The log version. * **IncludeTrustContext** *(boolean) --* Indicates whether trust data is included in the logs. EC2 / Client / get_managed_prefix_list_associations get_managed_prefix_list_associations ************************************ EC2.Client.get_managed_prefix_list_associations(**kwargs) Gets information about the resources that are associated with the specified managed prefix list. See also: AWS API Documentation **Request Syntax** response = client.get_managed_prefix_list_associations( DryRun=True|False, PrefixListId='string', MaxResults=123, NextToken='string' ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list. * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. Return type: dict Returns: **Response Syntax** { 'PrefixListAssociations': [ { 'ResourceId': 'string', 'ResourceOwner': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **PrefixListAssociations** *(list) --* Information about the associations. * *(dict) --* Describes the resource with which a prefix list is associated. * **ResourceId** *(string) --* The ID of the resource. * **ResourceOwner** *(string) --* The owner of the resource. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / modify_traffic_mirror_filter_network_services modify_traffic_mirror_filter_network_services ********************************************* EC2.Client.modify_traffic_mirror_filter_network_services(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.modify_traffic_mirror_filter_network_services( TrafficMirrorFilterId='string', AddNetworkServices=[ 'amazon-dns', ], RemoveNetworkServices=[ 'amazon-dns', ], DryRun=True|False ) Parameters: * **TrafficMirrorFilterId** (*string*) -- **[REQUIRED]** The ID of the Traffic Mirror filter. * **AddNetworkServices** (*list*) -- The network service, for example Amazon DNS, that you want to mirror. * *(string) --* * **RemoveNetworkServices** (*list*) -- The network service, for example Amazon DNS, that you no longer want to mirror. * *(string) --* * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TrafficMirrorFilter': { 'TrafficMirrorFilterId': 'string', 'IngressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'EgressFilterRules': [ { 'TrafficMirrorFilterRuleId': 'string', 'TrafficMirrorFilterId': 'string', 'TrafficDirection': 'ingress'|'egress', 'RuleNumber': 123, 'RuleAction': 'accept'|'reject', 'Protocol': 123, 'DestinationPortRange': { 'FromPort': 123, 'ToPort': 123 }, 'SourcePortRange': { 'FromPort': 123, 'ToPort': 123 }, 'DestinationCidrBlock': 'string', 'SourceCidrBlock': 'string', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NetworkServices': [ 'amazon-dns', ], 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TrafficMirrorFilter** *(dict) --* The Traffic Mirror filter that the network service is associated with. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter. * **IngressFilterRules** *(list) --* Information about the ingress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **EgressFilterRules** *(list) --* Information about the egress rules that are associated with the Traffic Mirror filter. * *(dict) --* Describes the Traffic Mirror rule. * **TrafficMirrorFilterRuleId** *(string) --* The ID of the Traffic Mirror rule. * **TrafficMirrorFilterId** *(string) --* The ID of the Traffic Mirror filter that the rule is associated with. * **TrafficDirection** *(string) --* The traffic direction assigned to the Traffic Mirror rule. * **RuleNumber** *(integer) --* The rule number of the Traffic Mirror rule. * **RuleAction** *(string) --* The action assigned to the Traffic Mirror rule. * **Protocol** *(integer) --* The protocol assigned to the Traffic Mirror rule. * **DestinationPortRange** *(dict) --* The destination port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **SourcePortRange** *(dict) --* The source port range assigned to the Traffic Mirror rule. * **FromPort** *(integer) --* The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **ToPort** *(integer) --* The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. * **DestinationCidrBlock** *(string) --* The destination CIDR block assigned to the Traffic Mirror rule. * **SourceCidrBlock** *(string) --* The source CIDR block assigned to the Traffic Mirror rule. * **Description** *(string) --* The description of the Traffic Mirror rule. * **Tags** *(list) --* Tags on Traffic Mirroring filter rules. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NetworkServices** *(list) --* The network service traffic that is associated with the Traffic Mirror filter. * *(string) --* * **Description** *(string) --* The description of the Traffic Mirror filter. * **Tags** *(list) --* The tags assigned to the Traffic Mirror filter. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_route_server_endpoints describe_route_server_endpoints ******************************* EC2.Client.describe_route_server_endpoints(**kwargs) Describes one or more route server endpoints. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_route_server_endpoints( RouteServerEndpointIds=[ 'string', ], NextToken='string', MaxResults=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DryRun=True|False ) Parameters: * **RouteServerEndpointIds** (*list*) -- The IDs of the route server endpoints to describe. * *(string) --* * **NextToken** (*string*) -- The token for the next page of results. * **MaxResults** (*integer*) -- The maximum number of results to return with a single call. * **Filters** (*list*) -- One or more filters to apply to the describe request. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RouteServerEndpoints': [ { 'RouteServerId': 'string', 'RouteServerEndpointId': 'string', 'VpcId': 'string', 'SubnetId': 'string', 'EniId': 'string', 'EniAddress': 'string', 'State': 'pending'|'available'|'deleting'|'deleted'|'failing'|'failed'|'delete-failed', 'FailureReason': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **RouteServerEndpoints** *(list) --* Information about the described route server endpoints. * *(dict) --* Describes a route server endpoint and its properties. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP (Border Gateway Protocol) connections between your route server and your BGP peers. * **RouteServerId** *(string) --* The ID of the route server associated with this endpoint. * **RouteServerEndpointId** *(string) --* The unique identifier of the route server endpoint. * **VpcId** *(string) --* The ID of the VPC containing the endpoint. * **SubnetId** *(string) --* The ID of the subnet to place the route server endpoint into. * **EniId** *(string) --* The ID of the Elastic network interface for the endpoint. * **EniAddress** *(string) --* The IP address of the Elastic network interface for the endpoint. * **State** *(string) --* The current state of the route server endpoint. * **FailureReason** *(string) --* The reason for any failure in endpoint creation or operation. * **Tags** *(list) --* Any tags assigned to the route server endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / detach_verified_access_trust_provider detach_verified_access_trust_provider ************************************* EC2.Client.detach_verified_access_trust_provider(**kwargs) Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance. See also: AWS API Documentation **Request Syntax** response = client.detach_verified_access_trust_provider( VerifiedAccessInstanceId='string', VerifiedAccessTrustProviderId='string', ClientToken='string', DryRun=True|False ) Parameters: * **VerifiedAccessInstanceId** (*string*) -- **[REQUIRED]** The ID of the Verified Access instance. * **VerifiedAccessTrustProviderId** (*string*) -- **[REQUIRED]** The ID of the Verified Access trust provider. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VerifiedAccessTrustProvider': { 'VerifiedAccessTrustProviderId': 'string', 'Description': 'string', 'TrustProviderType': 'user'|'device', 'UserTrustProviderType': 'iam-identity-center'|'oidc', 'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud', 'OidcOptions': { 'Issuer': 'string', 'AuthorizationEndpoint': 'string', 'TokenEndpoint': 'string', 'UserInfoEndpoint': 'string', 'ClientId': 'string', 'ClientSecret': 'string', 'Scope': 'string' }, 'DeviceOptions': { 'TenantId': 'string', 'PublicSigningKeyUrl': 'string' }, 'PolicyReferenceName': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'NativeApplicationOidcOptions': { 'PublicSigningKeyEndpoint': 'string', 'Issuer': 'string', 'AuthorizationEndpoint': 'string', 'TokenEndpoint': 'string', 'UserInfoEndpoint': 'string', 'ClientId': 'string', 'Scope': 'string' } }, 'VerifiedAccessInstance': { 'VerifiedAccessInstanceId': 'string', 'Description': 'string', 'VerifiedAccessTrustProviders': [ { 'VerifiedAccessTrustProviderId': 'string', 'Description': 'string', 'TrustProviderType': 'user'|'device', 'UserTrustProviderType': 'iam-identity-center'|'oidc', 'DeviceTrustProviderType': 'jamf'|'crowdstrike'|'jumpcloud' }, ], 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'FipsEnabled': True|False, 'CidrEndpointsCustomSubDomain': { 'SubDomain': 'string', 'Nameservers': [ 'string', ] } } } **Response Structure** * *(dict) --* * **VerifiedAccessTrustProvider** *(dict) --* Details about the Verified Access trust provider. * **VerifiedAccessTrustProviderId** *(string) --* The ID of the Amazon Web Services Verified Access trust provider. * **Description** *(string) --* A description for the Amazon Web Services Verified Access trust provider. * **TrustProviderType** *(string) --* The type of Verified Access trust provider. * **UserTrustProviderType** *(string) --* The type of user-based trust provider. * **DeviceTrustProviderType** *(string) --* The type of device-based trust provider. * **OidcOptions** *(dict) --* The options for an OpenID Connect-compatible user-identity trust provider. * **Issuer** *(string) --* The OIDC issuer. * **AuthorizationEndpoint** *(string) --* The OIDC authorization endpoint. * **TokenEndpoint** *(string) --* The OIDC token endpoint. * **UserInfoEndpoint** *(string) --* The OIDC user info endpoint. * **ClientId** *(string) --* The client identifier. * **ClientSecret** *(string) --* The client secret. * **Scope** *(string) --* The OpenID Connect (OIDC) scope specified. * **DeviceOptions** *(dict) --* The options for device-identity trust provider. * **TenantId** *(string) --* The ID of the tenant application with the device- identity provider. * **PublicSigningKeyUrl** *(string) --* The URL Amazon Web Services Verified Access will use to verify the authenticity of the device tokens. * **PolicyReferenceName** *(string) --* The identifier to be used when working with policy rules. * **CreationTime** *(string) --* The creation time. * **LastUpdatedTime** *(string) --* The last updated time. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **SseSpecification** *(dict) --* The options in use for server side encryption. * **CustomerManagedKeyEnabled** *(boolean) --* Indicates whether customer managed KMS keys are in use for server side encryption. Valid values: "True" | "False" * **KmsKeyArn** *(string) --* The ARN of the KMS key. * **NativeApplicationOidcOptions** *(dict) --* The OpenID Connect (OIDC) options. * **PublicSigningKeyEndpoint** *(string) --* The public signing key endpoint. * **Issuer** *(string) --* The OIDC issuer identifier of the IdP. * **AuthorizationEndpoint** *(string) --* The authorization endpoint of the IdP. * **TokenEndpoint** *(string) --* The token endpoint of the IdP. * **UserInfoEndpoint** *(string) --* The user info endpoint of the IdP. * **ClientId** *(string) --* The OAuth 2.0 client identifier. * **Scope** *(string) --* The set of user claims to be requested from the IdP. * **VerifiedAccessInstance** *(dict) --* Details about the Verified Access instance. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **Description** *(string) --* A description for the Amazon Web Services Verified Access instance. * **VerifiedAccessTrustProviders** *(list) --* The IDs of the Amazon Web Services Verified Access trust providers. * *(dict) --* Condensed information about a trust provider. * **VerifiedAccessTrustProviderId** *(string) --* The ID of the trust provider. * **Description** *(string) --* The description of trust provider. * **TrustProviderType** *(string) --* The type of trust provider (user- or device-based). * **UserTrustProviderType** *(string) --* The type of user-based trust provider. * **DeviceTrustProviderType** *(string) --* The type of device-based trust provider. * **CreationTime** *(string) --* The creation time. * **LastUpdatedTime** *(string) --* The last updated time. * **Tags** *(list) --* The tags. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **FipsEnabled** *(boolean) --* Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance. * **CidrEndpointsCustomSubDomain** *(dict) --* The custom subdomain. * **SubDomain** *(string) --* The subdomain. * **Nameservers** *(list) --* The name servers. * *(string) --* EC2 / Client / create_instance_event_window create_instance_event_window **************************** EC2.Client.create_instance_event_window(**kwargs) Creates an event window in which scheduled events for the associated Amazon EC2 instances can run. You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC. You can create up to 200 event windows per Amazon Web Services Region. When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API. Warning: Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.Event windows are *not* applicable for: * Expedited scheduled events and network maintenance events. * Unscheduled maintenance such as AutoRecovery and unplanned reboots. For more information, see Define event windows for scheduled events in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_instance_event_window( DryRun=True|False, Name='string', TimeRanges=[ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], CronExpression='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The name of the event window. * **TimeRanges** (*list*) -- The time range for the event window. If you specify a time range, you can't specify a cron expression. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **CronExpression** (*string*) -- The cron expression for the event window, for example, "* 0-4,20-23 * * 1,5". If you specify a cron expression, you can't specify a time range. Constraints: * Only hour and day of the week values are supported. * For day of the week values, you can specify either integers "0" through "6", or alternative single values "SUN" through "SAT". * The minute, month, and year must be specified by "*". * The hour value must be one or a multiple range, for example, "0-4" or "0-4,20-23". * Each hour range must be >= 2 hours, for example, "0-2" or "20-23". * The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours. For more information about cron expressions, see cron on the *Wikipedia website*. * **TagSpecifications** (*list*) -- The tags to apply to the event window. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'InstanceEventWindow': { 'InstanceEventWindowId': 'string', 'TimeRanges': [ { 'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'StartHour': 123, 'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday', 'EndHour': 123 }, ], 'Name': 'string', 'CronExpression': 'string', 'AssociationTarget': { 'InstanceIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DedicatedHostIds': [ 'string', ] }, 'State': 'creating'|'deleting'|'active'|'deleted', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **InstanceEventWindow** *(dict) --* Information about the event window. * **InstanceEventWindowId** *(string) --* The ID of the event window. * **TimeRanges** *(list) --* One or more time ranges defined for the event window. * *(dict) --* The start day and time and the end day and time of the time range, in UTC. * **StartWeekDay** *(string) --* The day on which the time range begins. * **StartHour** *(integer) --* The hour when the time range begins. * **EndWeekDay** *(string) --* The day on which the time range ends. * **EndHour** *(integer) --* The hour when the time range ends. * **Name** *(string) --* The name of the event window. * **CronExpression** *(string) --* The cron expression defined for the event window. * **AssociationTarget** *(dict) --* One or more targets associated with the event window. * **InstanceIds** *(list) --* The IDs of the instances associated with the event window. * *(string) --* * **Tags** *(list) --* The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can't create tag keys beginning with "aws:", you can specify existing Amazon Web Services managed tag keys (with the "aws:" prefix) when specifying them as targets to associate with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DedicatedHostIds** *(list) --* The IDs of the Dedicated Hosts associated with the event window. * *(string) --* * **State** *(string) --* The current state of the event window. * **Tags** *(list) --* The instance tags associated with the event window. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. EC2 / Client / describe_spot_fleet_request_history describe_spot_fleet_request_history *********************************** EC2.Client.describe_spot_fleet_request_history(**kwargs) Describes the events for the specified Spot Fleet request during the specified time. Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours. For more information, see Monitor fleet events using Amazon EventBridge in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_spot_fleet_request_history( DryRun=True|False, SpotFleetRequestId='string', EventType='instanceChange'|'fleetRequestChange'|'error'|'information', StartTime=datetime(2015, 1, 1), NextToken='string', MaxResults=123 ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotFleetRequestId** (*string*) -- **[REQUIRED]** The ID of the Spot Fleet request. * **EventType** (*string*) -- The type of events to describe. By default, all events are described. * **StartTime** (*datetime*) -- **[REQUIRED]** The starting date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*< - 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. * "tag-value" - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key. * "vpc-id" - The ID of the VPC in which the EC2 Instance Connect Endpoint was created. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **InstanceConnectEndpointIds** (*list*) -- One or more EC2 Instance Connect Endpoint IDs. * *(string) --* Return type: dict Returns: **Response Syntax** { 'InstanceConnectEndpoints': [ { 'OwnerId': 'string', 'InstanceConnectEndpointId': 'string', 'InstanceConnectEndpointArn': 'string', 'State': 'create-in-progress'|'create-complete'|'create-failed'|'delete-in-progress'|'delete-complete'|'delete-failed', 'StateMessage': 'string', 'DnsName': 'string', 'FipsDnsName': 'string', 'NetworkInterfaceIds': [ 'string', ], 'VpcId': 'string', 'AvailabilityZone': 'string', 'CreatedAt': datetime(2015, 1, 1), 'SubnetId': 'string', 'PreserveClientIp': True|False, 'SecurityGroupIds': [ 'string', ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'IpAddressType': 'ipv4'|'dualstack'|'ipv6' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceConnectEndpoints** *(list) --* Information about the EC2 Instance Connect Endpoints. * *(dict) --* The EC2 Instance Connect Endpoint. * **OwnerId** *(string) --* The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint. * **InstanceConnectEndpointId** *(string) --* The ID of the EC2 Instance Connect Endpoint. * **InstanceConnectEndpointArn** *(string) --* The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint. * **State** *(string) --* The current state of the EC2 Instance Connect Endpoint. * **StateMessage** *(string) --* The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message. * **DnsName** *(string) --* The DNS name of the EC2 Instance Connect Endpoint. * **FipsDnsName** *(string) --* The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint. * **NetworkInterfaceIds** *(list) --* The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint. * *(string) --* * **VpcId** *(string) --* The ID of the VPC in which the EC2 Instance Connect Endpoint was created. * **AvailabilityZone** *(string) --* The Availability Zone of the EC2 Instance Connect Endpoint. * **CreatedAt** *(datetime) --* The date and time that the EC2 Instance Connect Endpoint was created. * **SubnetId** *(string) --* The ID of the subnet in which the EC2 Instance Connect Endpoint was created. * **PreserveClientIp** *(boolean) --* Indicates whether your client's IP address is preserved as the source. The value is "true" or "false". * If "true", your client's IP address is used when you connect to a resource. * If "false", the elastic network interface IP address is used when you connect to a resource. Default: "true" * **SecurityGroupIds** *(list) --* The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint. * *(string) --* * **Tags** *(list) --* The tags assigned to the EC2 Instance Connect Endpoint. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **IpAddressType** *(string) --* The IP address type of the endpoint. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / modify_ipam modify_ipam *********** EC2.Client.modify_ipam(**kwargs) Modify the configurations of an IPAM. See also: AWS API Documentation **Request Syntax** response = client.modify_ipam( DryRun=True|False, IpamId='string', Description='string', AddOperatingRegions=[ { 'RegionName': 'string' }, ], RemoveOperatingRegions=[ { 'RegionName': 'string' }, ], Tier='free'|'advanced', EnablePrivateGua=True|False, MeteredAccount='ipam-owner'|'resource-owner' ) Parameters: * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **IpamId** (*string*) -- **[REQUIRED]** The ID of the IPAM you want to modify. * **Description** (*string*) -- The description of the IPAM you want to modify. * **AddOperatingRegions** (*list*) -- Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **RemoveOperatingRegions** (*list*) -- The operating Regions to remove. * *(dict) --* Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide* * **RegionName** *(string) --* The name of the operating Region you want to remove. * **Tier** (*string*) -- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** (*boolean*) -- Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** (*string*) -- A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. Return type: dict Returns: **Response Syntax** { 'Ipam': { 'OwnerId': 'string', 'IpamId': 'string', 'IpamArn': 'string', 'IpamRegion': 'string', 'PublicDefaultScopeId': 'string', 'PrivateDefaultScopeId': 'string', 'ScopeCount': 123, 'Description': 'string', 'OperatingRegions': [ { 'RegionName': 'string' }, ], 'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'DefaultResourceDiscoveryId': 'string', 'DefaultResourceDiscoveryAssociationId': 'string', 'ResourceDiscoveryAssociationCount': 123, 'StateMessage': 'string', 'Tier': 'free'|'advanced', 'EnablePrivateGua': True|False, 'MeteredAccount': 'ipam-owner'|'resource-owner' } } **Response Structure** * *(dict) --* * **Ipam** *(dict) --* The results of the modification. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the IPAM. * **IpamId** *(string) --* The ID of the IPAM. * **IpamArn** *(string) --* The Amazon Resource Name (ARN) of the IPAM. * **IpamRegion** *(string) --* The Amazon Web Services Region of the IPAM. * **PublicDefaultScopeId** *(string) --* The ID of the IPAM's default public scope. * **PrivateDefaultScopeId** *(string) --* The ID of the IPAM's default private scope. * **ScopeCount** *(integer) --* The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the *Amazon VPC IPAM User Guide*. * **Description** *(string) --* The description for the IPAM. * **OperatingRegions** *(list) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * *(dict) --* The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions. For more information about operating Regions, see Create an IPAM in the *Amazon VPC IPAM User Guide*. * **RegionName** *(string) --* The name of the operating Region. * **State** *(string) --* The state of the IPAM. * **Tags** *(list) --* 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. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **DefaultResourceDiscoveryId** *(string) --* The IPAM's default resource discovery ID. * **DefaultResourceDiscoveryAssociationId** *(string) --* The IPAM's default resource discovery association ID. * **ResourceDiscoveryAssociationCount** *(integer) --* The IPAM's resource discovery association count. * **StateMessage** *(string) --* The state message. * **Tier** *(string) --* IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab. * **EnablePrivateGua** *(boolean) --* Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. * **MeteredAccount** *(string) --* A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the *Amazon VPC IPAM User Guide*. Possible values: * "ipam-owner" (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM. * "resource-owner": The Amazon Web Services account that owns the IP address is charged for the active IP address. EC2 / Client / request_spot_instances request_spot_instances ********************** EC2.Client.request_spot_instances(**kwargs) Creates a Spot Instance request. For more information, see Work with Spot Instance in the *Amazon EC2 User Guide*. Warning: We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.request_spot_instances( LaunchSpecification={ 'SecurityGroupIds': [ 'string', ], 'SecurityGroups': [ 'string', ], 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'Monitoring': { 'Enabled': True|False }, 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SubnetId': 'string', 'UserData': 'string' }, TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], InstanceInterruptionBehavior='hibernate'|'stop'|'terminate', DryRun=True|False, SpotPrice='string', ClientToken='string', InstanceCount=123, Type='one-time'|'persistent', ValidFrom=datetime(2015, 1, 1), ValidUntil=datetime(2015, 1, 1), LaunchGroup='string', AvailabilityZoneGroup='string', BlockDurationMinutes=123 ) Parameters: * **LaunchSpecification** (*dict*) -- The launch specification. * **SecurityGroupIds** *(list) --* The IDs of the security groups. * *(string) --* * **SecurityGroups** *(list) --* Not supported. * *(string) --* * **AddressingType** *(string) --* Deprecated. * **BlockDeviceMappings** *(list) --* The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **EbsOptimized** *(boolean) --* Indicates whether the instance is optimized for 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. Default: "false" * **IamInstanceProfile** *(dict) --* The IAM instance profile. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the instance profile. * **Name** *(string) --* The name of the instance profile. * **ImageId** *(string) --* The ID of the AMI. * **InstanceType** *(string) --* The instance type. Only one instance type can be specified. * **KernelId** *(string) --* The ID of the kernel. * **KeyName** *(string) --* The name of the key pair. * **Monitoring** *(dict) --* Indicates whether basic or detailed monitoring is enabled for the instance. Default: Disabled * **Enabled** *(boolean) --* **[REQUIRED]** Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. * **NetworkInterfaces** *(list) --* The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. * *(dict) --* Describes a network interface. * **AssociatePublicIpAddress** *(boolean) --* Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is "true". Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the Amazon VPC pricing page. * **DeleteOnTermination** *(boolean) --* If set to "true", the interface is deleted when the instance is terminated. You can specify "true" only if creating a new network interface when launching an instance. * **Description** *(string) --* The description of the network interface. Applies only if creating a network interface when launching an instance. * **DeviceIndex** *(integer) --* The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index. * **Groups** *(list) --* The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. * *(string) --* * **Ipv6AddressCount** *(integer) --* A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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. * **Ipv6Addresses** *(list) --* The IPv6 addresses to assign to the 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. * *(dict) --* Describes an IPv6 address. * **Ipv6Address** *(string) --* The IPv6 address. * **IsPrimaryIpv6** *(boolean) --* Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances. * **NetworkInterfaceId** *(string) --* The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification. * **PrivateIpAddress** *(string) --* The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request. * **PrivateIpAddresses** *(list) --* The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request. * *(dict) --* Describes a secondary private IPv4 address for a network interface. * **Primary** *(boolean) --* Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. * **PrivateIpAddress** *(string) --* The private IPv4 address. * **SecondaryPrivateIpAddressCount** *(integer) --* The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the "PrivateIpAddress" parameter. * **SubnetId** *(string) --* The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. * **AssociateCarrierIpAddress** *(boolean) --* Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the *Amazon Web Services Wavelength Developer Guide*. * **InterfaceType** *(string) --* The type of network interface. If you specify "efa-only", do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Valid values: "interface" | "efa" | "efa-only" * **NetworkCardIndex** *(integer) --* 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. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances. * **Ipv4Prefixes** *(list) --* The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv4PrefixCount" option. * *(dict) --* Describes the IPv4 prefix option for a network interface. * **Ipv4Prefix** *(string) --* The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the *Amazon EC2 User Guide*. * **Ipv4PrefixCount** *(integer) --* The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv4Prefix" option. * **Ipv6Prefixes** *(list) --* The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the "Ipv6PrefixCount" option. * *(dict) --* Describes the IPv6 prefix option for a network interface. * **Ipv6Prefix** *(string) --* The IPv6 prefix. * **Ipv6PrefixCount** *(integer) --* The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the "Ipv6Prefix" option. * **PrimaryIpv6** *(boolean) --* The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances. * **EnaSrdSpecification** *(dict) --* Specifies the ENA Express settings for the network interface that's attached to the instance. * **EnaSrdEnabled** *(boolean) --* Specifies whether ENA Express is enabled for the network interface when you launch an instance. * **EnaSrdUdpSpecification** *(dict) --* Contains ENA Express settings for UDP network traffic for the network interface attached to the instance. * **EnaSrdUdpEnabled** *(boolean) --* Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set **EnaSrdEnabled** in the **EnaSrdSpecificationRequest** to "true". * **ConnectionTrackingSpecification** *(dict) --* A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the *Amazon EC2 User Guide*. * **TcpEstablishedTimeout** *(integer) --* Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds. * **UdpStreamTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds. * **UdpTimeout** *(integer) --* Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds. * **EnaQueueCount** *(integer) --* The number of ENA queues to be created with the instance. * **Placement** *(dict) --* The placement information for the instance. * **AvailabilityZone** *(string) --* The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us- west-2b". * **GroupName** *(string) --* The name of the placement group. * **Tenancy** *(string) --* The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of "dedicated" runs on single-tenant hardware. The "host" tenancy is not supported for Spot Instances. * **RamdiskId** *(string) --* The ID of the RAM disk. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instance. * **UserData** *(string) --* The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. * **TagSpecifications** (*list*) -- 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. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **InstanceInterruptionBehavior** (*string*) -- The behavior when a Spot Instance is interrupted. The default is "terminate". * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **SpotPrice** (*string*) -- The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter. * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests in the *Amazon EC2 User Guide*. * **InstanceCount** (*integer*) -- The maximum number of Spot Instances to launch. Default: 1 * **Type** (*string*) -- The Spot Instance request type. Default: "one-time" * **ValidFrom** (*datetime*) -- 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** (*datetime*) -- The end date of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*<>*< - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'SecurityGroups': [ { 'GroupId': 'string', 'IpPermissionsEgress': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VpcId': 'string', 'SecurityGroupArn': 'string', 'OwnerId': 'string', 'GroupName': 'string', 'Description': 'string', 'IpPermissions': [ { 'IpProtocol': 'string', 'FromPort': 123, 'ToPort': 123, 'UserIdGroupPairs': [ { 'Description': 'string', 'UserId': 'string', 'GroupName': 'string', 'GroupId': 'string', 'VpcId': 'string', 'VpcPeeringConnectionId': 'string', 'PeeringStatus': 'string' }, ], 'IpRanges': [ { 'Description': 'string', 'CidrIp': 'string' }, ], 'Ipv6Ranges': [ { 'Description': 'string', 'CidrIpv6': 'string' }, ], 'PrefixListIds': [ { 'Description': 'string', 'PrefixListId': 'string' }, ] }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **SecurityGroups** *(list) --* Information about the security groups. * *(dict) --* Describes a security group. * **GroupId** *(string) --* The ID of the security group. * **IpPermissionsEgress** *(list) --* The outbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. * **Tags** *(list) --* Any tags assigned to the security group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VpcId** *(string) --* The ID of the VPC for the security group. * **SecurityGroupArn** *(string) --* The ARN of the security group. * **OwnerId** *(string) --* The Amazon Web Services account ID of the owner of the security group. * **GroupName** *(string) --* The name of the security group. * **Description** *(string) --* A description of the security group. * **IpPermissions** *(list) --* The inbound rules associated with the security group. * *(dict) --* Describes the permissions for a security group rule. * **IpProtocol** *(string) --* The IP protocol name ( "tcp", "udp", "icmp", "icmpv6") or number (see Protocol Numbers). Use "-1" to specify all protocols. When authorizing security group rules, specifying "-1" or a protocol number other than "tcp", "udp", "icmp", or "icmpv6" allows traffic on all ports, regardless of any port range you specify. For "tcp", "udp", and "icmp", you must specify a port range. For "icmpv6", the port range is optional; if you omit the port range, traffic for all types and codes is allowed. * **FromPort** *(integer) --* If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types). * **ToPort** *(integer) --* If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). * **UserIdGroupPairs** *(list) --* The security group and Amazon Web Services account ID pairs. * *(dict) --* Describes a security group and Amazon Web Services account ID pair. * **Description** *(string) --* A description for the security group rule that references this user ID group pair. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **UserId** *(string) --* The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. * **GroupName** *(string) --* [Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted. * **GroupId** *(string) --* The ID of the security group. * **VpcId** *(string) --* The ID of the VPC for the referenced security group, if applicable. * **VpcPeeringConnectionId** *(string) --* The ID of the VPC peering connection, if applicable. * **PeeringStatus** *(string) --* The status of a VPC peering connection, if applicable. * **IpRanges** *(list) --* The IPv4 address ranges. * *(dict) --* Describes an IPv4 address range. * **Description** *(string) --* A description for the security group rule that references this IPv4 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIp** *(string) --* The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **Ipv6Ranges** *(list) --* The IPv6 address ranges. * *(dict) --* Describes an IPv6 address range. * **Description** *(string) --* A description for the security group rule that references this IPv6 address range. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* * **CidrIpv6** *(string) --* The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length. Note: Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. * **PrefixListIds** *(list) --* The prefix list IDs. * *(dict) --* Describes a prefix list ID. * **Description** *(string) --* A description for the security group rule that references this prefix list ID. Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$* * **PrefixListId** *(string) --* The ID of the prefix. **Examples** This example describes the specified security group. response = client.describe_security_groups( GroupIds=[ 'sg-903004f8', ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } This example describes the security groups that include the specified tag (Purpose=test). response = client.describe_security_groups( Filters=[ { 'Name': 'tag:Purpose', 'Values': [ 'test', ], }, ], ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / purchase_reserved_instances_offering purchase_reserved_instances_offering ************************************ EC2.Client.purchase_reserved_instances_offering(**kwargs) Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On- Demand instance pricing. Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances. To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time. For more information, see Reserved Instances and Sell in the Reserved Instance Marketplace in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.purchase_reserved_instances_offering( InstanceCount=123, ReservedInstancesOfferingId='string', PurchaseTime=datetime(2015, 1, 1), DryRun=True|False, LimitPrice={ 'Amount': 123.0, 'CurrencyCode': 'USD' } ) Parameters: * **InstanceCount** (*integer*) -- **[REQUIRED]** The number of Reserved Instances to purchase. * **ReservedInstancesOfferingId** (*string*) -- **[REQUIRED]** The ID of the Reserved Instance offering to purchase. * **PurchaseTime** (*datetime*) -- The time at which to purchase the Reserved Instance, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'SpotInstanceRequests': [ { 'ActualBlockHourlyPrice': 'string', 'AvailabilityZoneGroup': 'string', 'BlockDurationMinutes': 123, 'CreateTime': datetime(2015, 1, 1), 'Fault': { 'Code': 'string', 'Message': 'string' }, 'InstanceId': 'string', 'LaunchGroup': 'string', 'LaunchSpecification': { 'UserData': 'string', 'AddressingType': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'EbsOptimized': True|False, 'IamInstanceProfile': { 'Arn': 'string', 'Name': 'string' }, 'ImageId': 'string', 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'KernelId': 'string', 'KeyName': 'string', 'NetworkInterfaces': [ { 'AssociatePublicIpAddress': True|False, 'DeleteOnTermination': True|False, 'Description': 'string', 'DeviceIndex': 123, 'Groups': [ 'string', ], 'Ipv6AddressCount': 123, 'Ipv6Addresses': [ { 'Ipv6Address': 'string', 'IsPrimaryIpv6': True|False }, ], 'NetworkInterfaceId': 'string', 'PrivateIpAddress': 'string', 'PrivateIpAddresses': [ { 'Primary': True|False, 'PrivateIpAddress': 'string' }, ], 'SecondaryPrivateIpAddressCount': 123, 'SubnetId': 'string', 'AssociateCarrierIpAddress': True|False, 'InterfaceType': 'string', 'NetworkCardIndex': 123, 'Ipv4Prefixes': [ { 'Ipv4Prefix': 'string' }, ], 'Ipv4PrefixCount': 123, 'Ipv6Prefixes': [ { 'Ipv6Prefix': 'string' }, ], 'Ipv6PrefixCount': 123, 'PrimaryIpv6': True|False, 'EnaSrdSpecification': { 'EnaSrdEnabled': True|False, 'EnaSrdUdpSpecification': { 'EnaSrdUdpEnabled': True|False } }, 'ConnectionTrackingSpecification': { 'TcpEstablishedTimeout': 123, 'UdpStreamTimeout': 123, 'UdpTimeout': 123 }, 'EnaQueueCount': 123 }, ], 'Placement': { 'AvailabilityZone': 'string', 'GroupName': 'string', 'Tenancy': 'default'|'dedicated'|'host' }, 'RamdiskId': 'string', 'SubnetId': 'string', 'SecurityGroups': [ { 'GroupId': 'string', 'GroupName': 'string' }, ], 'Monitoring': { 'Enabled': True|False } }, 'LaunchedAvailabilityZone': 'string', 'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)', 'SpotInstanceRequestId': 'string', 'SpotPrice': 'string', 'State': 'open'|'active'|'closed'|'cancelled'|'failed'|'disabled', 'Status': { 'Code': 'string', 'Message': 'string', 'UpdateTime': datetime(2015, 1, 1) }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Type': 'one-time'|'persistent', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the output of DescribeSpotInstanceRequests. * **SpotInstanceRequests** *(list) --* The Spot Instance requests. * *(dict) --* Describes a Spot Instance request. * **ActualBlockHourlyPrice** *(string) --* Deprecated. * **AvailabilityZoneGroup** *(string) --* The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. * **BlockDurationMinutes** *(integer) --* Deprecated. * **CreateTime** *(datetime) --* The date and time when the Spot Instance request was created, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*<>*<>*<>*<" - 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Images': [ { 'PlatformDetails': 'string', 'UsageOperation': 'string', 'BlockDeviceMappings': [ { 'Ebs': { 'DeleteOnTermination': True|False, 'Iops': 123, 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'KmsKeyId': 'string', 'Throughput': 123, 'OutpostArn': 'string', 'AvailabilityZone': 'string', 'Encrypted': True|False, 'VolumeInitializationRate': 123, 'AvailabilityZoneId': 'string' }, 'NoDevice': 'string', 'DeviceName': 'string', 'VirtualName': 'string' }, ], 'Description': 'string', 'EnaSupport': True|False, 'Hypervisor': 'ovm'|'xen', 'ImageOwnerAlias': 'string', 'Name': 'string', 'RootDeviceName': 'string', 'RootDeviceType': 'ebs'|'instance-store', 'SriovNetSupport': 'string', 'StateReason': { 'Code': 'string', 'Message': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VirtualizationType': 'hvm'|'paravirtual', 'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred', 'TpmSupport': 'v2.0', 'DeprecationTime': 'string', 'ImdsSupport': 'v2.0', 'SourceInstanceId': 'string', 'DeregistrationProtection': 'string', 'LastLaunchedTime': 'string', 'ImageAllowed': True|False, 'SourceImageId': 'string', 'SourceImageRegion': 'string', 'FreeTierEligible': True|False, 'ImageId': 'string', 'ImageLocation': 'string', 'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error'|'disabled', 'OwnerId': 'string', 'CreationDate': 'string', 'Public': True|False, 'ProductCodes': [ { 'ProductCodeId': 'string', 'ProductCodeType': 'devpay'|'marketplace' }, ], 'Architecture': 'i386'|'x86_64'|'arm64'|'x86_64_mac'|'arm64_mac', 'ImageType': 'machine'|'kernel'|'ramdisk', 'KernelId': 'string', 'RamdiskId': 'string', 'Platform': 'Windows' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Images** *(list) --* Information about the images. * *(dict) --* Describes an image. * **PlatformDetails** *(string) --* The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the *Amazon EC2 User Guide*. * **UsageOperation** *(string) --* The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. "usageOperation" corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the **Instances** or **AMIs** pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI. * **BlockDeviceMappings** *(list) --* Any block device mapping entries. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the *Amazon EC2 User Guide*. * **Iops** *(integer) --* 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 - 256,000 IOPS For "io2" volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for "io1" and "io2" volumes. The default for "gp3" volumes is 3,000 IOPS. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* 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 sizes for each volume type: * "gp2" and "gp3": 1 - 16,384 GiB * "io1": 4 - 16,384 GiB * "io2": 4 - 65,536 GiB * "st1" and "sc1": 125 - 16,384 GiB * "standard": 1 - 1024 GiB * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on "BlockDeviceMapping" objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. This parameter is valid only for "gp3" volumes. Valid Range: Minimum value of 125. Maximum value of 1000. * **OutpostArn** *(string) --* The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage. * **AvailabilityZone** *(string) --* The Availability Zone where the EBS volume will be created (for example, "us-east-1a"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **Encrypted** *(boolean) --* Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 Amazon EBS encryption in the *Amazon EBS User Guide*. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating. * If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either "true" for an encrypted volume, or "false" for an unencrypted volume. If you omit this parameter, it defaults to "false" (unencrypted). * If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify. * If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify "false". If you specify "true", the request will fail. In this case, we recommend that you omit the parameter. * If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either "true" or "false". However, if you specify "false", the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter. * **VolumeInitializationRate** *(integer) --* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: * You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. Note: If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. * You want to create a volume that is initialized at the default rate. For more information, see Initialize Amazon EBS volumes in the *Amazon EC2 User Guide*. This parameter is not supported when using CreateImage. Valid range: 100 - 300 MiB/s * **AvailabilityZoneId** *(string) --* The ID of the Availability Zone where the EBS volume will be created (for example, "use1-az1"). Either "AvailabilityZone" or "AvailabilityZoneId" can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances. * **NoDevice** *(string) --* To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name ( "ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0" and "ephemeral1". The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. * **Description** *(string) --* The description of the AMI that was provided during image creation. * **EnaSupport** *(boolean) --* Specifies whether enhanced networking with ENA is enabled. * **Hypervisor** *(string) --* The hypervisor type of the image. Only "xen" is supported. "ovm" is not supported. * **ImageOwnerAlias** *(string) --* The owner alias ( "amazon" | "aws-backup-vault" | "aws- marketplace"). * **Name** *(string) --* The name of the AMI that was provided during image creation. * **RootDeviceName** *(string) --* The device name of the root device volume (for example, "/dev/sda1"). * **RootDeviceType** *(string) --* The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume. * **SriovNetSupport** *(string) --* Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. * **StateReason** *(dict) --* The reason for the state change. * **Code** *(string) --* The reason code for the state change. * **Message** *(string) --* The message for the state change. * "Server.InsufficientInstanceCapacity": There was insufficient capacity available to satisfy the launch request. * "Server.InternalError": An internal error caused the instance to terminate during launch. * "Server.ScheduledStop": The instance was stopped due to a scheduled retirement. * "Server.SpotInstanceShutdown": The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Server.SpotInstanceTermination": The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price. * "Client.InstanceInitiatedShutdown": The instance was shut down from the operating system of the instance. * "Client.InstanceTerminated": The instance was terminated or rebooted during AMI creation. * "Client.InternalError": A client error caused the instance to terminate during launch. * "Client.InvalidSnapshot.NotFound": The specified snapshot was not found. * "Client.UserInitiatedHibernate": Hibernation was initiated on the instance. * "Client.UserInitiatedShutdown": The instance was shut down using the Amazon EC2 API. * "Client.VolumeLimitExceeded": The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits. * **Tags** *(list) --* Any tags assigned to the image. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VirtualizationType** *(string) --* The type of virtualization of the AMI. * **BootMode** *(string) --* The boot mode of the image. For more information, see Instance launch behavior with Amazon EC2 boot modes in the *Amazon EC2 User Guide*. * **TpmSupport** *(string) --* If the image is configured for NitroTPM support, the value is "v2.0". For more information, see NitroTPM in the *Amazon EC2 User Guide*. * **DeprecationTime** *(string) --* The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<" - 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. * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PlacementGroups': [ { 'GroupName': 'string', 'State': 'pending'|'available'|'deleting'|'deleted', 'Strategy': 'cluster'|'spread'|'partition', 'PartitionCount': 123, 'GroupId': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'GroupArn': 'string', 'SpreadLevel': 'host'|'rack' }, ] } **Response Structure** * *(dict) --* * **PlacementGroups** *(list) --* Information about the placement groups. * *(dict) --* Describes a placement group. * **GroupName** *(string) --* The name of the placement group. * **State** *(string) --* The state of the placement group. * **Strategy** *(string) --* The placement strategy. * **PartitionCount** *(integer) --* The number of partitions. Valid only if **strategy** is set to "partition". * **GroupId** *(string) --* The ID of the placement group. * **Tags** *(list) --* Any tags applied to the placement group. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **GroupArn** *(string) --* The Amazon Resource Name (ARN) of the placement group. * **SpreadLevel** *(string) --* The spread level for the placement group. *Only* Outpost placement groups can be spread across hosts. EC2 / Client / describe_fleets describe_fleets *************** EC2.Client.describe_fleets(**kwargs) Describes the specified EC2 Fleet or all of your EC2 Fleets. Warning: If a fleet is of type "instant", you must specify the fleet ID in the request, otherwise the fleet does not appear in the response. For more information, see Describe your EC2 Fleet in the *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_fleets( DryRun=True|False, MaxResults=123, NextToken='string', FleetIds=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ] ) Parameters: * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **FleetIds** (*list*) -- The IDs of the EC2 Fleets. Note: If a fleet is of type "instant", you must specify the fleet ID, otherwise it does not appear in the response. * *(string) --* * **Filters** (*list*) -- 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Fleets': [ { 'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled', 'CreateTime': datetime(2015, 1, 1), 'FleetId': 'string', 'FleetState': 'submitted'|'active'|'deleted'|'failed'|'deleted_running'|'deleted_terminating'|'modifying', 'ClientToken': 'string', 'ExcessCapacityTerminationPolicy': 'no-termination'|'termination', 'FulfilledCapacity': 123.0, 'FulfilledOnDemandCapacity': 123.0, 'LaunchTemplateConfigs': [ { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': [ { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] }, ] }, ], 'TargetCapacitySpecification': { 'TotalTargetCapacity': 123, 'OnDemandTargetCapacity': 123, 'SpotTargetCapacity': 123, 'DefaultTargetCapacityType': 'spot'|'on-demand'|'capacity-block', 'TargetCapacityUnitType': 'vcpu'|'memory-mib'|'units' }, 'TerminateInstancesWithExpiration': True|False, 'Type': 'request'|'maintain'|'instant', 'ValidFrom': datetime(2015, 1, 1), 'ValidUntil': datetime(2015, 1, 1), 'ReplaceUnhealthyInstances': True|False, 'SpotOptions': { 'AllocationStrategy': 'lowest-price'|'diversified'|'capacity-optimized'|'capacity-optimized-prioritized'|'price-capacity-optimized', 'MaintenanceStrategies': { 'CapacityRebalance': { 'ReplacementStrategy': 'launch'|'launch-before-terminate', 'TerminationDelay': 123 } }, 'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate', 'InstancePoolsToUseCount': 123, 'SingleInstanceType': True|False, 'SingleAvailabilityZone': True|False, 'MinTargetCapacity': 123, 'MaxTotalPrice': 'string' }, 'OnDemandOptions': { 'AllocationStrategy': 'lowest-price'|'prioritized', 'CapacityReservationOptions': { 'UsageStrategy': 'use-capacity-reservations-first' }, 'SingleInstanceType': True|False, 'SingleAvailabilityZone': True|False, 'MinTargetCapacity': 123, 'MaxTotalPrice': 'string' }, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'Errors': [ { 'LaunchTemplateAndOverrides': { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] } }, 'Lifecycle': 'spot'|'on-demand', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'Instances': [ { 'LaunchTemplateAndOverrides': { 'LaunchTemplateSpecification': { 'LaunchTemplateId': 'string', 'LaunchTemplateName': 'string', 'Version': 'string' }, 'Overrides': { 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'MaxPrice': 'string', 'SubnetId': 'string', 'AvailabilityZone': 'string', 'WeightedCapacity': 123.0, 'Priority': 123.0, 'Placement': { 'GroupName': 'string' }, 'InstanceRequirements': { 'VCpuCount': { 'Min': 123, 'Max': 123 }, 'MemoryMiB': { 'Min': 123, 'Max': 123 }, 'CpuManufacturers': [ 'intel'|'amd'|'amazon-web-services'|'apple', ], 'MemoryGiBPerVCpu': { 'Min': 123.0, 'Max': 123.0 }, 'ExcludedInstanceTypes': [ 'string', ], 'InstanceGenerations': [ 'current'|'previous', ], 'SpotMaxPricePercentageOverLowestPrice': 123, 'OnDemandMaxPricePercentageOverLowestPrice': 123, 'BareMetal': 'included'|'required'|'excluded', 'BurstablePerformance': 'included'|'required'|'excluded', 'RequireHibernateSupport': True|False, 'NetworkInterfaceCount': { 'Min': 123, 'Max': 123 }, 'LocalStorage': 'included'|'required'|'excluded', 'LocalStorageTypes': [ 'hdd'|'ssd', ], 'TotalLocalStorageGB': { 'Min': 123.0, 'Max': 123.0 }, 'BaselineEbsBandwidthMbps': { 'Min': 123, 'Max': 123 }, 'AcceleratorTypes': [ 'gpu'|'fpga'|'inference', ], 'AcceleratorCount': { 'Min': 123, 'Max': 123 }, 'AcceleratorManufacturers': [ 'amazon-web-services'|'amd'|'nvidia'|'xilinx'|'habana', ], 'AcceleratorNames': [ 'a100'|'inferentia'|'k520'|'k80'|'m60'|'radeon-pro-v520'|'t4'|'vu9p'|'v100'|'a10g'|'h100'|'t4g', ], 'AcceleratorTotalMemoryMiB': { 'Min': 123, 'Max': 123 }, 'NetworkBandwidthGbps': { 'Min': 123.0, 'Max': 123.0 }, 'AllowedInstanceTypes': [ 'string', ], 'MaxSpotPriceAsPercentageOfOptimalOnDemandPrice': 123, 'BaselinePerformanceFactors': { 'Cpu': { 'References': [ { 'InstanceFamily': 'string' }, ] } } }, 'ImageId': 'string', 'BlockDeviceMappings': [ { 'DeviceName': 'string', 'VirtualName': 'string', 'Ebs': { 'Encrypted': True|False, 'DeleteOnTermination': True|False, 'Iops': 123, 'Throughput': 123, 'KmsKeyId': 'string', 'SnapshotId': 'string', 'VolumeSize': 123, 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3' }, 'NoDevice': 'string' }, ] } }, 'Lifecycle': 'spot'|'on-demand', 'InstanceIds': [ 'string', ], 'InstanceType': 'a1.medium'|'a1.large'|'a1.xlarge'|'a1.2xlarge'|'a1.4xlarge'|'a1.metal'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5.metal'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'c5ad.large'|'c5ad.xlarge'|'c5ad.2xlarge'|'c5ad.4xlarge'|'c5ad.8xlarge'|'c5ad.12xlarge'|'c5ad.16xlarge'|'c5ad.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c5d.metal'|'c5n.large'|'c5n.xlarge'|'c5n.2xlarge'|'c5n.4xlarge'|'c5n.9xlarge'|'c5n.18xlarge'|'c5n.metal'|'c6g.medium'|'c6g.large'|'c6g.xlarge'|'c6g.2xlarge'|'c6g.4xlarge'|'c6g.8xlarge'|'c6g.12xlarge'|'c6g.16xlarge'|'c6g.metal'|'c6gd.medium'|'c6gd.large'|'c6gd.xlarge'|'c6gd.2xlarge'|'c6gd.4xlarge'|'c6gd.8xlarge'|'c6gd.12xlarge'|'c6gd.16xlarge'|'c6gd.metal'|'c6gn.medium'|'c6gn.large'|'c6gn.xlarge'|'c6gn.2xlarge'|'c6gn.4xlarge'|'c6gn.8xlarge'|'c6gn.12xlarge'|'c6gn.16xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'c6i.32xlarge'|'c6i.metal'|'cc1.4xlarge'|'cc2.8xlarge'|'cg1.4xlarge'|'cr1.8xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'d3.xlarge'|'d3.2xlarge'|'d3.4xlarge'|'d3.8xlarge'|'d3en.xlarge'|'d3en.2xlarge'|'d3en.4xlarge'|'d3en.6xlarge'|'d3en.8xlarge'|'d3en.12xlarge'|'dl1.24xlarge'|'f1.2xlarge'|'f1.4xlarge'|'f1.16xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'g3s.xlarge'|'g4ad.xlarge'|'g4ad.2xlarge'|'g4ad.4xlarge'|'g4ad.8xlarge'|'g4ad.16xlarge'|'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g4dn.metal'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.12xlarge'|'g5.16xlarge'|'g5.24xlarge'|'g5.48xlarge'|'g5g.xlarge'|'g5g.2xlarge'|'g5g.4xlarge'|'g5g.8xlarge'|'g5g.16xlarge'|'g5g.metal'|'hi1.4xlarge'|'hpc6a.48xlarge'|'hs1.8xlarge'|'h1.2xlarge'|'h1.4xlarge'|'h1.8xlarge'|'h1.16xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'i3.metal'|'i3en.large'|'i3en.xlarge'|'i3en.2xlarge'|'i3en.3xlarge'|'i3en.6xlarge'|'i3en.12xlarge'|'i3en.24xlarge'|'i3en.metal'|'im4gn.large'|'im4gn.xlarge'|'im4gn.2xlarge'|'im4gn.4xlarge'|'im4gn.8xlarge'|'im4gn.16xlarge'|'inf1.xlarge'|'inf1.2xlarge'|'inf1.6xlarge'|'inf1.24xlarge'|'is4gen.medium'|'is4gen.large'|'is4gen.xlarge'|'is4gen.2xlarge'|'is4gen.4xlarge'|'is4gen.8xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5.metal'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'m5ad.large'|'m5ad.xlarge'|'m5ad.2xlarge'|'m5ad.4xlarge'|'m5ad.8xlarge'|'m5ad.12xlarge'|'m5ad.16xlarge'|'m5ad.24xlarge'|'m5d.large'|'m5d.xlarge'|'m5d.2xlarge'|'m5d.4xlarge'|'m5d.8xlarge'|'m5d.12xlarge'|'m5d.16xlarge'|'m5d.24xlarge'|'m5d.metal'|'m5dn.large'|'m5dn.xlarge'|'m5dn.2xlarge'|'m5dn.4xlarge'|'m5dn.8xlarge'|'m5dn.12xlarge'|'m5dn.16xlarge'|'m5dn.24xlarge'|'m5dn.metal'|'m5n.large'|'m5n.xlarge'|'m5n.2xlarge'|'m5n.4xlarge'|'m5n.8xlarge'|'m5n.12xlarge'|'m5n.16xlarge'|'m5n.24xlarge'|'m5n.metal'|'m5zn.large'|'m5zn.xlarge'|'m5zn.2xlarge'|'m5zn.3xlarge'|'m5zn.6xlarge'|'m5zn.12xlarge'|'m5zn.metal'|'m6a.large'|'m6a.xlarge'|'m6a.2xlarge'|'m6a.4xlarge'|'m6a.8xlarge'|'m6a.12xlarge'|'m6a.16xlarge'|'m6a.24xlarge'|'m6a.32xlarge'|'m6a.48xlarge'|'m6g.metal'|'m6g.medium'|'m6g.large'|'m6g.xlarge'|'m6g.2xlarge'|'m6g.4xlarge'|'m6g.8xlarge'|'m6g.12xlarge'|'m6g.16xlarge'|'m6gd.metal'|'m6gd.medium'|'m6gd.large'|'m6gd.xlarge'|'m6gd.2xlarge'|'m6gd.4xlarge'|'m6gd.8xlarge'|'m6gd.12xlarge'|'m6gd.16xlarge'|'m6i.large'|'m6i.xlarge'|'m6i.2xlarge'|'m6i.4xlarge'|'m6i.8xlarge'|'m6i.12xlarge'|'m6i.16xlarge'|'m6i.24xlarge'|'m6i.32xlarge'|'m6i.metal'|'mac1.metal'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'p3dn.24xlarge'|'p4d.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5.metal'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'r5ad.large'|'r5ad.xlarge'|'r5ad.2xlarge'|'r5ad.4xlarge'|'r5ad.8xlarge'|'r5ad.12xlarge'|'r5ad.16xlarge'|'r5ad.24xlarge'|'r5b.large'|'r5b.xlarge'|'r5b.2xlarge'|'r5b.4xlarge'|'r5b.8xlarge'|'r5b.12xlarge'|'r5b.16xlarge'|'r5b.24xlarge'|'r5b.metal'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge'|'r5d.metal'|'r5dn.large'|'r5dn.xlarge'|'r5dn.2xlarge'|'r5dn.4xlarge'|'r5dn.8xlarge'|'r5dn.12xlarge'|'r5dn.16xlarge'|'r5dn.24xlarge'|'r5dn.metal'|'r5n.large'|'r5n.xlarge'|'r5n.2xlarge'|'r5n.4xlarge'|'r5n.8xlarge'|'r5n.12xlarge'|'r5n.16xlarge'|'r5n.24xlarge'|'r5n.metal'|'r6g.medium'|'r6g.large'|'r6g.xlarge'|'r6g.2xlarge'|'r6g.4xlarge'|'r6g.8xlarge'|'r6g.12xlarge'|'r6g.16xlarge'|'r6g.metal'|'r6gd.medium'|'r6gd.large'|'r6gd.xlarge'|'r6gd.2xlarge'|'r6gd.4xlarge'|'r6gd.8xlarge'|'r6gd.12xlarge'|'r6gd.16xlarge'|'r6gd.metal'|'r6i.large'|'r6i.xlarge'|'r6i.2xlarge'|'r6i.4xlarge'|'r6i.8xlarge'|'r6i.12xlarge'|'r6i.16xlarge'|'r6i.24xlarge'|'r6i.32xlarge'|'r6i.metal'|'t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'t3.nano'|'t3.micro'|'t3.small'|'t3.medium'|'t3.large'|'t3.xlarge'|'t3.2xlarge'|'t3a.nano'|'t3a.micro'|'t3a.small'|'t3a.medium'|'t3a.large'|'t3a.xlarge'|'t3a.2xlarge'|'t4g.nano'|'t4g.micro'|'t4g.small'|'t4g.medium'|'t4g.large'|'t4g.xlarge'|'t4g.2xlarge'|'u-6tb1.56xlarge'|'u-6tb1.112xlarge'|'u-9tb1.112xlarge'|'u-12tb1.112xlarge'|'u-6tb1.metal'|'u-9tb1.metal'|'u-12tb1.metal'|'u-18tb1.metal'|'u-24tb1.metal'|'vt1.3xlarge'|'vt1.6xlarge'|'vt1.24xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'x2iezn.2xlarge'|'x2iezn.4xlarge'|'x2iezn.6xlarge'|'x2iezn.8xlarge'|'x2iezn.12xlarge'|'x2iezn.metal'|'x2gd.medium'|'x2gd.large'|'x2gd.xlarge'|'x2gd.2xlarge'|'x2gd.4xlarge'|'x2gd.8xlarge'|'x2gd.12xlarge'|'x2gd.16xlarge'|'x2gd.metal'|'z1d.large'|'z1d.xlarge'|'z1d.2xlarge'|'z1d.3xlarge'|'z1d.6xlarge'|'z1d.12xlarge'|'z1d.metal'|'x2idn.16xlarge'|'x2idn.24xlarge'|'x2idn.32xlarge'|'x2iedn.xlarge'|'x2iedn.2xlarge'|'x2iedn.4xlarge'|'x2iedn.8xlarge'|'x2iedn.16xlarge'|'x2iedn.24xlarge'|'x2iedn.32xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6a.32xlarge'|'c6a.48xlarge'|'c6a.metal'|'m6a.metal'|'i4i.large'|'i4i.xlarge'|'i4i.2xlarge'|'i4i.4xlarge'|'i4i.8xlarge'|'i4i.16xlarge'|'i4i.32xlarge'|'i4i.metal'|'x2idn.metal'|'x2iedn.metal'|'c7g.medium'|'c7g.large'|'c7g.xlarge'|'c7g.2xlarge'|'c7g.4xlarge'|'c7g.8xlarge'|'c7g.12xlarge'|'c7g.16xlarge'|'mac2.metal'|'c6id.large'|'c6id.xlarge'|'c6id.2xlarge'|'c6id.4xlarge'|'c6id.8xlarge'|'c6id.12xlarge'|'c6id.16xlarge'|'c6id.24xlarge'|'c6id.32xlarge'|'c6id.metal'|'m6id.large'|'m6id.xlarge'|'m6id.2xlarge'|'m6id.4xlarge'|'m6id.8xlarge'|'m6id.12xlarge'|'m6id.16xlarge'|'m6id.24xlarge'|'m6id.32xlarge'|'m6id.metal'|'r6id.large'|'r6id.xlarge'|'r6id.2xlarge'|'r6id.4xlarge'|'r6id.8xlarge'|'r6id.12xlarge'|'r6id.16xlarge'|'r6id.24xlarge'|'r6id.32xlarge'|'r6id.metal'|'r6a.large'|'r6a.xlarge'|'r6a.2xlarge'|'r6a.4xlarge'|'r6a.8xlarge'|'r6a.12xlarge'|'r6a.16xlarge'|'r6a.24xlarge'|'r6a.32xlarge'|'r6a.48xlarge'|'r6a.metal'|'p4de.24xlarge'|'u-3tb1.56xlarge'|'u-18tb1.112xlarge'|'u-24tb1.112xlarge'|'trn1.2xlarge'|'trn1.32xlarge'|'hpc6id.32xlarge'|'c6in.large'|'c6in.xlarge'|'c6in.2xlarge'|'c6in.4xlarge'|'c6in.8xlarge'|'c6in.12xlarge'|'c6in.16xlarge'|'c6in.24xlarge'|'c6in.32xlarge'|'m6in.large'|'m6in.xlarge'|'m6in.2xlarge'|'m6in.4xlarge'|'m6in.8xlarge'|'m6in.12xlarge'|'m6in.16xlarge'|'m6in.24xlarge'|'m6in.32xlarge'|'m6idn.large'|'m6idn.xlarge'|'m6idn.2xlarge'|'m6idn.4xlarge'|'m6idn.8xlarge'|'m6idn.12xlarge'|'m6idn.16xlarge'|'m6idn.24xlarge'|'m6idn.32xlarge'|'r6in.large'|'r6in.xlarge'|'r6in.2xlarge'|'r6in.4xlarge'|'r6in.8xlarge'|'r6in.12xlarge'|'r6in.16xlarge'|'r6in.24xlarge'|'r6in.32xlarge'|'r6idn.large'|'r6idn.xlarge'|'r6idn.2xlarge'|'r6idn.4xlarge'|'r6idn.8xlarge'|'r6idn.12xlarge'|'r6idn.16xlarge'|'r6idn.24xlarge'|'r6idn.32xlarge'|'c7g.metal'|'m7g.medium'|'m7g.large'|'m7g.xlarge'|'m7g.2xlarge'|'m7g.4xlarge'|'m7g.8xlarge'|'m7g.12xlarge'|'m7g.16xlarge'|'m7g.metal'|'r7g.medium'|'r7g.large'|'r7g.xlarge'|'r7g.2xlarge'|'r7g.4xlarge'|'r7g.8xlarge'|'r7g.12xlarge'|'r7g.16xlarge'|'r7g.metal'|'c6in.metal'|'m6in.metal'|'m6idn.metal'|'r6in.metal'|'r6idn.metal'|'inf2.xlarge'|'inf2.8xlarge'|'inf2.24xlarge'|'inf2.48xlarge'|'trn1n.32xlarge'|'i4g.large'|'i4g.xlarge'|'i4g.2xlarge'|'i4g.4xlarge'|'i4g.8xlarge'|'i4g.16xlarge'|'hpc7g.4xlarge'|'hpc7g.8xlarge'|'hpc7g.16xlarge'|'c7gn.medium'|'c7gn.large'|'c7gn.xlarge'|'c7gn.2xlarge'|'c7gn.4xlarge'|'c7gn.8xlarge'|'c7gn.12xlarge'|'c7gn.16xlarge'|'p5.48xlarge'|'m7i.large'|'m7i.xlarge'|'m7i.2xlarge'|'m7i.4xlarge'|'m7i.8xlarge'|'m7i.12xlarge'|'m7i.16xlarge'|'m7i.24xlarge'|'m7i.48xlarge'|'m7i-flex.large'|'m7i-flex.xlarge'|'m7i-flex.2xlarge'|'m7i-flex.4xlarge'|'m7i-flex.8xlarge'|'m7a.medium'|'m7a.large'|'m7a.xlarge'|'m7a.2xlarge'|'m7a.4xlarge'|'m7a.8xlarge'|'m7a.12xlarge'|'m7a.16xlarge'|'m7a.24xlarge'|'m7a.32xlarge'|'m7a.48xlarge'|'m7a.metal-48xl'|'hpc7a.12xlarge'|'hpc7a.24xlarge'|'hpc7a.48xlarge'|'hpc7a.96xlarge'|'c7gd.medium'|'c7gd.large'|'c7gd.xlarge'|'c7gd.2xlarge'|'c7gd.4xlarge'|'c7gd.8xlarge'|'c7gd.12xlarge'|'c7gd.16xlarge'|'m7gd.medium'|'m7gd.large'|'m7gd.xlarge'|'m7gd.2xlarge'|'m7gd.4xlarge'|'m7gd.8xlarge'|'m7gd.12xlarge'|'m7gd.16xlarge'|'r7gd.medium'|'r7gd.large'|'r7gd.xlarge'|'r7gd.2xlarge'|'r7gd.4xlarge'|'r7gd.8xlarge'|'r7gd.12xlarge'|'r7gd.16xlarge'|'r7a.medium'|'r7a.large'|'r7a.xlarge'|'r7a.2xlarge'|'r7a.4xlarge'|'r7a.8xlarge'|'r7a.12xlarge'|'r7a.16xlarge'|'r7a.24xlarge'|'r7a.32xlarge'|'r7a.48xlarge'|'c7i.large'|'c7i.xlarge'|'c7i.2xlarge'|'c7i.4xlarge'|'c7i.8xlarge'|'c7i.12xlarge'|'c7i.16xlarge'|'c7i.24xlarge'|'c7i.48xlarge'|'mac2-m2pro.metal'|'r7iz.large'|'r7iz.xlarge'|'r7iz.2xlarge'|'r7iz.4xlarge'|'r7iz.8xlarge'|'r7iz.12xlarge'|'r7iz.16xlarge'|'r7iz.32xlarge'|'c7a.medium'|'c7a.large'|'c7a.xlarge'|'c7a.2xlarge'|'c7a.4xlarge'|'c7a.8xlarge'|'c7a.12xlarge'|'c7a.16xlarge'|'c7a.24xlarge'|'c7a.32xlarge'|'c7a.48xlarge'|'c7a.metal-48xl'|'r7a.metal-48xl'|'r7i.large'|'r7i.xlarge'|'r7i.2xlarge'|'r7i.4xlarge'|'r7i.8xlarge'|'r7i.12xlarge'|'r7i.16xlarge'|'r7i.24xlarge'|'r7i.48xlarge'|'dl2q.24xlarge'|'mac2-m2.metal'|'i4i.12xlarge'|'i4i.24xlarge'|'c7i.metal-24xl'|'c7i.metal-48xl'|'m7i.metal-24xl'|'m7i.metal-48xl'|'r7i.metal-24xl'|'r7i.metal-48xl'|'r7iz.metal-16xl'|'r7iz.metal-32xl'|'c7gd.metal'|'m7gd.metal'|'r7gd.metal'|'g6.xlarge'|'g6.2xlarge'|'g6.4xlarge'|'g6.8xlarge'|'g6.12xlarge'|'g6.16xlarge'|'g6.24xlarge'|'g6.48xlarge'|'gr6.4xlarge'|'gr6.8xlarge'|'c7i-flex.large'|'c7i-flex.xlarge'|'c7i-flex.2xlarge'|'c7i-flex.4xlarge'|'c7i-flex.8xlarge'|'u7i-12tb.224xlarge'|'u7in-16tb.224xlarge'|'u7in-24tb.224xlarge'|'u7in-32tb.224xlarge'|'u7ib-12tb.224xlarge'|'c7gn.metal'|'r8g.medium'|'r8g.large'|'r8g.xlarge'|'r8g.2xlarge'|'r8g.4xlarge'|'r8g.8xlarge'|'r8g.12xlarge'|'r8g.16xlarge'|'r8g.24xlarge'|'r8g.48xlarge'|'r8g.metal-24xl'|'r8g.metal-48xl'|'mac2-m1ultra.metal'|'g6e.xlarge'|'g6e.2xlarge'|'g6e.4xlarge'|'g6e.8xlarge'|'g6e.12xlarge'|'g6e.16xlarge'|'g6e.24xlarge'|'g6e.48xlarge'|'c8g.medium'|'c8g.large'|'c8g.xlarge'|'c8g.2xlarge'|'c8g.4xlarge'|'c8g.8xlarge'|'c8g.12xlarge'|'c8g.16xlarge'|'c8g.24xlarge'|'c8g.48xlarge'|'c8g.metal-24xl'|'c8g.metal-48xl'|'m8g.medium'|'m8g.large'|'m8g.xlarge'|'m8g.2xlarge'|'m8g.4xlarge'|'m8g.8xlarge'|'m8g.12xlarge'|'m8g.16xlarge'|'m8g.24xlarge'|'m8g.48xlarge'|'m8g.metal-24xl'|'m8g.metal-48xl'|'x8g.medium'|'x8g.large'|'x8g.xlarge'|'x8g.2xlarge'|'x8g.4xlarge'|'x8g.8xlarge'|'x8g.12xlarge'|'x8g.16xlarge'|'x8g.24xlarge'|'x8g.48xlarge'|'x8g.metal-24xl'|'x8g.metal-48xl'|'i7ie.large'|'i7ie.xlarge'|'i7ie.2xlarge'|'i7ie.3xlarge'|'i7ie.6xlarge'|'i7ie.12xlarge'|'i7ie.18xlarge'|'i7ie.24xlarge'|'i7ie.48xlarge'|'i8g.large'|'i8g.xlarge'|'i8g.2xlarge'|'i8g.4xlarge'|'i8g.8xlarge'|'i8g.12xlarge'|'i8g.16xlarge'|'i8g.24xlarge'|'i8g.metal-24xl'|'u7i-6tb.112xlarge'|'u7i-8tb.112xlarge'|'u7inh-32tb.480xlarge'|'p5e.48xlarge'|'p5en.48xlarge'|'f2.12xlarge'|'f2.48xlarge'|'trn2.48xlarge'|'c7i-flex.12xlarge'|'c7i-flex.16xlarge'|'m7i-flex.12xlarge'|'m7i-flex.16xlarge'|'i7ie.metal-24xl'|'i7ie.metal-48xl'|'i8g.48xlarge'|'c8gd.medium'|'c8gd.large'|'c8gd.xlarge'|'c8gd.2xlarge'|'c8gd.4xlarge'|'c8gd.8xlarge'|'c8gd.12xlarge'|'c8gd.16xlarge'|'c8gd.24xlarge'|'c8gd.48xlarge'|'c8gd.metal-24xl'|'c8gd.metal-48xl'|'i7i.large'|'i7i.xlarge'|'i7i.2xlarge'|'i7i.4xlarge'|'i7i.8xlarge'|'i7i.12xlarge'|'i7i.16xlarge'|'i7i.24xlarge'|'i7i.48xlarge'|'i7i.metal-24xl'|'i7i.metal-48xl'|'p6-b200.48xlarge'|'m8gd.medium'|'m8gd.large'|'m8gd.xlarge'|'m8gd.2xlarge'|'m8gd.4xlarge'|'m8gd.8xlarge'|'m8gd.12xlarge'|'m8gd.16xlarge'|'m8gd.24xlarge'|'m8gd.48xlarge'|'m8gd.metal-24xl'|'m8gd.metal-48xl'|'r8gd.medium'|'r8gd.large'|'r8gd.xlarge'|'r8gd.2xlarge'|'r8gd.4xlarge'|'r8gd.8xlarge'|'r8gd.12xlarge'|'r8gd.16xlarge'|'r8gd.24xlarge'|'r8gd.48xlarge'|'r8gd.metal-24xl'|'r8gd.metal-48xl'|'c8gn.medium'|'c8gn.large'|'c8gn.xlarge'|'c8gn.2xlarge'|'c8gn.4xlarge'|'c8gn.8xlarge'|'c8gn.12xlarge'|'c8gn.16xlarge'|'c8gn.24xlarge'|'c8gn.48xlarge'|'c8gn.metal-24xl'|'c8gn.metal-48xl'|'f2.6xlarge'|'p6e-gb200.36xlarge', 'Platform': 'Windows' }, ], 'Context': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Fleets** *(list) --* Information about the EC2 Fleets. * *(dict) --* Describes an EC2 Fleet. * **ActivityStatus** *(string) --* The progress of the EC2 Fleet. If there is an error, the status is "error". After all requests are placed, the status is "pending_fulfillment". If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is "fulfilled". If the size of the EC2 Fleet is decreased, the status is "pending_termination" while instances are terminating. * **CreateTime** *(datetime) --* The creation date and time of the EC2 Fleet. * **FleetId** *(string) --* The ID of the EC2 Fleet. * **FleetState** *(string) --* The state of the EC2 Fleet. * **ClientToken** *(string) --* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. Constraints: Maximum 64 ASCII characters * **ExcessCapacityTerminationPolicy** *(string) --* Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type "maintain". * **FulfilledCapacity** *(float) --* The number of units fulfilled by this request compared to the set target capacity. * **FulfilledOnDemandCapacity** *(float) --* The number of units fulfilled by this request compared to the set target On-Demand capacity. * **LaunchTemplateConfigs** *(list) --* The launch template and overrides. * *(dict) --* Describes a launch template and overrides. * **LaunchTemplateSpecification** *(dict) --* The launch template. * **LaunchTemplateId** *(string) --* The ID of the launch template. You must specify the "LaunchTemplateId" or the "LaunchTemplateName", but not both. * **LaunchTemplateName** *(string) --* The name of the launch template. You must specify the "LaunchTemplateName" or the "LaunchTemplateId", but not both. * **Version** *(string) --* The launch template version number, "$Latest", or "$Default". You must specify a value, otherwise the request fails. If the value is "$Latest", Amazon EC2 uses the latest version of the launch template. If the value is "$Default", Amazon EC2 uses the default version of the launch template. * **Overrides** *(list) --* Any parameters that you specify override the same parameters in the launch template. * *(dict) --* Describes overrides for a launch template. * **InstanceType** *(string) --* The instance type. "mac1.metal" is not supported as a launch template override. Note: If you specify "InstanceType", you can't specify "InstanceRequirements". * **MaxPrice** *(string) --* The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price. Warning: If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an "InvalidParameterValue" error message. * **SubnetId** *(string) --* The ID of the subnet in which to launch the instances. * **AvailabilityZone** *(string) --* The Availability Zone in which to launch the instances. * **WeightedCapacity** *(float) --* The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. Note: When specifying weights, the price used in the "lowest-price" and "price-capacity-optimized" allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested "TargetCapacity", resulting in only 1 instance being launched, the price used is per *instance* hour. * **Priority** *(float) --* The priority for the launch template override. The highest priority is launched first. If the On-Demand "AllocationStrategy" is set to "prioritized", EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot "AllocationStrategy" is set to "capacity-optimized-prioritized", EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first. Valid values are whole numbers starting at "0". The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides. * **Placement** *(dict) --* The location where the instance launched, if applicable. * **GroupName** *(string) --* The name of the placement group that the instance is in. * **InstanceRequirements** *(dict) --* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. Note: If you specify "InstanceRequirements", you can't specify "InstanceType". * **VCpuCount** *(dict) --* The minimum and maximum number of vCPUs. * **Min** *(integer) --* The minimum number of vCPUs. If the value is "0", there is no minimum limit. * **Max** *(integer) --* The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit. * **MemoryMiB** *(dict) --* The minimum and maximum amount of memory, in MiB. * **Min** *(integer) --* The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit. * **CpuManufacturers** *(list) --* The CPU manufacturers to include. * For instance types with Intel CPUs, specify "intel". * For instance types with AMD CPUs, specify "amd". * For instance types with Amazon Web Services CPUs, specify "amazon-web-services". * For instance types with Apple CPUs, specify "apple". Note: Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer * *(string) --* * **MemoryGiBPerVCpu** *(dict) --* The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit. * **ExcludedInstanceTypes** *(list) --* The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to exclude an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. Note: If you specify "ExcludedInstanceTypes", you can't specify "AllowedInstanceTypes". Default: No excluded instance types * *(string) --* * **InstanceGenerations** *(list) --* Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the *Amazon EC2 User Guide*. For current generation instance types, specify "current". For previous generation instance types, specify "previous". Default: Current and previous generation instance types * *(string) --* * **SpotMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandP rice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". Default: "100" * **OnDemandMaxPricePercentageOverLowestPrice** *(integer) --* [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. To turn off price protection, specify a high value, such as "999999". This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Note: If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per- instance price. Default: "20" * **BareMetal** *(string) --* Indicates whether bare metal instance types must be included, excluded, or required. * To include bare metal instance types, specify "included". * To require only bare metal instance types, specify "required". * To exclude bare metal instance types, specify "excluded". Default: "excluded" * **BurstablePerformance** *(string) --* Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances. * To include burstable performance instance types, specify "included". * To require only burstable performance instance types, specify "required". * To exclude burstable performance instance types, specify "excluded". Default: "excluded" * **RequireHibernateSupport** *(boolean) --* Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: "false" * **NetworkInterfaceCount** *(dict) --* The minimum and maximum number of network interfaces. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit. * **LocalStorage** *(string) --* Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the *Amazon EC2 User Guide*. * To include instance types with instance store volumes, specify "included". * To require only instance types with instance store volumes, specify "required". * To exclude instance types with instance store volumes, specify "excluded". Default: "included" * **LocalStorageTypes** *(list) --* The type of local storage that is required. * For instance types with hard disk drive (HDD) storage, specify "hdd". * For instance types with solid state drive (SSD) storage, specify "ssd". Default: "hdd" and "ssd" * *(string) --* * **TotalLocalStorageGB** *(dict) --* The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit. * **BaselineEbsBandwidthMbps** *(dict) --* The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the *Amazon EC2 User Guide*. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit. * **AcceleratorTypes** *(list) --* The accelerator types that must be on the instance type. * For instance types with FPGA accelerators, specify "fpga". * For instance types with GPU accelerators, specify "gpu". * For instance types with Inference accelerators, specify "inference". Default: Any accelerator type * *(string) --* * **AcceleratorCount** *(dict) --* The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set "Max" to "0". Default: No minimum or maximum limits * **Min** *(integer) --* The minimum number of accelerators. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum number of accelerators. If this parameter is not specified, there is no maximum limit. * **AcceleratorManufacturers** *(list) --* Indicates whether instance types must have accelerators by specific manufacturers. * For instance types with Amazon Web Services devices, specify "amazon-web-services". * For instance types with AMD devices, specify "amd". * For instance types with Habana devices, specify "habana". * For instance types with NVIDIA devices, specify "nvidia". * For instance types with Xilinx devices, specify "xilinx". Default: Any manufacturer * *(string) --* * **AcceleratorNames** *(list) --* The accelerators that must be on the instance type. * For instance types with NVIDIA A10G GPUs, specify "a10g". * For instance types with NVIDIA A100 GPUs, specify "a100". * For instance types with NVIDIA H100 GPUs, specify "h100". * For instance types with Amazon Web Services Inferentia chips, specify "inferentia". * For instance types with NVIDIA GRID K520 GPUs, specify "k520". * For instance types with NVIDIA K80 GPUs, specify "k80". * For instance types with NVIDIA M60 GPUs, specify "m60". * For instance types with AMD Radeon Pro V520 GPUs, specify "radeon-pro-v520". * For instance types with NVIDIA T4 GPUs, specify "t4". * For instance types with NVIDIA T4G GPUs, specify "t4g". * For instance types with Xilinx VU9P FPGAs, specify "vu9p". * For instance types with NVIDIA V100 GPUs, specify "v100". Default: Any accelerator * *(string) --* * **AcceleratorTotalMemoryMiB** *(dict) --* The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits * **Min** *(integer) --* The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit. * **Max** *(integer) --* The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit. * **NetworkBandwidthGbps** *(dict) --* The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits * **Min** *(float) --* The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit. * **Max** *(float) --* The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit. * **AllowedInstanceTypes** *(list) --* The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk ( "*"), to allow an instance type, size, or generation. The following are examples: "m5.8xlarge", "c5*.*", "m5a.*", "r*", "*3*". For example, if you specify "c5*",Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify "m5a.*", Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. Note: If you specify "AllowedInstanceTypes", you can't specify "ExcludedInstanceTypes". Default: All instance types * *(string) --* * **MaxSpotPriceAsPercentageOfOptimalOnDemandPr ice** *(integer) --* [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set "TargetCapacityUnitType" to "vcpu" or "memory-mib", the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Note: Only one of "SpotMaxPricePercentageOverLowestPrice" or "MaxSpotPriceAsPercentageOfOptimalOnDemandP rice" can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as "999999". * **BaselinePerformanceFactors** *(dict) --* The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the *Amazon EC2 User Guide*. * **Cpu** *(dict) --* The CPU performance to consider, using an instance family as the baseline reference. * **References** *(list) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Note: Currently, only one instance family can be specified in the list. * *(dict) --* Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture. Note: Currently, only one instance family can be specified in the list. * **InstanceFamily** *(string) --* The instance family to use as a baseline reference. Note: Ensure that you specify the correct value for the instance family. The instance family is everything before the period ( ".") in the instance type name. For example, in the instance type "c6i.large", the instance family is "c6i", not "c6". For more information, see Amazon EC2 instance type naming conventions in *Amazon EC2 Instance Types*. The following instance families are *not supported* for performance protection: * "c1" * "g3" | "g3s" * "hpc7g" * "m1" | "m2" * "mac1" | "mac2" | "mac2-m1ultra" | "mac2-m2" | "mac2-m2pro" * "p3dn" | "p4d" | "p5" * "t1" * "u-12tb1" | "u-18tb1" | "u-24tb1" | "u-3tb1" | "u-6tb1" | "u-9tb1" | "u7i-12tb" | "u7in-16tb" | "u7in- 24tb" | "u7in-32tb" If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInst anceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest. * **ImageId** *(string) --* The ID of the AMI in the format "ami- 17characters00000". Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter: * "resolve:ssm:public-parameter" To reference a parameter stored in the same account: * "resolve:ssm:parameter-name" * "resolve:ssm:parameter-name:version-number" * "resolve:ssm:parameter-name:label" To reference a parameter shared from another Amazon Web Services account: * "resolve:ssm:parameter-ARN" * "resolve:ssm:parameter-ARN:version-number" * "resolve:ssm:parameter-ARN:label" For more information, see Use a Systems Manager parameter instead of an AMI ID in the *Amazon EC2 User Guide*. Note: This parameter is only available for fleets of type "instant". For fleets of type "maintain" and "request", you must specify the AMI ID in the launch template. * **BlockDeviceMappings** *(list) --* The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch. Supported only for fleets of type "instant". For more information, see Block device mappings for volumes on Amazon EC2 instances in the *Amazon EC2 User Guide*. * *(dict) --* Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch. * **DeviceName** *(string) --* The device name (for example, "/dev/sdh" or "xvdh"). * **VirtualName** *(string) --* The virtual device name. * **Ebs** *(dict) --* Parameters used to automatically set up EBS volumes when the instance is launched. * **Encrypted** *(boolean) --* Indicates whether the volume is encrypted. * **DeleteOnTermination** *(boolean) --* Indicates whether the volume is deleted on instance termination. * **Iops** *(integer) --* 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. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **KmsKeyId** *(string) --* Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. * **SnapshotId** *(string) --* The ID of the snapshot. * **VolumeSize** *(integer) --* The size of the volume, in GiBs. * **VolumeType** *(string) --* The volume type. For more information, see Amazon EBS volume types in the *Amazon EBS User Guide*. * **NoDevice** *(string) --* Suppresses the specified device included in the block device mapping. * **TargetCapacitySpecification** *(dict) --* The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is "maintain", you can specify a target capacity of 0 and add capacity later. * **TotalTargetCapacity** *(integer) --* The number of units to request, filled the default target capacity type. * **OnDemandTargetCapacity** *(integer) --* The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units. * **SpotTargetCapacity** *(integer) --* The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units. * **DefaultTargetCapacityType** *(string) --* The default target capacity type. * **TargetCapacityUnitType** *(string) --* The unit for the target capacity. * **TerminateInstancesWithExpiration** *(boolean) --* Indicates whether running instances should be terminated when the EC2 Fleet expires. * **Type** *(string) --* The type of request. Indicates whether the EC2 Fleet only "requests" the target capacity, or also attempts to "maintain" it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: "maintain". * **ValidFrom** *(datetime) --* The start date and time of the request, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:>>*<>*< - 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") * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Volumes': [ { 'OutpostArn': 'string', 'Iops': 123, 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'VolumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3', 'FastRestored': True|False, 'MultiAttachEnabled': True|False, 'Throughput': 123, 'SseType': 'sse-ebs'|'sse-kms'|'none', 'Operator': { 'Managed': True|False, 'Principal': 'string' }, 'VolumeInitializationRate': 123, 'VolumeId': 'string', 'Size': 123, 'SnapshotId': 'string', 'AvailabilityZone': 'string', 'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error', 'CreateTime': datetime(2015, 1, 1), 'Attachments': [ { 'DeleteOnTermination': True|False, 'AssociatedResource': 'string', 'InstanceOwningService': 'string', 'VolumeId': 'string', 'InstanceId': 'string', 'Device': 'string', 'State': 'attaching'|'attached'|'detaching'|'detached'|'busy', 'AttachTime': datetime(2015, 1, 1) }, ], 'Encrypted': True|False, 'KmsKeyId': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. * **Volumes** *(list) --* Information about the volumes. * *(dict) --* Describes a volume. * **OutpostArn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **Iops** *(integer) --* 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. * **Tags** *(list) --* Any tags assigned to the volume. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **VolumeType** *(string) --* The volume type. * **FastRestored** *(boolean) --* Note: This parameter is not returned by CreateVolume. Indicates whether the volume was created using fast snapshot restore. * **MultiAttachEnabled** *(boolean) --* Indicates whether Amazon EBS Multi-Attach is enabled. * **Throughput** *(integer) --* The throughput that the volume supports, in MiB/s. * **SseType** *(string) --* Note: This parameter is not returned by CreateVolume. Reserved for future use. * **Operator** *(dict) --* The service provider that manages the volume. * **Managed** *(boolean) --* If "true", the resource is managed by a service provider. * **Principal** *(string) --* If "managed" is "true", then the principal is returned. The principal is the service provider that manages the resource. * **VolumeInitializationRate** *(integer) --* The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is "null". * **VolumeId** *(string) --* The ID of the volume. * **Size** *(integer) --* The size of the volume, in GiBs. * **SnapshotId** *(string) --* The snapshot from which the volume was created, if applicable. * **AvailabilityZone** *(string) --* The Availability Zone for the volume. * **State** *(string) --* The volume state. * **CreateTime** *(datetime) --* The time stamp when volume creation was initiated. * **Attachments** *(list) --* Note: This parameter is not returned by CreateVolume. Information about the volume attachments. * *(dict) --* Describes volume attachment details. * **DeleteOnTermination** *(boolean) --* Indicates whether the EBS volume is deleted on instance termination. * **AssociatedResource** *(string) --* The ARN of the Amazon Web Services-managed resource to which the volume is attached. * **InstanceOwningService** *(string) --* The service principal of the Amazon Web Services service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to Amazon Web Services-managed resources. * **VolumeId** *(string) --* The ID of the volume. * **InstanceId** *(string) --* The ID of the instance. If the volume is attached to an Amazon Web Services- managed resource, this parameter returns "null". * **Device** *(string) --* The device name. If the volume is attached to an Amazon Web Services- managed resource, this parameter returns "null". * **State** *(string) --* The attachment state of the volume. * **AttachTime** *(datetime) --* The time stamp when the attachment initiated. * **Encrypted** *(boolean) --* Indicates whether the volume is encrypted. * **KmsKeyId** *(string) --* The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume. **Examples** This example describes all of your volumes in the default region. response = client.describe_volumes( ) print(response) Expected Output: { 'NextToken': '', 'Volumes': [ { 'Attachments': [ { 'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0), 'DeleteOnTermination': True, 'Device': '/dev/sda1', 'InstanceId': 'i-1234567890abcdef0', 'State': 'attached', 'VolumeId': 'vol-049df61146c4d7901', }, ], 'AvailabilityZone': 'us-east-1a', 'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0), 'Size': 8, 'SnapshotId': 'snap-1234567890abcdef0', 'State': 'in-use', 'VolumeId': 'vol-049df61146c4d7901', 'VolumeType': 'standard', }, ], 'ResponseMetadata': { '...': '...', }, } This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates. response = client.describe_volumes( Filters=[ { 'Name': 'attachment.instance-id', 'Values': [ 'i-1234567890abcdef0', ], }, { 'Name': 'attachment.delete-on-termination', 'Values': [ 'true', ], }, ], ) print(response) Expected Output: { 'Volumes': [ { 'Attachments': [ { 'AttachTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0), 'DeleteOnTermination': True, 'Device': '/dev/sda1', 'InstanceId': 'i-1234567890abcdef0', 'State': 'attached', 'VolumeId': 'vol-049df61146c4d7901', }, ], 'AvailabilityZone': 'us-east-1a', 'CreateTime': datetime(2013, 12, 18, 22, 35, 0, 2, 352, 0), 'Size': 8, 'SnapshotId': 'snap-1234567890abcdef0', 'State': 'in-use', 'VolumeId': 'vol-049df61146c4d7901', 'VolumeType': 'standard', }, ], 'ResponseMetadata': { '...': '...', }, } EC2 / Client / purchase_capacity_block_extension purchase_capacity_block_extension ********************************* EC2.Client.purchase_capacity_block_extension(**kwargs) Purchase the Capacity Block extension for use with your account. You must specify the ID of the Capacity Block extension offering you are purchasing. See also: AWS API Documentation **Request Syntax** response = client.purchase_capacity_block_extension( CapacityBlockExtensionOfferingId='string', CapacityReservationId='string', DryRun=True|False ) Parameters: * **CapacityBlockExtensionOfferingId** (*string*) -- **[REQUIRED]** The ID of the Capacity Block extension offering to purchase. * **CapacityReservationId** (*string*) -- **[REQUIRED]** The ID of the Capacity reservation to be extended. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'CapacityBlockExtensions': [ { 'CapacityReservationId': 'string', 'InstanceType': 'string', 'InstanceCount': 123, 'AvailabilityZone': 'string', 'AvailabilityZoneId': 'string', 'CapacityBlockExtensionOfferingId': 'string', 'CapacityBlockExtensionDurationHours': 123, 'CapacityBlockExtensionStatus': 'payment-pending'|'payment-failed'|'payment-succeeded', 'CapacityBlockExtensionPurchaseDate': datetime(2015, 1, 1), 'CapacityBlockExtensionStartDate': datetime(2015, 1, 1), 'CapacityBlockExtensionEndDate': datetime(2015, 1, 1), 'UpfrontFee': 'string', 'CurrencyCode': 'string' }, ] } **Response Structure** * *(dict) --* * **CapacityBlockExtensions** *(list) --* The purchased Capacity Block extensions. * *(dict) --* Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block. * **CapacityReservationId** *(string) --* The reservation ID of the Capacity Block extension. * **InstanceType** *(string) --* The instance type of the Capacity Block extension. * **InstanceCount** *(integer) --* The number of instances in the Capacity Block extension. * **AvailabilityZone** *(string) --* The Availability Zone of the Capacity Block extension. * **AvailabilityZoneId** *(string) --* The Availability Zone ID of the Capacity Block extension. * **CapacityBlockExtensionOfferingId** *(string) --* The ID of the Capacity Block extension offering. * **CapacityBlockExtensionDurationHours** *(integer) --* The duration of the Capacity Block extension in hours. * **CapacityBlockExtensionStatus** *(string) --* The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses: * "payment-pending" - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed. * "payment-failed" - Payment for the Capacity Block extension request was not successful. * "payment-succeeded" - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID. * **CapacityBlockExtensionPurchaseDate** *(datetime) --* The date when the Capacity Block extension was purchased. * **CapacityBlockExtensionStartDate** *(datetime) --* The start date of the Capacity Block extension. * **CapacityBlockExtensionEndDate** *(datetime) --* The end date of the Capacity Block extension. * **UpfrontFee** *(string) --* The total price to be paid up front. * **CurrencyCode** *(string) --* The currency of the payment for the Capacity Block extension. EC2 / Client / get_verified_access_endpoint_policy get_verified_access_endpoint_policy *********************************** EC2.Client.get_verified_access_endpoint_policy(**kwargs) Get the Verified Access policy associated with the endpoint. See also: AWS API Documentation **Request Syntax** response = client.get_verified_access_endpoint_policy( VerifiedAccessEndpointId='string', DryRun=True|False ) Parameters: * **VerifiedAccessEndpointId** (*string*) -- **[REQUIRED]** The ID of the Verified Access endpoint. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'PolicyEnabled': True|False, 'PolicyDocument': 'string' } **Response Structure** * *(dict) --* * **PolicyEnabled** *(boolean) --* The status of the Verified Access policy. * **PolicyDocument** *(string) --* The Verified Access policy document. EC2 / Client / create_delegate_mac_volume_ownership_task create_delegate_mac_volume_ownership_task ***************************************** EC2.Client.create_delegate_mac_volume_ownership_task(**kwargs) Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user. See also: AWS API Documentation **Request Syntax** response = client.create_delegate_mac_volume_ownership_task( ClientToken='string', DryRun=True|False, InstanceId='string', MacCredentials='string', TagSpecifications=[ { 'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] ) Parameters: * **ClientToken** (*string*) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". * **InstanceId** (*string*) -- **[REQUIRED]** The ID of the Amazon EC2 Mac instance. * **MacCredentials** (*string*) -- **[REQUIRED]** Specifies the following credentials: * **Internal disk administrative user** * **Username** - Only the default administrative user ( "aws-managed-user") is supported and it is used by default. You can't specify a different administrative user. * **Password** - If you did not change the default password for "aws-managed-user", specify the default password, which is *blank*. Otherwise, specify your password. * **Amazon EBS root volume administrative user** * **Username** - If you did not change the default administrative user, specify "ec2-user". Otherwise, specify the username for your administrative user. * **Password** - Specify the password for the administrative user. The credentials must be specified in the following JSON format: "{ "internalDiskPassword":"internal-disk-admin_password", "rootVolumeUsername":"root-volume-admin_username", "rootVolumepassword":"root-volume-admin_password" }" * **TagSpecifications** (*list*) -- The tags to assign to the volume ownership delegation task. * *(dict) --* The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail. Note: The "Valid Values" lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error. * **ResourceType** *(string) --* The type of resource to tag on creation. * **Tags** *(list) --* The tags to apply to the resource. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Return type: dict Returns: **Response Syntax** { 'MacModificationTask': { 'InstanceId': 'string', 'MacModificationTaskId': 'string', 'MacSystemIntegrityProtectionConfig': { 'AppleInternal': 'enabled'|'disabled', 'BaseSystem': 'enabled'|'disabled', 'DebuggingRestrictions': 'enabled'|'disabled', 'DTraceRestrictions': 'enabled'|'disabled', 'FilesystemProtections': 'enabled'|'disabled', 'KextSigning': 'enabled'|'disabled', 'NvramProtections': 'enabled'|'disabled', 'Status': 'enabled'|'disabled' }, 'StartTime': datetime(2015, 1, 1), 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'TaskState': 'successful'|'failed'|'in-progress'|'pending', 'TaskType': 'sip-modification'|'volume-ownership-delegation' } } **Response Structure** * *(dict) --* * **MacModificationTask** *(dict) --* Information about the volume ownership delegation task. * **InstanceId** *(string) --* The ID of the Amazon EC2 Mac instance. * **MacModificationTaskId** *(string) --* The ID of task. * **MacSystemIntegrityProtectionConfig** *(dict) --* [SIP modification tasks only] Information about the SIP configuration. * **AppleInternal** *(string) --* Indicates whether Apple Internal was enabled or disabled by the task. * **BaseSystem** *(string) --* Indicates whether Base System was enabled or disabled by the task. * **DebuggingRestrictions** *(string) --* Indicates whether Debugging Restrictions was enabled or disabled by the task. * **DTraceRestrictions** *(string) --* Indicates whether Dtrace Restrictions was enabled or disabled by the task. * **FilesystemProtections** *(string) --* Indicates whether Filesystem Protections was enabled or disabled by the task. * **KextSigning** *(string) --* Indicates whether Kext Signing was enabled or disabled by the task. * **NvramProtections** *(string) --* Indicates whether NVRAM Protections was enabled or disabled by the task. * **Status** *(string) --* Indicates SIP was enabled or disabled by the task. * **StartTime** *(datetime) --* The date and time the task was created, in the UTC timezone ( "YYYY-MM-DDThh:mm:ss.sssZ"). * **Tags** *(list) --* The tags assigned to the task. * *(dict) --* Describes a tag. * **Key** *(string) --* The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with "aws:". * **Value** *(string) --* The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. * **TaskState** *(string) --* The state of the task. * **TaskType** *(string) --* The type of task. EC2 / Client / disable_route_server_propagation disable_route_server_propagation ******************************** EC2.Client.disable_route_server_propagation(**kwargs) Disables route propagation from a route server to a specified route table. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: * VPC route tables not associated with subnets * Subnet route tables * Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect. For more information see Dynamic routing in your VPC with VPC Route Server in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.disable_route_server_propagation( RouteServerId='string', RouteTableId='string', DryRun=True|False ) Parameters: * **RouteServerId** (*string*) -- **[REQUIRED]** The ID of the route server for which to disable propagation. * **RouteTableId** (*string*) -- **[REQUIRED]** The ID of the route table for which to disable route server propagation. * **DryRun** (*boolean*) -- A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'RouteServerPropagation': { 'RouteServerId': 'string', 'RouteTableId': 'string', 'State': 'pending'|'available'|'deleting' } } **Response Structure** * *(dict) --* * **RouteServerPropagation** *(dict) --* Information about the disabled route server propagation. * **RouteServerId** *(string) --* The ID of the route server configured for route propagation. * **RouteTableId** *(string) --* The ID of the route table configured for route server propagation. * **State** *(string) --* The current state of route propagation. EC2 / Client / cancel_import_task cancel_import_task ****************** EC2.Client.cancel_import_task(**kwargs) Cancels an in-process import virtual machine or import snapshot task. See also: AWS API Documentation **Request Syntax** response = client.cancel_import_task( CancelReason='string', DryRun=True|False, ImportTaskId='string' ) Parameters: * **CancelReason** (*string*) -- The reason for canceling the task. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without 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** (*string*) -- The ID of the import image or import snapshot task to be canceled. Return type: dict Returns: **Response Syntax** { 'ImportTaskId': 'string', 'PreviousState': 'string', 'State': 'string' } **Response Structure** * *(dict) --* * **ImportTaskId** *(string) --* The ID of the task being canceled. * **PreviousState** *(string) --* The current state of the task being canceled. * **State** *(string) --* The current state of the task being canceled. EC2 / Client / describe_instance_event_notification_attributes describe_instance_event_notification_attributes *********************************************** EC2.Client.describe_instance_event_notification_attributes(**kwargs) Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. See also: AWS API Documentation **Request Syntax** response = client.describe_instance_event_notification_attributes( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'InstanceTagAttribute': { 'InstanceTagKeys': [ 'string', ], 'IncludeAllTagsOfInstance': True|False } } **Response Structure** * *(dict) --* * **InstanceTagAttribute** *(dict) --* Information about the registered tag keys. * **InstanceTagKeys** *(list) --* The registered tag keys. * *(string) --* * **IncludeAllTagsOfInstance** *(boolean) --* Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. "true" indicates that all tag keys in the current Region are registered. EC2 / Client / get_verified_access_endpoint_targets get_verified_access_endpoint_targets ************************************ EC2.Client.get_verified_access_endpoint_targets(**kwargs) Gets the targets for the specified network CIDR endpoint for Verified Access. See also: AWS API Documentation **Request Syntax** response = client.get_verified_access_endpoint_targets( VerifiedAccessEndpointId='string', MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **VerifiedAccessEndpointId** (*string*) -- **[REQUIRED]** The ID of the network CIDR endpoint. * **MaxResults** (*integer*) -- 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** (*string*) -- The token for the next page of results. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VerifiedAccessEndpointTargets': [ { 'VerifiedAccessEndpointId': 'string', 'VerifiedAccessEndpointTargetIpAddress': 'string', 'VerifiedAccessEndpointTargetDns': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VerifiedAccessEndpointTargets** *(list) --* The Verified Access targets. * *(dict) --* Describes the targets for the specified Verified Access endpoint. * **VerifiedAccessEndpointId** *(string) --* The ID of the Verified Access endpoint. * **VerifiedAccessEndpointTargetIpAddress** *(string) --* The IP address of the target. * **VerifiedAccessEndpointTargetDns** *(string) --* The DNS name of the target. * **NextToken** *(string) --* The token to use to retrieve the next page of results. This value is "null" when there are no more results to return. EC2 / Client / reset_image_attribute reset_image_attribute ********************* EC2.Client.reset_image_attribute(**kwargs) Resets an attribute of an AMI to its default value. See also: AWS API Documentation **Request Syntax** response = client.reset_image_attribute( Attribute='launchPermission', ImageId='string', DryRun=True|False ) Parameters: * **Attribute** (*string*) -- **[REQUIRED]** The attribute to reset (currently you can only reset the launch permission attribute). * **ImageId** (*string*) -- **[REQUIRED]** The ID of the AMI. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Returns: None **Examples** This example resets the launchPermission attribute for the specified AMI. By default, AMIs are private. response = client.reset_image_attribute( Attribute='launchPermission', ImageId='ami-5731123e', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } EC2 / Client / describe_fast_snapshot_restores describe_fast_snapshot_restores ******************************* EC2.Client.describe_fast_snapshot_restores(**kwargs) Describes the state of fast snapshot restores for your snapshots. See also: AWS API Documentation **Request Syntax** response = client.describe_fast_snapshot_restores( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string', DryRun=True|False ) Parameters: * **Filters** (*list*) -- The filters. The possible values are: * "availability-zone": The Availability Zone of the snapshot. * "owner-id": The ID of the Amazon Web Services 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"). * *(dict) --* A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. If you specify multiple filters, the filters are joined with an "AND", and the request returns only results that match all of the specified filters. For more information, see List and filter using the CLI and API in the *Amazon EC2 User Guide*. * **Name** *(string) --* The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an "OR", and the request returns all results that match any of the specified values. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination. * **NextToken** (*string*) -- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'FastSnapshotRestores': [ { 'SnapshotId': 'string', 'AvailabilityZone': 'string', 'State': 'enabling'|'optimizing'|'enabled'|'disabling'|'disabled', 'StateTransitionReason': 'string', 'OwnerId': 'string', 'OwnerAlias': 'string', 'EnablingTime': datetime(2015, 1, 1), 'OptimizingTime': datetime(2015, 1, 1), 'EnabledTime': datetime(2015, 1, 1), 'DisablingTime': datetime(2015, 1, 1), 'DisabledTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **FastSnapshotRestores** *(list) --* Information about the state of fast snapshot restores. * *(dict) --* Describes fast snapshot restores for a snapshot. * **SnapshotId** *(string) --* The ID of the snapshot. * **AvailabilityZone** *(string) --* The Availability Zone. * **State** *(string) --* The state of fast snapshot restores. * **StateTransitionReason** *(string) --* The reason for the state transition. The possible values are as follows: * "Client.UserInitiated" - The state successfully transitioned to "enabling" or "disabling". * "Client.UserInitiated - Lifecycle state transition" - The state successfully transitioned to "optimizing", "enabled", or "disabled". * **OwnerId** *(string) --* The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. * **OwnerAlias** *(string) --* The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. * **EnablingTime** *(datetime) --* The time at which fast snapshot restores entered the "enabling" state. * **OptimizingTime** *(datetime) --* The time at which fast snapshot restores entered the "optimizing" state. * **EnabledTime** *(datetime) --* The time at which fast snapshot restores entered the "enabled" state. * **DisablingTime** *(datetime) --* The time at which fast snapshot restores entered the "disabling" state. * **DisabledTime** *(datetime) --* The time at which fast snapshot restores entered the "disabled" state. * **NextToken** *(string) --* The token to include in another request to get the next page of items. This value is "null" when there are no more items to return. EC2 / Client / disable_allowed_images_settings disable_allowed_images_settings ******************************* EC2.Client.disable_allowed_images_settings(**kwargs) Disables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to "disabled", the image criteria in your Allowed AMIs settings do not apply, and no restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. Note: The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in *Amazon EC2 User Guide*. See also: AWS API Documentation **Request Syntax** response = client.disable_allowed_images_settings( DryRun=True|False ) Parameters: **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'AllowedImagesSettingsState': 'disabled' } **Response Structure** * *(dict) --* * **AllowedImagesSettingsState** *(string) --* Returns "disabled" if the request succeeds; otherwise, it returns an error. EC2 / Client / create_transit_gateway_prefix_list_reference create_transit_gateway_prefix_list_reference ******************************************** EC2.Client.create_transit_gateway_prefix_list_reference(**kwargs) Creates a reference (route) to a prefix list in a specified transit gateway route table. See also: AWS API Documentation **Request Syntax** response = client.create_transit_gateway_prefix_list_reference( TransitGatewayRouteTableId='string', PrefixListId='string', TransitGatewayAttachmentId='string', Blackhole=True|False, DryRun=True|False ) Parameters: * **TransitGatewayRouteTableId** (*string*) -- **[REQUIRED]** The ID of the transit gateway route table. * **PrefixListId** (*string*) -- **[REQUIRED]** The ID of the prefix list that is used for destination matches. * **TransitGatewayAttachmentId** (*string*) -- The ID of the attachment to which traffic is routed. * **Blackhole** (*boolean*) -- Indicates whether to drop traffic that matches this route. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'TransitGatewayPrefixListReference': { 'TransitGatewayRouteTableId': 'string', 'PrefixListId': 'string', 'PrefixListOwnerId': 'string', 'State': 'pending'|'available'|'modifying'|'deleting', 'Blackhole': True|False, 'TransitGatewayAttachment': { 'TransitGatewayAttachmentId': 'string', 'ResourceType': 'vpc'|'vpn'|'direct-connect-gateway'|'connect'|'peering'|'tgw-peering'|'network-function', 'ResourceId': 'string' } } } **Response Structure** * *(dict) --* * **TransitGatewayPrefixListReference** *(dict) --* Information about the prefix list reference. * **TransitGatewayRouteTableId** *(string) --* The ID of the transit gateway route table. * **PrefixListId** *(string) --* The ID of the prefix list. * **PrefixListOwnerId** *(string) --* The ID of the prefix list owner. * **State** *(string) --* The state of the prefix list reference. * **Blackhole** *(boolean) --* Indicates whether traffic that matches this route is dropped. * **TransitGatewayAttachment** *(dict) --* Information about the transit gateway attachment. * **TransitGatewayAttachmentId** *(string) --* The ID of the attachment. * **ResourceType** *(string) --* The resource type. Note that the "tgw-peering" resource type has been deprecated. * **ResourceId** *(string) --* The ID of the resource. EC2 / Client / delete_verified_access_endpoint delete_verified_access_endpoint ******************************* EC2.Client.delete_verified_access_endpoint(**kwargs) Delete an Amazon Web Services Verified Access endpoint. See also: AWS API Documentation **Request Syntax** response = client.delete_verified_access_endpoint( VerifiedAccessEndpointId='string', ClientToken='string', DryRun=True|False ) Parameters: * **VerifiedAccessEndpointId** (*string*) -- **[REQUIRED]** The ID of the Verified Access endpoint. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency. This field is autopopulated if not provided. * **DryRun** (*boolean*) -- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is "DryRunOperation". Otherwise, it is "UnauthorizedOperation". Return type: dict Returns: **Response Syntax** { 'VerifiedAccessEndpoint': { 'VerifiedAccessInstanceId': 'string', 'VerifiedAccessGroupId': 'string', 'VerifiedAccessEndpointId': 'string', 'ApplicationDomain': 'string', 'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr', 'AttachmentType': 'vpc', 'DomainCertificateArn': 'string', 'EndpointDomain': 'string', 'DeviceValidationDomain': 'string', 'SecurityGroupIds': [ 'string', ], 'LoadBalancerOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'LoadBalancerArn': 'string', 'SubnetIds': [ 'string', ], 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'NetworkInterfaceOptions': { 'NetworkInterfaceId': 'string', 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ] }, 'Status': { 'Code': 'pending'|'active'|'updating'|'deleting'|'deleted', 'Message': 'string' }, 'Description': 'string', 'CreationTime': 'string', 'LastUpdatedTime': 'string', 'DeletionTime': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'SseSpecification': { 'CustomerManagedKeyEnabled': True|False, 'KmsKeyArn': 'string' }, 'RdsOptions': { 'Protocol': 'http'|'https'|'tcp', 'Port': 123, 'RdsDbInstanceArn': 'string', 'RdsDbClusterArn': 'string', 'RdsDbProxyArn': 'string', 'RdsEndpoint': 'string', 'SubnetIds': [ 'string', ] }, 'CidrOptions': { 'Cidr': 'string', 'PortRanges': [ { 'FromPort': 123, 'ToPort': 123 }, ], 'Protocol': 'http'|'https'|'tcp', 'SubnetIds': [ 'string', ] } } } **Response Structure** * *(dict) --* * **VerifiedAccessEndpoint** *(dict) --* Details about the Verified Access endpoint. * **VerifiedAccessInstanceId** *(string) --* The ID of the Amazon Web Services Verified Access instance. * **VerifiedAccessGroupId** *(string) --* The ID of the Amazon Web Services Verified Access group. * **VerifiedAccessEndpointId** *(string) --* The ID of the Amazon Web Services Verified Access endpoint. * **ApplicationDomain** *(string) --* The DNS name for users to reach your application. * **EndpointType** *(string) --* The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified. * **AttachmentType** *(string) --* The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application. * **DomainCertificateArn** *(string) --* The ARN of a public TLS/SSL certificate imported into or created with ACM. * **EndpointDomain** *(string) --* A DNS name that is generated for the endpoint. * **DeviceValidationDomain** *(string) --* Returned if endpoint has a device trust provider attached. * **SecurityGroupIds** *(list) --* The IDs of the security groups for the endpoint. * *(string) --* * **LoadBalancerOptions** *(dict) --* The load balancer details if creating the Amazon Web Services Verified Access endpoint as >>``<