Data retrieval APIs for Amazon EC2
Amazon EC2 provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeAccountAttributes | Describe the attributes of the AWS account | List |
| DescribeAddressTransfers | Describe an Elastic IP address transfer | List |
| DescribeAddresses | Describe one or more Elastic IP addresses | List |
| DescribeAddressesAttribute | Describe the attributes of the specified Elastic IP addresses | List |
| DescribeAggregateIdFormat | Describe the longer ID format settings for all resource types | List |
| DescribeAvailabilityZones | Describe one or more of the Availability Zones that are available to you | List |
| DescribeAwsNetworkPerformanceMetricSubscriptions | Describe the current infrastructure performance metric subscriptions | List |
| DescribeBundleTasks | Describe one or more bundling tasks | List |
| DescribeByoipCidrs | Describe the IP address ranges that were provisioned through bring your own IP addresses (BYOIP) | List |
| DescribeCapacityBlockExtensionHistory | Describe Capacity Block extensions history | List |
| DescribeCapacityBlockExtensionOfferings | Describe Capacity Block extensions offerings | List |
| DescribeCapacityBlockOfferings | Describe Capacity Block offerings available for purchase | List |
| DescribeCapacityBlockStatus | Describe the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks | List |
| DescribeCapacityBlocks | Describe details about Capacity Blocks in the AWS Region that you're currently using | List |
| DescribeCapacityReservationBillingRequests | Describe one or more requests to assign the billing of the unused capacity of a Capacity Reservation | List |
| DescribeCapacityReservationFleets | Describe one or more Capacity Reservation Fleets | List |
| DescribeCapacityReservations | Describe one or more Capacity Reservations | List |
| DescribeCarrierGateways | Describe one or more Carrier Gateways | List |
| DescribeClassicLinkInstances | Describe one or more linked EC2-Classic instances | List |
| DescribeClientVpnAuthorizationRules | Describe the authorization rules for a Client VPN endpoint | List |
| DescribeClientVpnConnections | Describe active client connections and connections that have been terminated within the last 60 minutes for a Client VPN endpoint | List |
| DescribeClientVpnEndpoints | Describe one or more Client VPN endpoints | List |
| DescribeClientVpnRoutes | Describe the routes for a Client VPN endpoint | List |
| DescribeClientVpnTargetNetworks | Describe the target networks that are associated with a Client VPN endpoint | List |
| DescribeCoipPools | Describe the specified customer-owned address pools or all of your customer-owned address pools | List |
| DescribeConversionTasks | Describe one or more conversion tasks | List |
| DescribeCustomerGateways | Describe one or more customer gateways | List |
| DescribeDeclarativePoliciesReports | Describe one or more declarative policies reports | List |
| DescribeDhcpOptions | Describe one or more DHCP options sets | List |
| DescribeEgressOnlyInternetGateways | Describe one or more egress-only internet gateways | List |
| DescribeElasticGpus | Describe an Elastic Graphics accelerator that is associated with an instance | List |
| DescribeExportImageTasks | Describe one or more export image tasks | List |
| DescribeExportTasks | Describe one or more export instance tasks | List |
| DescribeFastLaunchImages | Describe fast-launch enabled Windows AMIs | List |
| DescribeFastSnapshotRestores | Describe the state of fast snapshot restores for snapshots | List |
| DescribeFleetHistory | Describe the events for an EC2 Fleet during a specified time | List |
| DescribeFleetInstances | Describe the running instances for an EC2 Fleet | List |
| DescribeFleets | Describe one or more EC2 Fleets | List |
| DescribeFlowLogs | Describe one or more flow logs | List |
| DescribeFpgaImageAttribute | Describe the attributes of an Amazon FPGA Image (AFI) | List |
| DescribeFpgaImages | Describe one or more Amazon FPGA Images (AFIs) | List |
| DescribeHostReservationOfferings | Describe the Dedicated Host Reservations that are available to purchase | List |
| DescribeHostReservations | Describe the Dedicated Host Reservations that are associated with Dedicated Hosts in the AWS account | List |
| DescribeHosts | Describe one or more Dedicated Hosts | List |
| DescribeIamInstanceProfileAssociations | Describe the IAM instance profile associations | List |
| DescribeIdFormat | Describe the ID format settings for resources | List |
| DescribeIdentityIdFormat | Describe the ID format settings for resources for an IAM user, IAM role, or root user | List |
| DescribeImageAttribute | Describe an attribute of an Amazon Machine Image (AMI) | List |
| DescribeImageReferences | Describe your AWS resources that are referencing specified images | List |
| DescribeImageUsageReportEntries | Describe the entries of an AMI usage report | List |
| DescribeImageUsageReports | Describe the configuration and status of an AMI usage report | List |
| DescribeImages | Describe one or more images (AMIs, AKIs, and ARIs) | List |
| DescribeImportImageTasks | Describe import virtual machine or import snapshot tasks | List |
| DescribeImportSnapshotTasks | Describe import snapshot tasks | List |
| DescribeInstanceAttribute | Describe the attributes of an instance | List |
| DescribeInstanceConnectEndpoints | Describe EC2 Instance Connect Endpoints | List |
| DescribeInstanceCreditSpecifications | Describe the credit option for CPU usage of one or more burstable performance instances | List |
| DescribeInstanceEventNotificationAttributes | Describe the set of tags to include in notifications about scheduled events for your instances | List |
| DescribeInstanceEventWindows | Describe the specified event windows or all event windows | List |
| DescribeInstanceImageMetadata | Describe the AMI that was used to launch an instance | List |
| DescribeInstanceStatus | Describe the status of one or more instances | List |
| DescribeInstanceTopology | Describe a tree-based hierarchy that represents the physical host placement of EC2 instances | List |
| DescribeInstanceTypeOfferings | Describe the set of instance types that are offered in a location | List |
| DescribeInstanceTypes | Describe the details of instance types that are offered in a location | List |
| DescribeInstances | Describe one or more instances | List |
| DescribeInternetGateways | Describe one or more internet gateways | List |
| DescribeIpamByoasn | Describe a bring your own Autonomous System Number (BYOASN) that you've brought to IPAM | List |
| DescribeIpamExternalResourceVerificationTokens | Describe verification tokens, which proves ownership of an external resource | List |
| DescribeIpamPools | Describe Amazon VPC IP Address Manager (IPAM) pools | List |
| DescribeIpamResourceDiscoveries | Describe IPAM resource discoveries | List |
| DescribeIpamResourceDiscoveryAssociations | Describe resource discovery associations with an Amazon VPC IPAM | List |
| DescribeIpamScopes | Describe Amazon VPC IP Address Manager (IPAM) scopes | List |
| DescribeIpams | Describe an Amazon VPC IP Address Manager (IPAM) | List |
| DescribeIpv6Pools | Describe one or more IPv6 address pools | List |
| DescribeKeyPairs | Describe one or more key pairs | List |
| DescribeLaunchTemplateVersions | Describe one or more launch template versions | List |
| DescribeLaunchTemplates | Describe one or more launch templates | List |
| DescribeLocalGatewayRouteTablePermissions | Allow a service to describe local gateway route table permissions | List |
| DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations | Describe the associations between virtual interface groups and local gateway route tables | List |
| DescribeLocalGatewayRouteTableVpcAssociations | Describe an association between VPCs and local gateway route tables | List |
| DescribeLocalGatewayRouteTables | Describe one or more local gateway route tables | List |
| DescribeLocalGatewayVirtualInterfaceGroups | Describe local gateway virtual interface groups | List |
| DescribeLocalGatewayVirtualInterfaces | Describe local gateway virtual interfaces | List |
| DescribeLocalGateways | Describe one or more local gateways | List |
| DescribeLockedSnapshots | Describe the lock status for a snapshot | List |
| DescribeMacHosts | Describe your EC2 Mac Dedicated hosts | List |
| DescribeMacModificationTasks | Describe a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance | List |
| DescribeManagedPrefixLists | Describe your managed prefix lists and any AWS-managed prefix lists | List |
| DescribeMovingAddresses | Describe Elastic IP addresses that are being moved to the EC2-VPC platform | List |
| DescribeNatGateways | Describe one or more NAT gateways | List |
| DescribeNetworkAcls | Describe one or more network ACLs | List |
| DescribeNetworkInsightsAccessScopeAnalyses | Describe one or more Network Access Scope analyses | List |
| DescribeNetworkInsightsAccessScopes | Describe the Network Access Scopes | List |
| DescribeNetworkInsightsAnalyses | Describe one or more network insights analyses | List |
| DescribeNetworkInsightsPaths | Describe one or more network insights paths | List |
| DescribeNetworkInterfaceAttribute | Describe a network interface attribute | List |
| DescribeNetworkInterfacePermissions | Describe the permissions that are associated with a network interface | List |
| DescribeNetworkInterfaces | Describe one or more network interfaces | List |
| DescribeOutpostLags | Describe Outpost LAGs | List |
| DescribePlacementGroups | Describe one or more placement groups | List |
| DescribePrefixLists | Describe available AWS services in a prefix list format | List |
| DescribePrincipalIdFormat | Describe the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference | List |
| DescribePublicIpv4Pools | Describe one or more IPv4 address pools | List |
| DescribeRegions | Describe one or more AWS Regions that are currently available in your account | List |
| DescribeReplaceRootVolumeTasks | Describe a root volume replacement task | List |
| DescribeReservedInstances | Describe one or more purchased Reserved Instances in your account | List |
| DescribeReservedInstancesListings | Describe your account's Reserved Instance listings in the Reserved Instance Marketplace | List |
| DescribeReservedInstancesModifications | Describe the modifications made to one or more Reserved Instances | List |
| DescribeReservedInstancesOfferings | Describe the Reserved Instance offerings that are available for purchase | List |
| DescribeRouteServerEndpoints | Describe one or more route server endpoints | List |
| DescribeRouteServerPeers | Describe one or more route server peers | List |
| DescribeRouteServers | Describe one or more route servers | List |
| DescribeRouteTables | Describe one or more route tables | List |
| DescribeScheduledInstanceAvailability | Find available schedules for Scheduled Instances | List |
| DescribeScheduledInstances | Describe one or more Scheduled Instances in your account | List |
| DescribeSecurityGroupReferences | Describe the VPCs on the other side of a VPC peering connection that are referencing specified VPC security groups | List |
| DescribeSecurityGroupRules | Describe one or more of your security group rules | List |
| DescribeSecurityGroupVpcAssociations | Describe security group VPC associations | List |
| DescribeSecurityGroups | Describe one or more security groups | List |
| DescribeServiceLinkVirtualInterfaces | Describe service link virtual interfaces | List |
| DescribeSnapshotAttribute | Describe an attribute of a snapshot | List |
| DescribeSnapshotTierStatus | Describe the storage tier status for Amazon EBS snapshots | List |
| DescribeSnapshots | Describe one or more EBS snapshots | List |
| DescribeSpotDatafeedSubscription | Describe the data feed for Spot Instances | List |
| DescribeSpotFleetInstances | Describe the running instances for a Spot Fleet | List |
| DescribeSpotFleetRequestHistory | Describe the events for a Spot Fleet request during a specified time | List |
| DescribeSpotFleetRequests | Describe one or more Spot Fleet requests | List |
| DescribeSpotInstanceRequests | Describe one or more Spot Instance requests | List |
| DescribeSpotPriceHistory | Describe the Spot Instance price history | List |
| DescribeStaleSecurityGroups | Describe the stale security group rules for security groups in a specified VPC | List |
| DescribeStoreImageTasks | Describe the progress of the AMI store tasks | List |
| DescribeSubnets | Describe one or more subnets | List |
| DescribeTags | Describe one or more tags for an Amazon EC2 resource | List |
| DescribeTrafficMirrorFilterRules | Describe traffic mirror filters that determine the traffic that is mirrored | List |
| DescribeTrafficMirrorFilters | Describe one or more traffic mirror filters | List |
| DescribeTrafficMirrorSessions | Describe one or more traffic mirror sessions | List |
| DescribeTrafficMirrorTargets | Describe one or more traffic mirror targets | List |
| DescribeTransitGatewayAttachments | Describe one or more attachments between resources and transit gateways | List |
| DescribeTransitGatewayConnectPeers | Describe one or more transit gateway connect peers | List |
| DescribeTransitGatewayConnects | Describe one or more transit gateway connect attachments | List |
| DescribeTransitGatewayMulticastDomains | Describe one or more transit gateway multicast domains | List |
| DescribeTransitGatewayPeeringAttachments | Describe one or more transit gateway peering attachments | List |
| DescribeTransitGatewayPolicyTables | Describe a transit gateway policy table | List |
| DescribeTransitGatewayRouteTableAnnouncements | Describe a transit gateway route table announcement | List |
| DescribeTransitGatewayRouteTables | Describe one or more transit gateway route tables | List |
| DescribeTransitGatewayVpcAttachments | Describe one or more VPC attachments on a transit gateway | List |
| DescribeTransitGateways | Describe one or more transit gateways | List |
| DescribeTrunkInterfaceAssociations | Describe one or more network interface trunk associations | List |
| DescribeVerifiedAccessEndpoints | Describe the specified Verified Access endpoints or all Verified Access endpoints | List |
| DescribeVerifiedAccessGroups | Describe the specified Verified Access groups or all Verified Access groups | List |
| DescribeVerifiedAccessInstanceLoggingConfigurations | Describe the current logging configuration for the Verified Access instances | List |
| DescribeVerifiedAccessInstanceWebAclAssociations | Describe the AWS Web Application Firewall (WAF) web access control list (ACL) associations for a Verified Access instance | List |
| DescribeVerifiedAccessInstances | Describe the specified Verified Access instances or all Verified Access instances | List |
| DescribeVerifiedAccessTrustProviders | Describe details of existing Verified Access trust providers | List |
| DescribeVolumeAttribute | Describe an attribute of an EBS volume | List |
| DescribeVolumeStatus | Describe the status of one or more EBS volumes | List |
| DescribeVolumes | Describe one or more EBS volumes | List |
| DescribeVolumesModifications | Describe the current modification status of one or more EBS volumes | List |
| DescribeVpcAttribute | Describe an attribute of a VPC | List |
| DescribeVpcBlockPublicAccessExclusions | Describe an exclusion list for blocked public access on a VPC | List |
| DescribeVpcBlockPublicAccessOptions | Describe options for blocked public access on a VPC | List |
| DescribeVpcClassicLink | Describe the ClassicLink status of one or more VPCs | List |
| DescribeVpcClassicLinkDnsSupport | Describe the ClassicLink DNS support status of one or more VPCs | List |
| DescribeVpcEndpointAssociations | Describe the VPC endpoint associations | List |
| DescribeVpcEndpointConnectionNotifications | Describe the connection notifications for VPC endpoints and VPC endpoint services | List |
| DescribeVpcEndpointConnections | Describe the VPC endpoint connections to your VPC endpoint services | List |
| DescribeVpcEndpointServiceConfigurations | Describe VPC endpoint service configurations (your services) | List |
| DescribeVpcEndpointServicePermissions | Describe the principals (service consumers) that are permitted to discover your VPC endpoint service | List |
| DescribeVpcEndpointServices | Describe all supported AWS services that can be specified when creating a VPC endpoint | List |
| DescribeVpcEndpoints | Describe one or more VPC endpoints | List |
| DescribeVpcPeeringConnections | Describe one or more VPC peering connections | List |
| DescribeVpcs | Describe one or more VPCs | List |
| DescribeVpnConnections | Describe one or more VPN connections | List |
| DescribeVpnGateways | Describe one or more virtual private gateways | List |
| ExportClientVpnClientCertificateRevocationList | Download the client certificate revocation list for a Client VPN endpoint | Read |
| ExportClientVpnClientConfiguration | Download the contents of the Client VPN endpoint configuration file for a Client VPN endpoint | Read |
| ExportVerifiedAccessInstanceClientConfiguration | Export a verified access instance client configuration | Read |
| GetActiveVpnTunnelStatus | Retrieve the current security parameters for an active VPN tunnel | Read |
| GetAllowedImagesSettings | Get the allowed settings for images | Read |
| GetAssociatedEnclaveCertificateIamRoles | Get the list of roles associated with an ACM certificate | Read |
| GetAssociatedIpv6PoolCidrs | Get information about the IPv6 CIDR block associations for a specified IPv6 address pool | Read |
| GetAwsNetworkPerformanceData | Get network performance data | Read |
| GetCapacityReservationUsage | Get usage information about a Capacity Reservation | Read |
| GetCoipPoolUsage | Describe the allocations from the specified customer-owned address pool | Read |
| GetConsoleOutput | Get the console output for an instance | Read |
| GetConsoleScreenshot | Retrieve a JPG-format screenshot of a running instance | Read |
| GetDeclarativePoliciesReportSummary | Get the report summary of declarative policies | Read |
| GetDefaultCreditSpecification | Get the default credit option for CPU usage of a burstable performance instance family | Read |
| GetEbsDefaultKmsKeyId | Get the ID of the default customer master key (CMK) for EBS encryption by default | Read |
| GetEbsEncryptionByDefault | Describe whether EBS encryption by default is enabled for your account | Read |
| GetFlowLogsIntegrationTemplate | Generate a CloudFormation template to streamline the integration of VPC flow logs with Amazon Athena | Read |
| GetGroupsForCapacityReservation | List the resource groups to which a Capacity Reservation has been added | List |
| GetHostReservationPurchasePreview | Preview a reservation purchase with configurations that match those of a Dedicated Host | Read |
| GetImageBlockPublicAccessState | Get the current state of block public access for AMIs at the account level in the specified AWS Region | Read |
| GetInstanceMetadataDefaults | View the default instance metadata service (IMDS) settings set for your account in the specified Region | List |
| GetInstanceTpmEkPub | Get the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance | Read |
| GetInstanceTypesFromInstanceRequirements | View a list of instance types with specified instance attributes | List |
| GetInstanceUefiData | Retrieve the binary representation of the UEFI variable store | Read |
| GetIpamAddressHistory | Retrieve historical information about a CIDR within an Amazon VPC IP Address Manager (IPAM) scope | Read |
| GetIpamDiscoveredAccounts | Retrieve IPAM discovered accounts | Read |
| GetIpamDiscoveredPublicAddresses | Retrieve the public IP addresses that have been discovered by IPAM | Read |
| GetIpamDiscoveredResourceCidrs | Retrieve the resource CIDRs that are monitored as part of a resource discovery | Read |
| GetIpamPoolAllocations | Get a list of all the CIDR allocations in an Amazon VPC IP Address Manager (IPAM) pool | List |
| GetIpamPoolCidrs | Get the CIDRs provisioned to an Amazon VPC IP Address Manager (IPAM) pool | Read |
| GetIpamResourceCidrs | Get information about the resources in an Amazon VPC IP Address Manager (IPAM) scope | Read |
| GetLaunchTemplateData | Get the configuration data of the specified instance for use with a new launch template or launch template version | Read |
| GetManagedPrefixListAssociations | Get information about the resources that are associated with the specified managed prefix list | Read |
| GetManagedPrefixListEntries | Get information about the entries for a specified managed prefix list | Read |
| GetNetworkInsightsAccessScopeAnalysisFindings | Get the findings for one or more Network Access Scope analyses | Read |
| GetNetworkInsightsAccessScopeContent | Get the content for a specified Network Access Scope | Read |
| GetPasswordData | Retrieve the encrypted administrator password for a running Windows instance | Read |
| GetReservedInstancesExchangeQuote | Return a quote and exchange information for exchanging one or more Convertible Reserved Instances for a new Convertible Reserved Instance | Read |
| GetResourcePolicy | Describe an IAM policy that enables cross-account sharing | Read |
| GetRouteServerAssociations | Get associations for a route server | Read |
| GetRouteServerPropagations | Get propagations for a route server | Read |
| GetRouteServerRoutingDatabase | Get the routing database for a route server | Read |
| GetSecurityGroupsForVpc | Retrieve a list of security groups for a specified VPC | Read |
| GetSerialConsoleAccessStatus | Retrieve the access status of your account to the EC2 serial console of all instances | Read |
| GetSnapshotBlockPublicAccessState | Retrieve the current state of the block public access for snapshots setting for a Region | Read |
| GetSpotPlacementScores | Calculate the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements | Read |
| GetSubnetCidrReservations | Retrieve information about the subnet CIDR reservations | Read |
| GetTransitGatewayAttachmentPropagations | List the route tables to which a resource attachment propagates routes | List |
| GetTransitGatewayMulticastDomainAssociations | Get information about the associations for a transit gateway multicast domain | List |
| GetTransitGatewayPolicyTableAssociations | Get information about associations for a transit gateway policy table | List |
| GetTransitGatewayPolicyTableEntries | Get information about associations for a transit gateway policy table entry | List |
| GetTransitGatewayPrefixListReferences | Get information about prefix list references for a transit gateway route table | List |
| GetTransitGatewayRouteTableAssociations | Get information about associations for a transit gateway route table | List |
| GetTransitGatewayRouteTablePropagations | Get information about the route table propagations for a transit gateway route table | List |
| GetVerifiedAccessEndpointPolicy | Show the Verified Access policy associated with the endpoint | List |
| GetVerifiedAccessEndpointTargets | Get verified access endpoint targets | List |
| GetVerifiedAccessGroupPolicy | Show the contents of the Verified Access policy associated with the group | List |
| GetVerifiedAccessInstanceWebAcl | Show the AWS Web Application Firewall (WAF) web access control list (ACL) for a Verified Access instance | List |
| GetVpnConnectionDeviceSampleConfiguration | Download an AWS-provided sample configuration file to be used with the customer gateway device | List |
| GetVpnConnectionDeviceTypes | Obtain a list of customer gateway devices for which sample configuration files can be provided | List |
| GetVpnTunnelReplacementStatus | View available tunnel endpoint maintenance events | List |
| ListImagesInRecycleBin | List Amazon Machine Images (AMIs) that are currently in the Recycle Bin | List |
| ListSnapshotsInRecycleBin | List the Amazon EBS snapshots that are currently in the Recycle Bin | List |
| SearchLocalGatewayRoutes | Search for routes in a local gateway route table | List |
| SearchTransitGatewayMulticastGroups | Search for groups, sources, and members in a transit gateway multicast domain | List |
| SearchTransitGatewayRoutes | Search for routes in a transit gateway route table | List |
| StartDeclarativePoliciesReport | Start a declarative policies report | Read |
